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

use crate::{
    calc_next_block_base_fee,
    eip1559::constants::{
        BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR, DEFAULT_ELASTICITY_MULTIPLIER,
        OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
        OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
        OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
        OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
        OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
    },
};

/// BaseFeeParams contains the config parameters that control block base fee computation
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BaseFeeParams {
    /// The base_fee_max_change_denominator from EIP-1559
    #[cfg_attr(feature = "serde", serde(with = "alloy_serde::quantity"))]
    pub max_change_denominator: u128,
    /// The elasticity multiplier from EIP-1559
    #[cfg_attr(feature = "serde", serde(with = "alloy_serde::quantity"))]
    pub elasticity_multiplier: u128,
}

impl BaseFeeParams {
    /// Create a new BaseFeeParams
    pub const fn new(max_change_denominator: u128, elasticity_multiplier: u128) -> Self {
        Self { max_change_denominator, elasticity_multiplier }
    }

    /// Get the base fee parameters for Ethereum mainnet
    pub const fn ethereum() -> Self {
        Self {
            max_change_denominator: DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR as u128,
            elasticity_multiplier: DEFAULT_ELASTICITY_MULTIPLIER as u128,
        }
    }

    /// Get the base fee parameters for Optimism Mainnet
    pub const fn optimism() -> Self {
        Self {
            max_change_denominator: OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
            elasticity_multiplier: OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Get the base fee parameters for Optimism Mainnet (post Canyon)
    pub const fn optimism_canyon() -> Self {
        Self {
            max_change_denominator: OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
            elasticity_multiplier: OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Get the base fee parameters for Optimism Sepolia
    pub const fn optimism_sepolia() -> Self {
        Self {
            max_change_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
            elasticity_multiplier: OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Get the base fee parameters for Optimism Sepolia (post Canyon)
    pub const fn optimism_sepolia_canyon() -> Self {
        Self {
            max_change_denominator: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
            elasticity_multiplier: OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Get the base fee parameters for Base Sepolia
    pub const fn base_sepolia() -> Self {
        Self {
            max_change_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
            elasticity_multiplier: BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Get the base fee parameters for Base Sepolia (post Canyon)
    pub const fn base_sepolia_canyon() -> Self {
        Self {
            max_change_denominator: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
            elasticity_multiplier: BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
        }
    }

    /// Calculate the base fee for the next block based on the EIP-1559 specification.
    ///
    /// See also [calc_next_block_base_fee]
    #[inline]
    pub fn next_block_base_fee(self, gas_used: u64, gas_limit: u64, base_fee: u64) -> u64 {
        calc_next_block_base_fee(gas_used, gas_limit, base_fee, self)
    }
}