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

// 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::{
    block_reward::{self, RewardKind},
    Engine,
};
use ethereum_types::U256;
use machine::Machine;
use types::{
    ancestry_action::AncestryAction,
    header::{ExtendedHeader, Header},
    BlockNumber,
};

/// Params for a null engine.
#[derive(Clone, Default)]
pub struct NullEngineParams {
    /// base reward for a block.
    pub block_reward: U256,
    /// Immediate finalization.
    pub immediate_finalization: bool,
}

impl From<::ethjson::spec::NullEngineParams> for NullEngineParams {
    fn from(p: ::ethjson::spec::NullEngineParams) -> Self {
        NullEngineParams {
            block_reward: p.block_reward.map_or_else(Default::default, Into::into),
            immediate_finalization: p.immediate_finalization.unwrap_or(false),
        }
    }
}

/// An engine which does not provide any consensus mechanism and does not seal blocks.
pub struct NullEngine<M> {
    params: NullEngineParams,
    machine: M,
}

impl<M> NullEngine<M> {
    /// Returns new instance of NullEngine with default VM Factory
    pub fn new(params: NullEngineParams, machine: M) -> Self {
        NullEngine {
            params: params,
            machine: machine,
        }
    }
}

impl<M: Default> Default for NullEngine<M> {
    fn default() -> Self {
        Self::new(Default::default(), Default::default())
    }
}

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

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

    fn on_close_block(&self, block: &mut ExecutedBlock) -> Result<(), M::Error> {
        use std::ops::Shr;

        let author = *block.header.author();
        let number = block.header.number();

        let reward = self.params.block_reward;
        if reward == U256::zero() {
            return Ok(());
        }

        let n_uncles = block.uncles.len();

        let mut rewards = Vec::new();

        // Bestow block reward
        let result_block_reward = reward + reward.shr(5) * U256::from(n_uncles);
        rewards.push((author, RewardKind::Author, result_block_reward));

        // bestow uncle rewards.
        for u in &block.uncles {
            let uncle_author = u.author();
            let result_uncle_reward = (reward * U256::from(8 + u.number() - number)).shr(3);
            rewards.push((
                *uncle_author,
                RewardKind::uncle(number, u.number()),
                result_uncle_reward,
            ));
        }

        block_reward::apply_block_rewards(&rewards, block, &self.machine)
    }

    fn maximum_uncle_count(&self, _block: BlockNumber) -> usize {
        2
    }

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

    fn snapshot_components(&self) -> Option<Box<dyn crate::snapshot::SnapshotComponents>> {
        Some(Box::new(::snapshot::PowSnapshot::new(10000, 10000)))
    }

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

    fn ancestry_actions(
        &self,
        _header: &Header,
        ancestry: &mut dyn Iterator<Item = ExtendedHeader>,
    ) -> Vec<AncestryAction> {
        if self.params.immediate_finalization {
            // always mark parent finalized
            ancestry
                .take(1)
                .map(|e| AncestryAction::MarkFinalized(e.header.hash()))
                .collect()
        } else {
            Vec::new()
        }
    }
}