1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

use block::ExecutedBlock;
use engines::{Engine, Seal, SealingState};
use machine::Machine;
use std::sync::atomic::{AtomicU64, Ordering};
use types::header::{ExtendedHeader, Header};

/// `InstantSeal` params.
#[derive(Default, Debug, PartialEq)]
pub struct InstantSealParams {
    /// Whether to use millisecond timestamp
    pub millisecond_timestamp: bool,
}

impl From<::ethjson::spec::InstantSealParams> for InstantSealParams {
    fn from(p: ::ethjson::spec::InstantSealParams) -> Self {
        InstantSealParams {
            millisecond_timestamp: p.millisecond_timestamp,
        }
    }
}

/// An engine which does not provide any consensus mechanism, just seals blocks internally.
/// Only seals blocks which have transactions.
pub struct InstantSeal<M> {
    params: InstantSealParams,
    machine: M,
    last_sealed_block: AtomicU64,
}

impl<M> InstantSeal<M> {
    /// Returns new instance of InstantSeal over the given state machine.
    pub fn new(params: InstantSealParams, machine: M) -> Self {
        InstantSeal {
            params,
            machine,
            last_sealed_block: AtomicU64::new(0),
        }
    }
}

impl<M: Machine> Engine<M> for InstantSeal<M> {
    fn name(&self) -> &str {
        "InstantSeal"
    }

    fn machine(&self) -> &M {
        &self.machine
    }

    fn sealing_state(&self) -> SealingState {
        SealingState::Ready
    }

    fn should_reseal_on_update(&self) -> bool {
        // We would like for the miner to `update_sealing` if there are local_pending_transactions
        // in the pool to prevent transactions sent in parallel from stalling in the transaction
        // pool. (see #9660)
        true
    }

    fn generate_seal(&self, block: &ExecutedBlock, _parent: &Header) -> Seal {
        if !block.transactions.is_empty() {
            let block_number = block.header.number();
            let last_sealed_block = self.last_sealed_block.load(Ordering::SeqCst);
            // Return a regular seal if the given block is _higher_ than
            // the last sealed one
            if block_number > last_sealed_block {
                if self
                    .last_sealed_block
                    .compare_exchange(
                        last_sealed_block,
                        block_number,
                        Ordering::SeqCst,
                        Ordering::SeqCst,
                    )
                    .is_ok()
                {
                    return Seal::Regular(Vec::new());
                }
            }
        }
        Seal::None
    }

    fn verify_local_seal(&self, _header: &Header) -> Result<(), M::Error> {
        Ok(())
    }

    fn open_block_header_timestamp(&self, parent_timestamp: u64) -> u64 {
        use std::{cmp, time};

        let dur = time::SystemTime::now()
            .duration_since(time::UNIX_EPOCH)
            .unwrap_or_default();
        let mut now = dur.as_secs();
        if self.params.millisecond_timestamp {
            now = now * 1000 + dur.subsec_millis() as u64;
        }
        cmp::max(now, parent_timestamp)
    }

    fn is_timestamp_valid(&self, header_timestamp: u64, parent_timestamp: u64) -> bool {
        header_timestamp >= parent_timestamp
    }

    fn fork_choice(&self, new: &ExtendedHeader, current: &ExtendedHeader) -> super::ForkChoice {
        super::total_difficulty_fork_choice(new, current)
    }
}

#[cfg(test)]
mod tests {
    use block::*;
    use engines::Seal;
    use ethereum_types::{Address, H520};
    use spec::Spec;
    use std::sync::Arc;
    use test_helpers::get_temp_state_db;
    use types::header::Header;

    #[test]
    fn instant_can_seal() {
        let spec = Spec::new_instant();
        let engine = &*spec.engine;
        let db = spec
            .ensure_db_good(get_temp_state_db(), &Default::default())
            .unwrap();
        let genesis_header = spec.genesis_header();
        let last_hashes = Arc::new(vec![genesis_header.hash()]);
        let b = OpenBlock::new(
            engine,
            Default::default(),
            false,
            db,
            &genesis_header,
            last_hashes,
            Address::default(),
            (3141562.into(), 31415620.into()),
            vec![],
            false,
            None,
        )
        .unwrap();
        let b = b.close_and_lock().unwrap();
        if let Seal::Regular(seal) = engine.generate_seal(&b, &genesis_header) {
            assert!(b.try_seal(engine, seal).is_ok());
        }
    }

    #[test]
    fn instant_cant_verify() {
        let engine = Spec::new_instant().engine;
        let mut header: Header = Header::default();

        assert!(engine.verify_block_basic(&header).is_ok());

        header.set_seal(vec![::rlp::encode(&H520::default())]);

        assert!(engine.verify_block_unordered(&header).is_ok());
    }
}