ethereum.forks.cancun.forkethereum.forks.prague.fork
Ethereum Specification.
.. contents:: Table of Contents :backlinks: none :local:
Introduction
Entry point for the Ethereum specification.
BASE_FEE_MAX_CHANGE_DENOMINATOR¶
| 97 | BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8) |
|---|
ELASTICITY_MULTIPLIER¶
| 98 | ELASTICITY_MULTIPLIER = Uint(2) |
|---|
EMPTY_OMMER_HASH¶
| 99 | EMPTY_OMMER_HASH = keccak256(rlp.encode([])) |
|---|
SYSTEM_ADDRESS¶
| 100 | SYSTEM_ADDRESS = hex_to_address("0xfffffffffffffffffffffffffffffffffffffffe") |
|---|
BEACON_ROOTS_ADDRESS¶
| 101 | BEACON_ROOTS_ADDRESS = hex_to_address( |
|---|---|
| 102 | "0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02" |
| 103 | ) |
SYSTEM_TRANSACTION_GAS¶
| 104 | SYSTEM_TRANSACTION_GAS = Uint(30000000) |
|---|
MAX_BLOB_GAS_PER_BLOCK¶
| 95 | MAX_BLOB_GAS_PER_BLOCK: Final[U64] = U64(786432) |
|---|---|
| 105 | MAX_BLOB_GAS_PER_BLOCK: Final[U64] = U64(1179648) |
VERSIONED_HASH_VERSION_KZG¶
| 106 | VERSIONED_HASH_VERSION_KZG = b"\x01" |
|---|
WITHDRAWAL_REQUEST_PREDEPLOY_ADDRESS¶
| 108 | WITHDRAWAL_REQUEST_PREDEPLOY_ADDRESS = hex_to_address( |
|---|---|
| 109 | "0x00000961Ef480Eb55e80D19ad83579A64c007002" |
| 110 | ) |
CONSOLIDATION_REQUEST_PREDEPLOY_ADDRESS¶
| 111 | CONSOLIDATION_REQUEST_PREDEPLOY_ADDRESS = hex_to_address( |
|---|---|
| 112 | "0x0000BBdDc7CE488642fb579F8B00f3a590007251" |
| 113 | ) |
HISTORY_STORAGE_ADDRESS¶
| 114 | HISTORY_STORAGE_ADDRESS = hex_to_address( |
|---|---|
| 115 | "0x0000F90827F1C53a10cb7A02335B175320002935" |
| 116 | ) |
BlockChain ¶
History and current state of the block chain.
| 119 | @dataclass |
|---|
class BlockChain:
blocks¶
| 125 | blocks: List[Block] |
|---|
state¶
| 126 | state: State |
|---|
chain_id¶
| 127 | chain_id: U64 |
|---|
apply_fork ¶
Transforms the state from the previous hard fork (old) into the block
chain object for this hard fork and returns it.
When forks need to implement an irregular state transition, this function
is used to handle the irregularity. See the :ref:DAO Fork <dao-fork> for
an example.
Parameters
old : Previous block chain object.
Returns
new : BlockChain
Upgraded block chain object for this hard fork.
def apply_fork(old: BlockChain) -> BlockChain:
| 131 | <snip> |
|---|---|
| 150 | return old |
get_last_256_block_hashes ¶
Obtain the list of hashes of the previous 256 blocks in order of increasing block number.
This function will return less hashes for the first 256 blocks.
The BLOCKHASH opcode needs to access the latest hashes on the chain,
therefore this function retrieves them.
Parameters
chain : History and current state.
Returns
recent_block_hashes : List[Hash32]
Hashes of the recent 256 blocks in order of increasing block number.
def get_last_256_block_hashes(chain: BlockChain) -> List[Hash32]:
| 154 | <snip> |
|---|---|
| 174 | recent_blocks = chain.blocks[-255:] |
| 175 | # TODO: This function has not been tested rigorously |
| 176 | if len(recent_blocks) == 0: |
| 177 | return [] |
| 178 | |
| 179 | recent_block_hashes = [] |
| 180 | |
| 181 | for block in recent_blocks: |
| 182 | prev_block_hash = block.header.parent_hash |
| 183 | recent_block_hashes.append(prev_block_hash) |
| 184 | |
| 185 | # We are computing the hash only for the most recent block and not for |
| 186 | # the rest of the blocks as they have successors which have the hash of |
| 187 | # the current block as parent hash. |
| 188 | most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header)) |
| 189 | recent_block_hashes.append(most_recent_block_hash) |
| 190 | |
| 191 | return recent_block_hashes |
state_transition ¶
Attempts to apply a block to an existing block chain.
All parts of the block's contents need to be verified before being added to the chain. Blocks are verified by ensuring that the contents of the block make logical sense with the contents of the parent block. The information in the block's header must also match the corresponding information in the block.
To implement Ethereum, in theory clients are only required to store the most recent 255 blocks of the chain since as far as execution is concerned, only those blocks are accessed. Practically, however, clients should store more blocks to handle reorgs.
Parameters
chain :
History and current state.
block :
Block to apply to chain.
def state_transition(chain: BlockChain, block: Block) -> None:
| 195 | <snip> |
|---|---|
| 217 | validate_header(chain, block.header) |
| 218 | if block.ommers != (): |
| 219 | raise InvalidBlock |
| 220 | |
| 221 | block_state = BlockState(pre_state=chain.state) |
| 222 | |
| 223 | block_env = vm.BlockEnvironment( |
| 224 | chain_id=chain.chain_id, |
| 225 | state=block_state, |
| 226 | block_gas_limit=block.header.gas_limit, |
| 227 | block_hashes=get_last_256_block_hashes(chain), |
| 228 | coinbase=block.header.coinbase, |
| 229 | number=block.header.number, |
| 230 | base_fee_per_gas=block.header.base_fee_per_gas, |
| 231 | time=block.header.timestamp, |
| 232 | prev_randao=block.header.prev_randao, |
| 233 | excess_blob_gas=block.header.excess_blob_gas, |
| 234 | parent_beacon_block_root=block.header.parent_beacon_block_root, |
| 235 | ) |
| 236 | |
| 237 | block_output = apply_body( |
| 238 | block_env=block_env, |
| 239 | transactions=block.transactions, |
| 240 | withdrawals=block.withdrawals, |
| 241 | ) |
| 242 | block_diff = extract_block_diff(block_state) |
| 243 | block_state_root, _ = chain.state.compute_state_root_and_trie_changes( |
| 244 | block_diff.account_changes, block_diff.storage_changes |
| 245 | ) |
| 246 | transactions_root = root(block_output.transactions_trie) |
| 247 | receipt_root = root(block_output.receipts_trie) |
| 248 | block_logs_bloom = logs_bloom(block_output.block_logs) |
| 249 | withdrawals_root = root(block_output.withdrawals_trie) |
| 250 | requests_hash = compute_requests_hash(block_output.requests) |
| 251 | |
| 252 | if block_output.block_gas_used != block.header.gas_used: |
| 253 | raise InvalidBlock( |
| 254 | f"{block_output.block_gas_used} != {block.header.gas_used}" |
| 255 | ) |
| 256 | if transactions_root != block.header.transactions_root: |
| 257 | raise InvalidBlock |
| 258 | if block_state_root != block.header.state_root: |
| 259 | raise InvalidBlock |
| 260 | if receipt_root != block.header.receipt_root: |
| 261 | raise InvalidBlock |
| 262 | if block_logs_bloom != block.header.bloom: |
| 263 | raise InvalidBlock |
| 264 | if withdrawals_root != block.header.withdrawals_root: |
| 265 | raise InvalidBlock |
| 266 | if block_output.blob_gas_used != block.header.blob_gas_used: |
| 267 | raise InvalidBlock |
| 268 | if requests_hash != block.header.requests_hash: |
| 269 | raise InvalidBlock |
| 270 | |
| 271 | apply_changes_to_state(chain.state, block_diff) |
| 272 | chain.blocks.append(block) |
| 273 | if len(chain.blocks) > 255: |
| 274 | # Real clients have to store more blocks to deal with reorgs, but the |
| 275 | # protocol only requires the last 255 |
| 276 | chain.blocks = chain.blocks[-255:] |
calculate_base_fee_per_gas ¶
Calculates the base fee per gas for the block.
Parameters
block_gas_limit : Gas limit of the block for which the base fee is being calculated. parent_gas_limit : Gas limit of the parent block. parent_gas_used : Gas used in the parent block. parent_base_fee_per_gas : Base fee per gas of the parent block.
Returns
base_fee_per_gas : Uint
Base fee per gas for the block.
def calculate_base_fee_per_gas(block_gas_limit: Uint, parent_gas_limit: Uint, parent_gas_used: Uint, parent_base_fee_per_gas: Uint) -> Uint:
| 285 | <snip> |
|---|---|
| 305 | parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER |
| 306 | if not check_gas_limit(block_gas_limit, parent_gas_limit): |
| 307 | raise InvalidBlock |
| 308 | |
| 309 | if parent_gas_used == parent_gas_target: |
| 310 | expected_base_fee_per_gas = parent_base_fee_per_gas |
| 311 | elif parent_gas_used > parent_gas_target: |
| 312 | gas_used_delta = parent_gas_used - parent_gas_target |
| 313 | |
| 314 | parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta |
| 315 | target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target |
| 316 | |
| 317 | base_fee_per_gas_delta = max( |
| 318 | target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR, |
| 319 | Uint(1), |
| 320 | ) |
| 321 | |
| 322 | expected_base_fee_per_gas = ( |
| 323 | parent_base_fee_per_gas + base_fee_per_gas_delta |
| 324 | ) |
| 325 | else: |
| 326 | gas_used_delta = parent_gas_target - parent_gas_used |
| 327 | |
| 328 | parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta |
| 329 | target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target |
| 330 | |
| 331 | base_fee_per_gas_delta = ( |
| 332 | target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR |
| 333 | ) |
| 334 | |
| 335 | expected_base_fee_per_gas = ( |
| 336 | parent_base_fee_per_gas - base_fee_per_gas_delta |
| 337 | ) |
| 338 | |
| 339 | return Uint(expected_base_fee_per_gas) |
validate_header ¶
Verifies a block header.
In order to consider a block's header valid, the logic for the quantities in the header should match the logic for the block itself. For example the header timestamp should be greater than the block's parent timestamp because the block was created after the parent block. Additionally, the block's number should be directly following the parent block's number since it is the next block in the sequence.
Parameters
chain : History and current state. header : Header to check for correctness.
def validate_header(chain: BlockChain, header: Header) -> None:
| 343 | <snip> |
|---|---|
| 361 | if header.number < Uint(1): |
| 362 | raise InvalidBlock |
| 363 | |
| 364 | parent_header = chain.blocks[-1].header |
| 365 | |
| 366 | excess_blob_gas = calculate_excess_blob_gas(parent_header) |
| 367 | if header.excess_blob_gas != excess_blob_gas: |
| 368 | raise InvalidBlock |
| 369 | |
| 370 | if header.gas_used > header.gas_limit: |
| 371 | raise InvalidBlock |
| 372 | |
| 373 | expected_base_fee_per_gas = calculate_base_fee_per_gas( |
| 374 | header.gas_limit, |
| 375 | parent_header.gas_limit, |
| 376 | parent_header.gas_used, |
| 377 | parent_header.base_fee_per_gas, |
| 378 | ) |
| 379 | if expected_base_fee_per_gas != header.base_fee_per_gas: |
| 380 | raise InvalidBlock |
| 381 | if header.timestamp <= parent_header.timestamp: |
| 382 | raise InvalidBlock |
| 383 | if header.number != parent_header.number + Uint(1): |
| 384 | raise InvalidBlock |
| 385 | if len(header.extra_data) > 32: |
| 386 | raise InvalidBlock |
| 387 | if header.difficulty != 0: |
| 388 | raise InvalidBlock |
| 389 | if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00": |
| 390 | raise InvalidBlock |
| 391 | if header.ommers_hash != EMPTY_OMMER_HASH: |
| 392 | raise InvalidBlock |
| 393 | |
| 394 | block_parent_hash = keccak256(rlp.encode(parent_header)) |
| 395 | if header.parent_hash != block_parent_hash: |
| 396 | raise InvalidBlock |
check_transaction ¶
Check if the transaction is includable in the block.
Parameters
block_env : The block scoped environment. block_output : The block output for the current block. tx : The transaction. tx_state : The transaction state tracker.
Returns
sender_address : The sender of the transaction. effective_gas_price : The price to charge for gas when the transaction is executed. blob_versioned_hashes : The blob versioned hashes of the transaction. tx_blob_gas_used: The blob gas used by the transaction.
Raises
InvalidBlock : If the transaction is not includable. GasUsedExceedsLimitError : If the gas used by the transaction exceeds the block's gas limit. NonceMismatchError : If the nonce of the transaction is not equal to the sender's nonce. InsufficientBalanceError : If the sender's balance is not enough to pay for the transaction. InvalidSenderError : If the transaction is from an address that does not exist anymore. PriorityFeeGreaterThanMaxFeeError : If the priority fee is greater than the maximum fee per gas. InsufficientMaxFeePerGasError : If the maximum fee per gas is insufficient for the transaction. InsufficientMaxFeePerBlobGasError : If the maximum fee per blob gas is insufficient for the transaction. BlobGasLimitExceededError : If the blob gas used by the transaction exceeds the block's blob gas limit. InvalidBlobVersionedHashError : If the transaction contains a blob versioned hash with an invalid version. NoBlobDataError : If the transaction is a type 3 but has no blobs. TransactionTypeContractCreationError: If the transaction type is not allowed to create contracts. EmptyAuthorizationListError : If the transaction is a SetCodeTransaction and the authorization list is empty.
def check_transaction(block_env: ethereum.forks.cancun.vm.BlockEnvironmentethereum.forks.prague.vm.BlockEnvironment, block_output: ethereum.forks.cancun.vm.BlockOutputethereum.forks.prague.vm.BlockOutput, tx: Transaction, tx_state: TransactionState) -> Tuple[Address, Uint, Tuple[VersionedHash, ...], U64]:
| 405 | <snip> |
|---|---|
| 463 | gas_available = block_env.block_gas_limit - block_output.block_gas_used |
| 464 | blob_gas_available = MAX_BLOB_GAS_PER_BLOCK - block_output.blob_gas_used |
| 465 | |
| 466 | if tx.gas > gas_available: |
| 467 | raise GasUsedExceedsLimitError("gas used exceeds limit") |
| 468 | |
| 469 | tx_blob_gas_used = calculate_total_blob_gas(tx) |
| 470 | if tx_blob_gas_used > blob_gas_available: |
| 471 | raise BlobGasLimitExceededError("blob gas limit exceeded") |
| 472 | |
| 473 | sender_address = recover_sender(block_env.chain_id, tx) |
| 474 | sender_account = get_account(tx_state, sender_address) |
| 475 | |
| 450 | if isinstance(tx, (FeeMarketTransaction, BlobTransaction)): |
| 476 | if isinstance( |
| 477 | tx, (FeeMarketTransaction, BlobTransaction, SetCodeTransaction) |
| 478 | ): |
| 479 | if tx.max_fee_per_gas < tx.max_priority_fee_per_gas: |
| 480 | raise PriorityFeeGreaterThanMaxFeeError( |
| 481 | "priority fee greater than max fee" |
| 482 | ) |
| 483 | if tx.max_fee_per_gas < block_env.base_fee_per_gas: |
| 484 | raise InsufficientMaxFeePerGasError( |
| 485 | tx.max_fee_per_gas, block_env.base_fee_per_gas |
| 486 | ) |
| 487 | |
| 488 | priority_fee_per_gas = min( |
| 489 | tx.max_priority_fee_per_gas, |
| 490 | tx.max_fee_per_gas - block_env.base_fee_per_gas, |
| 491 | ) |
| 492 | effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas |
| 493 | max_gas_fee = tx.gas * tx.max_fee_per_gas |
| 494 | else: |
| 495 | if tx.gas_price < block_env.base_fee_per_gas: |
| 496 | raise InvalidBlock |
| 497 | effective_gas_price = tx.gas_price |
| 498 | max_gas_fee = tx.gas * tx.gas_price |
| 499 | |
| 500 | if isinstance(tx, BlobTransaction): |
| 473 | if not isinstance(tx.to, Address): |
| 474 | raise TransactionTypeContractCreationError(tx) |
| 475 | if len(tx.blob_versioned_hashes) == 0: |
| 501 | if len(tx.blob_versioned_hashes) == 0: |
| 502 | raise NoBlobDataError("no blob data in transaction") |
| 503 | for blob_versioned_hash in tx.blob_versioned_hashes: |
| 504 | if blob_versioned_hash[0:1] != VERSIONED_HASH_VERSION_KZG: |
| 505 | raise InvalidBlobVersionedHashError( |
| 506 | "invalid blob versioned hash" |
| 507 | ) |
| 508 | |
| 509 | blob_gas_price = calculate_blob_gas_price(block_env.excess_blob_gas) |
| 510 | if Uint(tx.max_fee_per_blob_gas) < blob_gas_price: |
| 511 | raise InsufficientMaxFeePerBlobGasError( |
| 512 | "insufficient max fee per blob gas" |
| 513 | ) |
| 514 | |
| 515 | max_gas_fee += Uint(calculate_total_blob_gas(tx)) * Uint( |
| 516 | tx.max_fee_per_blob_gas |
| 517 | ) |
| 518 | blob_versioned_hashes = tx.blob_versioned_hashes |
| 519 | else: |
| 520 | blob_versioned_hashes = () |
| 521 | |
| 522 | if isinstance(tx, (BlobTransaction, SetCodeTransaction)): |
| 523 | if not isinstance(tx.to, Address): |
| 524 | raise TransactionTypeContractCreationError(tx) |
| 525 | |
| 526 | if isinstance(tx, SetCodeTransaction): |
| 527 | if not any(tx.authorizations): |
| 528 | raise EmptyAuthorizationListError("empty authorization list") |
| 529 | |
| 530 | if sender_account.nonce > Uint(tx.nonce): |
| 531 | raise NonceMismatchError("nonce too low") |
| 532 | elif sender_account.nonce < Uint(tx.nonce): |
| 533 | raise NonceMismatchError("nonce too high") |
| 534 | |
| 535 | if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value): |
| 536 | raise InsufficientBalanceError("insufficient sender balance") |
| 501 | if sender_account.code_hash != EMPTY_CODE_HASH: |
| 537 | sender_code = get_code(tx_state, sender_account.code_hash) |
| 538 | if sender_account.code_hash != EMPTY_CODE_HASH and not is_valid_delegation( |
| 539 | sender_code |
| 540 | ): |
| 541 | raise InvalidSenderError("not EOA") |
| 542 | |
| 543 | return ( |
| 544 | sender_address, |
| 545 | effective_gas_price, |
| 546 | blob_versioned_hashes, |
| 547 | tx_blob_gas_used, |
| 548 | ) |
make_receipt ¶
Make the receipt for a transaction that was executed.
Parameters
tx : The executed transaction. error : Error in the top level frame of the transaction, if any. cumulative_gas_used : The total gas used so far in the block after the transaction was executed. logs : The logs produced by the transaction.
Returns
receipt : The receipt for the transaction.
def make_receipt(tx: Transaction, error: Optional[EthereumException], cumulative_gas_used: Uint, logs: Tuple[Log, ...]) -> Bytes | Receipt:
| 557 | <snip> |
|---|---|
| 578 | receipt = Receipt( |
| 579 | succeeded=error is None, |
| 580 | cumulative_gas_used=cumulative_gas_used, |
| 581 | bloom=logs_bloom(logs), |
| 582 | logs=logs, |
| 583 | ) |
| 584 | |
| 585 | return encode_receipt(tx, receipt) |
process_checked_system_transaction ¶
Process a system transaction and raise an error if the contract does not contain code or if the transaction fails.
Parameters
block_env : The block scoped environment. target_address : Address of the contract to call. data : Data to pass to the contract.
Returns
system_tx_output : MessageCallOutput
Output of processing the system transaction.
def process_checked_system_transaction(block_env: ethereum.forks.prague.vm.BlockEnvironment, target_address: Address, data: Bytes) -> MessageCallOutput:
| 593 | <snip> |
|---|---|
| 612 | # Pre-check that the system contract has code. We use a throwaway |
| 613 | # TransactionState here that is *never* propagated back to BlockState |
| 614 | # (no incorporate_tx_into_block call); the same get_account / get_code |
| 615 | # lookups are performed and properly tracked by |
| 616 | # process_unchecked_system_transaction below, which this function |
| 617 | # always calls. Reading via a TransactionState (rather than directly |
| 618 | # against pre_state) lets us see system contracts deployed earlier in |
| 619 | # the same block — see EIP-7002 and EIP-7251 for this edge case. |
| 620 | untracked_state = TransactionState(parent=block_env.state) |
| 621 | system_contract_code = get_code( |
| 622 | untracked_state, |
| 623 | get_account(untracked_state, target_address).code_hash, |
| 624 | ) |
| 625 | |
| 626 | if len(system_contract_code) == 0: |
| 627 | raise InvalidBlock( |
| 628 | f"System contract address {target_address.hex()} does not " |
| 629 | "contain code" |
| 630 | ) |
| 631 | |
| 632 | system_tx_output = process_unchecked_system_transaction( |
| 633 | block_env, |
| 634 | target_address, |
| 635 | data, |
| 636 | ) |
| 637 | |
| 638 | if system_tx_output.error: |
| 639 | raise InvalidBlock( |
| 640 | f"System contract ({target_address.hex()}) call failed: " |
| 641 | f"{system_tx_output.error}" |
| 642 | ) |
| 643 | |
| 644 | return system_tx_output |
process_unchecked_system_transaction ¶
Process a system transaction without checking if the contract contains code or if the transaction fails.
Parameters
block_env : The block scoped environment. target_address : Address of the contract to call. data : Data to pass to the contract.
Returns
system_tx_output : MessageCallOutput
Output of processing the system transaction.
def process_unchecked_system_transaction(block_env: ethereum.forks.cancun.vm.BlockEnvironmentethereum.forks.prague.vm.BlockEnvironment, target_address: Address, data: Bytes) -> MessageCallOutput:
| 652 | <snip> |
|---|---|
| 671 | system_tx_state = TransactionState(parent=block_env.state) |
| 672 | system_contract_code = get_code( |
| 673 | system_tx_state, |
| 674 | get_account(system_tx_state, target_address).code_hash, |
| 675 | ) |
| 676 | |
| 677 | tx_env = vm.TransactionEnvironment( |
| 678 | origin=SYSTEM_ADDRESS, |
| 679 | gas_price=block_env.base_fee_per_gas, |
| 680 | gas=SYSTEM_TRANSACTION_GAS, |
| 681 | access_list_addresses=set(), |
| 682 | access_list_storage_keys=set(), |
| 683 | state=system_tx_state, |
| 684 | blob_versioned_hashes=(), |
| 685 | authorizations=(), |
| 686 | index_in_block=None, |
| 687 | tx_hash=None, |
| 688 | ) |
| 689 | |
| 690 | system_tx_message = Message( |
| 691 | block_env=block_env, |
| 692 | tx_env=tx_env, |
| 693 | caller=SYSTEM_ADDRESS, |
| 694 | target=target_address, |
| 695 | gas=SYSTEM_TRANSACTION_GAS, |
| 696 | value=U256(0), |
| 697 | data=data, |
| 698 | code=system_contract_code, |
| 699 | depth=Uint(0), |
| 700 | current_target=target_address, |
| 701 | code_address=target_address, |
| 702 | should_transfer_value=False, |
| 703 | is_static=False, |
| 704 | accessed_addresses=set(), |
| 705 | accessed_storage_keys=set(), |
| 706 | disable_precompiles=False, |
| 707 | parent_evm=None, |
| 708 | ) |
| 709 | |
| 710 | system_tx_output = process_message_call(system_tx_message) |
| 711 | |
| 712 | incorporate_tx_into_block(system_tx_state) |
| 713 | |
| 714 | return system_tx_output |
apply_body ¶
Executes a block.
Many of the contents of a block are stored in data structures called tries. There is a transactions trie which is similar to a ledger of the transactions stored in the current block. There is also a receipts trie which stores the results of executing a transaction, like the post state and gas used. This function creates and executes the block that is to be added to the chain.
Parameters
block_env : The block scoped environment. transactions : Transactions included in the block. withdrawals : Withdrawals to be processed in the current block.
Returns
block_output : The block output for the current block.
def apply_body(block_env: ethereum.forks.cancun.vm.BlockEnvironmentethereum.forks.prague.vm.BlockEnvironment, transactions: Tuple[LegacyTransaction | Bytes, ...], withdrawals: Tuple[Withdrawal, ...]) -> ethereum.forks.cancun.vm.BlockOutputethereum.forks.prague.vm.BlockOutput:
| 722 | <snip> |
|---|---|
| 747 | block_output = vm.BlockOutput() |
| 748 | |
| 749 | process_unchecked_system_transaction( |
| 750 | block_env=block_env, |
| 751 | target_address=BEACON_ROOTS_ADDRESS, |
| 752 | data=block_env.parent_beacon_block_root, |
| 753 | ) |
| 754 | |
| 755 | process_unchecked_system_transaction( |
| 756 | block_env=block_env, |
| 757 | target_address=HISTORY_STORAGE_ADDRESS, |
| 758 | data=block_env.block_hashes[-1], # The parent hash |
| 759 | ) |
| 760 | |
| 761 | for i, tx in enumerate(map(decode_transaction, transactions)): |
| 762 | process_transaction(block_env, block_output, tx, Uint(i)) |
| 763 | |
| 764 | process_withdrawals(block_env, block_output, withdrawals) |
| 765 | |
| 766 | process_general_purpose_requests( |
| 767 | block_env=block_env, |
| 768 | block_output=block_output, |
| 769 | ) |
| 770 | |
| 771 | return block_output |
process_general_purpose_requests ¶
Process all the requests in the block.
Parameters
block_env : The execution environment for the Block. block_output : The block output for the current block.
def process_general_purpose_requests(block_env: ethereum.forks.prague.vm.BlockEnvironment, block_output: ethereum.forks.prague.vm.BlockOutput) -> None:
| 778 | <snip> |
|---|---|
| 789 | # Requests are to be in ascending order of request type |
| 790 | deposit_requests = parse_deposit_requests(block_output) |
| 791 | requests_from_execution = block_output.requests |
| 792 | if len(deposit_requests) > 0: |
| 793 | requests_from_execution.append(DEPOSIT_REQUEST_TYPE + deposit_requests) |
| 794 | |
| 795 | system_withdrawal_tx_output = process_checked_system_transaction( |
| 796 | block_env=block_env, |
| 797 | target_address=WITHDRAWAL_REQUEST_PREDEPLOY_ADDRESS, |
| 798 | data=b"", |
| 799 | ) |
| 800 | |
| 801 | if len(system_withdrawal_tx_output.return_data) > 0: |
| 802 | requests_from_execution.append( |
| 803 | WITHDRAWAL_REQUEST_TYPE + system_withdrawal_tx_output.return_data |
| 804 | ) |
| 805 | |
| 806 | system_consolidation_tx_output = process_checked_system_transaction( |
| 807 | block_env=block_env, |
| 808 | target_address=CONSOLIDATION_REQUEST_PREDEPLOY_ADDRESS, |
| 809 | data=b"", |
| 810 | ) |
| 811 | |
| 812 | if len(system_consolidation_tx_output.return_data) > 0: |
| 813 | requests_from_execution.append( |
| 814 | CONSOLIDATION_REQUEST_TYPE |
| 815 | + system_consolidation_tx_output.return_data |
| 816 | ) |
process_transaction ¶
Execute a transaction against the provided environment.
This function processes the actions needed to execute a transaction. It decrements the sender's account balance after calculating the gas fee and refunds them the proper amount after execution. Calling contracts, deploying code, and incrementing nonces are all examples of actions that happen within this function or from a call made within this function.
Accounts that are marked for deletion are processed and destroyed after execution.
Parameters
block_env : Environment for the Ethereum Virtual Machine. block_output : The block output for the current block. tx : Transaction to execute. index: Index of the transaction in the block.
def process_transaction(block_env: ethereum.forks.cancun.vm.BlockEnvironmentethereum.forks.prague.vm.BlockEnvironment, block_output: ethereum.forks.cancun.vm.BlockOutputethereum.forks.prague.vm.BlockOutput, tx: Transaction, index: Uint) -> None:
| 825 | <snip> |
|---|---|
| 849 | tx_state = TransactionState(parent=block_env.state) |
| 850 | |
| 851 | trie_set( |
| 852 | block_output.transactions_trie, |
| 853 | rlp.encode(index), |
| 854 | encode_transaction(tx), |
| 855 | ) |
| 856 | |
| 701 | intrinsic_gas = validate_transaction(tx) |
| 857 | intrinsic_gas, calldata_floor_gas_cost = validate_transaction(tx) |
| 858 | |
| 859 | ( |
| 860 | sender, |
| 861 | effective_gas_price, |
| 862 | blob_versioned_hashes, |
| 863 | tx_blob_gas_used, |
| 864 | ) = check_transaction( |
| 865 | block_env=block_env, |
| 866 | block_output=block_output, |
| 867 | tx=tx, |
| 868 | tx_state=tx_state, |
| 869 | ) |
| 870 | |
| 871 | sender_account = get_account(tx_state, sender) |
| 872 | |
| 873 | if isinstance(tx, BlobTransaction): |
| 874 | blob_gas_fee = calculate_data_fee(block_env.excess_blob_gas, tx) |
| 875 | else: |
| 876 | blob_gas_fee = Uint(0) |
| 877 | |
| 878 | effective_gas_fee = tx.gas * effective_gas_price |
| 879 | |
| 880 | gas = tx.gas - intrinsic_gas |
| 881 | increment_nonce(tx_state, sender) |
| 882 | |
| 883 | sender_balance_after_gas_fee = ( |
| 884 | Uint(sender_account.balance) - effective_gas_fee - blob_gas_fee |
| 885 | ) |
| 886 | set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee)) |
| 887 | |
| 888 | access_list_addresses = set() |
| 889 | access_list_storage_keys = set() |
| 890 | access_list_addresses.add(block_env.coinbase) |
| 735 | if isinstance( |
| 736 | tx, (AccessListTransaction, FeeMarketTransaction, BlobTransaction) |
| 737 | ): |
| 891 | if has_access_list(tx): |
| 892 | for access in tx.access_list: |
| 893 | access_list_addresses.add(access.account) |
| 894 | for slot in access.slots: |
| 895 | access_list_storage_keys.add((access.account, slot)) |
| 896 | |
| 897 | authorizations: Tuple[Authorization, ...] = () |
| 898 | if isinstance(tx, SetCodeTransaction): |
| 899 | authorizations = tx.authorizations |
| 900 | |
| 901 | tx_env = vm.TransactionEnvironment( |
| 902 | origin=sender, |
| 903 | gas_price=effective_gas_price, |
| 904 | gas=gas, |
| 905 | access_list_addresses=access_list_addresses, |
| 906 | access_list_storage_keys=access_list_storage_keys, |
| 907 | state=tx_state, |
| 908 | blob_versioned_hashes=blob_versioned_hashes, |
| 909 | authorizations=authorizations, |
| 910 | index_in_block=index, |
| 911 | tx_hash=get_transaction_hash(encode_transaction(tx)), |
| 912 | ) |
| 913 | |
| 914 | message = prepare_message(block_env, tx_env, tx) |
| 915 | |
| 916 | tx_output = process_message_call(message) |
| 917 | |
| 759 | tx_gas_used_before_refund = tx.gas - tx_output.gas_left |
| 918 | # For EIP-7623 we first calculate the execution_gas_used, which includes |
| 919 | # the execution gas refund. |
| 920 | tx_gas_used_before_refund = tx.gas - tx_output.gas_left |
| 921 | tx_gas_refund = min( |
| 922 | tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter) |
| 923 | ) |
| 924 | tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund |
| 925 | |
| 926 | # Transactions with less execution_gas_used than the floor pay at the |
| 927 | # floor cost. |
| 928 | tx_gas_used_after_refund = max( |
| 929 | tx_gas_used_after_refund, calldata_floor_gas_cost |
| 930 | ) |
| 931 | |
| 932 | tx_gas_left = tx.gas - tx_gas_used_after_refund |
| 933 | gas_refund_amount = tx_gas_left * effective_gas_price |
| 934 | |
| 935 | # For non-1559 transactions effective_gas_price == tx.gas_price |
| 936 | priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas |
| 937 | transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas |
| 938 | |
| 939 | # refund gas |
| 940 | sender_balance_after_refund = get_account(tx_state, sender).balance + U256( |
| 941 | gas_refund_amount |
| 942 | ) |
| 943 | set_account_balance(tx_state, sender, sender_balance_after_refund) |
| 944 | |
| 945 | # transfer miner fees |
| 946 | coinbase_balance_after_mining_fee = get_account( |
| 947 | tx_state, block_env.coinbase |
| 948 | ).balance + U256(transaction_fee) |
| 949 | set_account_balance( |
| 950 | tx_state, block_env.coinbase, coinbase_balance_after_mining_fee |
| 951 | ) |
| 952 | |
| 953 | for address in tx_output.accounts_to_delete: |
| 954 | destroy_account(tx_state, address) |
| 955 | |
| 956 | block_output.block_gas_used += tx_gas_used_after_refund |
| 957 | block_output.blob_gas_used += tx_blob_gas_used |
| 958 | |
| 959 | receipt = make_receipt( |
| 960 | tx, tx_output.error, block_output.block_gas_used, tx_output.logs |
| 961 | ) |
| 962 | |
| 963 | receipt_key = rlp.encode(Uint(index)) |
| 964 | block_output.receipt_keys += (receipt_key,) |
| 965 | |
| 966 | trie_set( |
| 967 | block_output.receipts_trie, |
| 968 | receipt_key, |
| 969 | receipt, |
| 970 | ) |
| 971 | |
| 972 | block_output.block_logs += tx_output.logs |
| 973 | |
| 974 | incorporate_tx_into_block(tx_state) |
process_withdrawals ¶
Increase the balance of the withdrawing account.
def process_withdrawals(block_env: ethereum.forks.cancun.vm.BlockEnvironmentethereum.forks.prague.vm.BlockEnvironment, block_output: ethereum.forks.cancun.vm.BlockOutputethereum.forks.prague.vm.BlockOutput, withdrawals: Tuple[Withdrawal, ...]) -> None:
| 982 | <snip> |
|---|---|
| 985 | wd_state = TransactionState(parent=block_env.state) |
| 986 | |
| 987 | for i, wd in enumerate(withdrawals): |
| 988 | trie_set( |
| 989 | block_output.withdrawals_trie, |
| 990 | rlp.encode(Uint(i)), |
| 991 | rlp.encode(wd), |
| 992 | ) |
| 993 | |
| 994 | create_ether(wd_state, wd.address, wd.amount * U256(10**9)) |
| 995 | |
| 996 | incorporate_tx_into_block(wd_state) |
check_gas_limit ¶
Validates the gas limit for a block.
The bounds of the gas limit, max_adjustment_delta, is set as the
quotient of the parent block's gas limit and the
LIMIT_ADJUSTMENT_FACTOR. Therefore, if the gas limit that is. Therefore, if the gas limit that is passed
passed through as a parameter is greater than or equal to the through as a parameter is greater than or equal to the sum of of the
the parent's gas and the adjustment delta then the limit for gas is tooparent's gas and the adjustment delta then the limit for gas is too high
high and fails this function's check. Similarly, if the limit is lessand fails this function's check. Similarly, if the limit is less than or
than or equal to the equal to the difference of the parent's gas and the adjustment of the parent's gas and the adjustment delta or
delta or the predefined the predefined LIMIT_MINIMUM then this function's then this function's check fails because
check fails because the gas limit doesn't allow for a sufficient orthe gas limit doesn't allow for a sufficient or reasonable amount of gas to
reasonable amount of gas to be used on a block.be used on a block.
Parameters
gas_limit : Gas limit to validate.
parent_gas_limit : Gas limit of the parent block.
Returns
check : bool
True if gas limit constraints are satisfied, False otherwise.
def check_gas_limit(gas_limit: Uint, parent_gas_limit: Uint) -> bool:
| 1000 | <snip> |
|---|---|
| 1028 | max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR |
| 1029 | if gas_limit >= parent_gas_limit + max_adjustment_delta: |
| 1030 | return False |
| 1031 | if gas_limit <= parent_gas_limit - max_adjustment_delta: |
| 1032 | return False |
| 1033 | if gas_limit < GasCosts.LIMIT_MINIMUM: |
| 1034 | return False |
| 1035 | |
| 1036 | return True |