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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
use crate::precompile::HashMap;
use reth_chainspec::{ChainSpec, EthereumHardforks};
use reth_consensus_common::calc;
use reth_primitives::{Address, Block, Withdrawal, Withdrawals, U256};
/// Collect all balance changes at the end of the block.
///
/// Balance changes might include the block reward, uncle rewards, withdrawals, or irregular
/// state changes (DAO fork).
#[inline]
pub fn post_block_balance_increments(
chain_spec: &ChainSpec,
block: &Block,
total_difficulty: U256,
) -> HashMap<Address, u128> {
let mut balance_increments = HashMap::new();
// Add block rewards if they are enabled.
if let Some(base_block_reward) =
calc::base_block_reward(chain_spec, block.number, block.difficulty, total_difficulty)
{
// Ommer rewards
for ommer in &block.ommers {
*balance_increments.entry(ommer.beneficiary).or_default() +=
calc::ommer_reward(base_block_reward, block.number, ommer.number);
}
// Full block reward
*balance_increments.entry(block.beneficiary).or_default() +=
calc::block_reward(base_block_reward, block.ommers.len());
}
// process withdrawals
insert_post_block_withdrawals_balance_increments(
chain_spec,
block.timestamp,
block.withdrawals.as_ref().map(Withdrawals::as_ref),
&mut balance_increments,
);
balance_increments
}
/// Returns a map of addresses to their balance increments if the Shanghai hardfork is active at the
/// given timestamp.
///
/// Zero-valued withdrawals are filtered out.
#[inline]
pub fn post_block_withdrawals_balance_increments(
chain_spec: &ChainSpec,
block_timestamp: u64,
withdrawals: &[Withdrawal],
) -> HashMap<Address, u128> {
let mut balance_increments = HashMap::with_capacity(withdrawals.len());
insert_post_block_withdrawals_balance_increments(
chain_spec,
block_timestamp,
Some(withdrawals),
&mut balance_increments,
);
balance_increments
}
/// Applies all withdrawal balance increments if shanghai is active at the given timestamp to the
/// given `balance_increments` map.
///
/// Zero-valued withdrawals are filtered out.
#[inline]
pub fn insert_post_block_withdrawals_balance_increments(
chain_spec: &ChainSpec,
block_timestamp: u64,
withdrawals: Option<&[Withdrawal]>,
balance_increments: &mut HashMap<Address, u128>,
) {
// Process withdrawals
if chain_spec.is_shanghai_active_at_timestamp(block_timestamp) {
if let Some(withdrawals) = withdrawals {
for withdrawal in withdrawals {
if withdrawal.amount > 0 {
*balance_increments.entry(withdrawal.address).or_default() +=
withdrawal.amount_wei().to::<u128>();
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use reth_ethereum_forks::{ChainHardforks, EthereumHardfork, ForkCondition};
use reth_primitives::constants::GWEI_TO_WEI;
/// Tests that the function correctly inserts balance increments when the Shanghai hardfork is
/// active and there are withdrawals.
#[test]
fn test_insert_post_block_withdrawals_balance_increments_shanghai_active_with_withdrawals() {
// Arrange
// Create a ChainSpec with the Shanghai hardfork active at timestamp 100
let chain_spec = ChainSpec {
hardforks: ChainHardforks::new(vec![(
Box::new(EthereumHardfork::Shanghai),
ForkCondition::Timestamp(100),
)]),
..Default::default()
};
// Define the block timestamp and withdrawals
let block_timestamp = 1000;
let withdrawals = vec![
Withdrawal {
address: Address::from([1; 20]),
amount: 1000,
index: 45,
validator_index: 12,
},
Withdrawal {
address: Address::from([2; 20]),
amount: 500,
index: 412,
validator_index: 123,
},
];
// Create an empty HashMap to hold the balance increments
let mut balance_increments = HashMap::new();
// Act
// Call the function with the prepared inputs
insert_post_block_withdrawals_balance_increments(
&chain_spec,
block_timestamp,
Some(&withdrawals),
&mut balance_increments,
);
// Assert
// Verify that the balance increments map has the correct number of entries
assert_eq!(balance_increments.len(), 2);
// Verify that the balance increments map contains the correct values for each address
assert_eq!(
*balance_increments.get(&Address::from([1; 20])).unwrap(),
(1000 * GWEI_TO_WEI).into()
);
assert_eq!(
*balance_increments.get(&Address::from([2; 20])).unwrap(),
(500 * GWEI_TO_WEI).into()
);
}
/// Tests that the function correctly handles the case when Shanghai is active but there are no
/// withdrawals.
#[test]
fn test_insert_post_block_withdrawals_balance_increments_shanghai_active_no_withdrawals() {
// Arrange
// Create a ChainSpec with the Shanghai hardfork active
let chain_spec = ChainSpec {
hardforks: ChainHardforks::new(vec![(
Box::new(EthereumHardfork::Shanghai),
ForkCondition::Timestamp(100),
)]),
..Default::default()
};
// Define the block timestamp and an empty list of withdrawals
let block_timestamp = 1000;
let withdrawals = Vec::<Withdrawal>::new();
// Create an empty HashMap to hold the balance increments
let mut balance_increments = HashMap::new();
// Act
// Call the function with the prepared inputs
insert_post_block_withdrawals_balance_increments(
&chain_spec,
block_timestamp,
Some(&withdrawals),
&mut balance_increments,
);
// Assert
// Verify that the balance increments map is empty
assert!(balance_increments.is_empty());
}
/// Tests that the function correctly handles the case when Shanghai is not active even if there
/// are withdrawals.
#[test]
fn test_insert_post_block_withdrawals_balance_increments_shanghai_not_active_with_withdrawals()
{
// Arrange
// Create a ChainSpec without the Shanghai hardfork active
let chain_spec = ChainSpec::default(); // Mock chain spec with Shanghai not active
// Define the block timestamp and withdrawals
let block_timestamp = 1000;
let withdrawals = vec![
Withdrawal {
address: Address::from([1; 20]),
amount: 1000,
index: 45,
validator_index: 12,
},
Withdrawal {
address: Address::from([2; 20]),
amount: 500,
index: 412,
validator_index: 123,
},
];
// Create an empty HashMap to hold the balance increments
let mut balance_increments = HashMap::new();
// Act
// Call the function with the prepared inputs
insert_post_block_withdrawals_balance_increments(
&chain_spec,
block_timestamp,
Some(&withdrawals),
&mut balance_increments,
);
// Assert
// Verify that the balance increments map is empty
assert!(balance_increments.is_empty());
}
/// Tests that the function correctly handles the case when Shanghai is active but all
/// withdrawals have zero amounts.
#[test]
fn test_insert_post_block_withdrawals_balance_increments_shanghai_active_with_zero_withdrawals()
{
// Arrange
// Create a ChainSpec with the Shanghai hardfork active
let chain_spec = ChainSpec {
hardforks: ChainHardforks::new(vec![(
Box::new(EthereumHardfork::Shanghai),
ForkCondition::Timestamp(100),
)]),
..Default::default()
};
// Define the block timestamp and withdrawals with zero amounts
let block_timestamp = 1000;
let withdrawals = vec![
Withdrawal {
address: Address::from([1; 20]),
amount: 0, // Zero withdrawal amount
index: 45,
validator_index: 12,
},
Withdrawal {
address: Address::from([2; 20]),
amount: 0, // Zero withdrawal amount
index: 412,
validator_index: 123,
},
];
// Create an empty HashMap to hold the balance increments
let mut balance_increments = HashMap::new();
// Act
// Call the function with the prepared inputs
insert_post_block_withdrawals_balance_increments(
&chain_spec,
block_timestamp,
Some(&withdrawals),
&mut balance_increments,
);
// Assert
// Verify that the balance increments map is empty
assert!(balance_increments.is_empty());
}
/// Tests that the function correctly handles the case when Shanghai is active but there are no
/// withdrawals provided.
#[test]
fn test_insert_post_block_withdrawals_balance_increments_shanghai_active_with_empty_withdrawals(
) {
// Arrange
// Create a ChainSpec with the Shanghai hardfork active
let chain_spec = ChainSpec {
hardforks: ChainHardforks::new(vec![(
Box::new(EthereumHardfork::Shanghai),
ForkCondition::Timestamp(100),
)]),
..Default::default()
};
// Define the block timestamp and no withdrawals
let block_timestamp = 1000;
let withdrawals = None; // No withdrawals provided
// Create an empty HashMap to hold the balance increments
let mut balance_increments = HashMap::new();
// Act
// Call the function with the prepared inputs
insert_post_block_withdrawals_balance_increments(
&chain_spec,
block_timestamp,
withdrawals,
&mut balance_increments,
);
// Assert
// Verify that the balance increments map is empty
assert!(balance_increments.is_empty());
}
}