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

// Copyright 2019-2020 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/

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

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

// Parity 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 Parity.  If not, see <http://www.gnu.org/licenses/>.

// Copyright 2019 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/

//! Environment information for transaction execution.

use std::collections::BTreeMap;

use cfx_types::{Address, Space, SpaceMap, H256, U256};
use primitives::BlockNumber;

/// Information concerning the execution environment for a
/// message-call/contract-creation.
#[derive(Debug, Clone, Default)]
pub struct Env {
    /// Chain ID
    pub chain_id: BTreeMap<Space, u32>,
    /// The block number.
    pub number: BlockNumber,
    /// The block author.
    pub author: Address,
    /// The block timestamp.
    pub timestamp: u64,
    /// The block difficulty.
    pub difficulty: U256,
    /// The block gas limit.
    pub gas_limit: U256,
    /// The last block hash.
    pub last_hash: H256,
    /// The total gas used in the block following execution of the transaction.
    pub accumulated_gas_used: U256,
    /// The epoch height.
    pub epoch_height: u64,
    /// PoS view number.
    pub pos_view: Option<u64>,
    /// Finalized epoch number by PoS view.
    pub finalized_epoch: Option<u64>,
    /// The transaction_epoch_bound used to verify if a transaction has
    /// expired.
    pub transaction_epoch_bound: u64,
    /// Base gas price in CIP-1559, equals to 0 if CIP-1559 has not been
    /// activated
    pub base_gas_price: SpaceMap<U256>,
    /// Base gas price to miner according to in CIP-137
    pub burnt_gas_price: SpaceMap<U256>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_can_be_created_as_default() {
        let default_env = Env::default();

        assert_eq!(default_env.number, 0);
        assert_eq!(default_env.author, Address::default());
        assert_eq!(default_env.timestamp, 0);
        assert_eq!(default_env.difficulty, 0.into());
        assert_eq!(default_env.gas_limit, 0.into());
        assert_eq!(default_env.last_hash, H256::zero());
        assert_eq!(default_env.accumulated_gas_used, 0.into());
    }
}