openethereum/crates/ethjson/src/spec/authority_round.rs

// 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/>.

//! Authority params deserialization.

use super::{BlockReward, ValidatorSet};
use crate::{bytes::Bytes, hash::Address, uint::Uint};

/// Authority params deserialization.
#[derive(Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(rename_all = "camelCase")]
pub struct AuthorityRoundParams {
    /// Block duration, in seconds.
    pub step_duration: Uint,
    /// Valid authorities
    pub validators: ValidatorSet,
    /// Starting step. Determined automatically if not specified.
    /// To be used for testing only.
    pub start_step: Option<Uint>,
    /// Block at which score validation should start.
    pub validate_score_transition: Option<Uint>,
    /// Block from which monotonic steps start.
    pub validate_step_transition: Option<Uint>,
    /// Whether transitions should be immediate.
    pub immediate_transitions: Option<bool>,
    /// Reward per block in wei.
    pub block_reward: Option<BlockReward>,
    /// Block at which the block reward contract should start being used.
    pub block_reward_contract_transition: Option<Uint>,
    /// Block reward contract address (setting the block reward contract
    /// overrides the static block reward definition).
    pub block_reward_contract_address: Option<Address>,
    /// Block reward code. This overrides the block reward contract address.
    pub block_reward_contract_code: Option<Bytes>,
    /// Block at which maximum uncle count should be considered.
    pub maximum_uncle_count_transition: Option<Uint>,
    /// Maximum number of accepted uncles.
    pub maximum_uncle_count: Option<Uint>,
    /// Block at which empty step messages should start.
    pub empty_steps_transition: Option<Uint>,
    /// Maximum number of accepted empty steps.
    pub maximum_empty_steps: Option<Uint>,
    /// Strict validation of empty steps transition block.
    pub strict_empty_steps_transition: Option<Uint>,
}

/// Authority engine deserialization.
#[derive(Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct AuthorityRound {
    /// Ethash params.
    pub params: AuthorityRoundParams,
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use super::BlockReward;
    use crate::{
        hash::Address,
        spec::{authority_round::AuthorityRound, validator_set::ValidatorSet},
        uint::Uint,
    };
    use ethereum_types::{H160, U256};
    use serde_json;
    use std::str::FromStr;

    #[test]
    fn authority_round_deserialization() {
        let s = r#"{
			"params": {
				"stepDuration": "0x02",
				"validators": {
					"list" : ["0xc6d9d2cd449a754c494264e1809c50e34d64562b"]
				},
				"startStep" : 24,
				"validateStepTransition": 150,
				"blockReward": 5000000,
				"maximumUncleCountTransition": 10000000,
				"maximumUncleCount": 5
			}
		}"#;

        let deserialized: AuthorityRound = serde_json::from_str(s).unwrap();
        assert_eq!(deserialized.params.step_duration, Uint(U256::from(0x02)));
        assert_eq!(
            deserialized.params.validators,
            ValidatorSet::List(vec![Address(
                H160::from_str("c6d9d2cd449a754c494264e1809c50e34d64562b").unwrap()
            )])
        );
        assert_eq!(deserialized.params.start_step, Some(Uint(U256::from(24))));
        assert_eq!(deserialized.params.immediate_transitions, None);
        assert_eq!(
            deserialized.params.maximum_uncle_count_transition,
            Some(Uint(10_000_000.into()))
        );
        assert_eq!(
            deserialized.params.maximum_uncle_count,
            Some(Uint(5.into()))
        );
        assert_eq!(
            deserialized.params.block_reward,
            Some(BlockReward::Single(Uint(5000000.into())))
        )
    }

    #[test]
    fn authority_round_deserialization_multi_block() {
        let s = r#"{
			"params": {
				"stepDuration": "0x02",
				"validators": {
					"contract" : "0xc6d9d2cd449a754c494264e1809c50e34d64562b"
				},
				"blockReward": {
                    "0": 5000000,
                    "100": 150
                }
			}
		}"#;

        let deserialized: AuthorityRound = serde_json::from_str(s).unwrap();
        assert_eq!(deserialized.params.step_duration, Uint(U256::from(0x02)));
        assert_eq!(
            deserialized.params.validators,
            ValidatorSet::Contract(Address(
                H160::from_str("c6d9d2cd449a754c494264e1809c50e34d64562b").unwrap()
            ))
        );
        let mut rewards: BTreeMap<Uint, Uint> = BTreeMap::new();
        rewards.insert(Uint(U256::from(0)), Uint(U256::from(5000000)));
        rewards.insert(Uint(U256::from(100)), Uint(U256::from(150)));
        assert_eq!(
            deserialized.params.block_reward,
            Some(BlockReward::Multi(rewards))
        );
    }
}