ethereum.forks.paris.forkethereum.forks.shanghai.fork

Ethereum Specification.

.. contents:: Table of Contents :backlinks: none :local:

Introduction

Entry point for the Ethereum specification.

BASE_FEE_MAX_CHANGE_DENOMINATOR

73
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

74
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

75
EMPTY_OMMER_HASH = keccak256(rlp.encode([]))

BlockChain

History and current state of the block chain.

78
@final
79
@dataclass
class BlockChain:

blocks

85
    blocks: List[Block]

state

86
    state: State

chain_id

87
    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:
91
    <snip>
110
    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]:
114
    <snip>
134
    recent_blocks = chain.blocks[-255:]
135
    # TODO: This function has not been tested rigorously
136
    if len(recent_blocks) == 0:
137
        return []
138
139
    recent_block_hashes = []
140
141
    for block in recent_blocks:
142
        prev_block_hash = block.header.parent_hash
143
        recent_block_hashes.append(prev_block_hash)
144
145
    # We are computing the hash only for the most recent block and not for
146
    # the rest of the blocks as they have successors which have the hash of
147
    # the current block as parent hash.
148
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
149
    recent_block_hashes.append(most_recent_block_hash)
150
151
    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:
155
    <snip>
177
    validate_header(chain, block.header)
178
    if block.ommers != ():
179
        raise InvalidBlock
180
181
    block_state = BlockState(pre_state=chain.state)
182
183
    block_env = vm.BlockEnvironment(
184
        chain_id=chain.chain_id,
185
        state=block_state,
186
        block_gas_limit=block.header.gas_limit,
187
        block_hashes=get_last_256_block_hashes(chain),
188
        coinbase=block.header.coinbase,
189
        number=block.header.number,
190
        base_fee_per_gas=block.header.base_fee_per_gas,
191
        time=block.header.timestamp,
192
        prev_randao=block.header.prev_randao,
193
    )
194
195
    block_output = apply_body(
196
        block_env=block_env,
197
        transactions=block.transactions,
198
        withdrawals=block.withdrawals,
199
    )
200
    block_diff = extract_block_diff(block_state)
201
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
202
        block_diff.account_changes,
203
        block_diff.storage_changes,
204
        block_diff.storage_clears,
205
    )
206
    transactions_root = root(block_output.transactions_trie)
207
    receipt_root = root(block_output.receipts_trie)
208
    block_logs_bloom = logs_bloom(block_output.block_logs)
209
    withdrawals_root = root(block_output.withdrawals_trie)
210
211
    if block_output.block_gas_used != block.header.gas_used:
212
        raise InvalidBlock(
213
            f"{block_output.block_gas_used} != {block.header.gas_used}"
214
        )
215
    if transactions_root != block.header.transactions_root:
216
        raise InvalidBlock
217
    if block_state_root != block.header.state_root:
218
        raise InvalidBlock
219
    if receipt_root != block.header.receipt_root:
220
        raise InvalidBlock
221
    if block_logs_bloom != block.header.bloom:
222
        raise InvalidBlock
223
    if withdrawals_root != block.header.withdrawals_root:
224
        raise InvalidBlock
225
226
    apply_changes_to_state(chain.state, block_diff)
227
    chain.blocks.append(block)
228
    if len(chain.blocks) > 255:
229
        # Real clients have to store more blocks to deal with reorgs, but the
230
        # protocol only requires the last 255
231
        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:
240
    <snip>
260
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
261
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
262
        raise InvalidBlock
263
264
    if parent_gas_used == parent_gas_target:
265
        expected_base_fee_per_gas = parent_base_fee_per_gas
266
    elif parent_gas_used > parent_gas_target:
267
        gas_used_delta = parent_gas_used - parent_gas_target
268
269
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
270
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
271
272
        base_fee_per_gas_delta = max(
273
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
274
            Uint(1),
275
        )
276
277
        expected_base_fee_per_gas = (
278
            parent_base_fee_per_gas + base_fee_per_gas_delta
279
        )
280
    else:
281
        gas_used_delta = parent_gas_target - parent_gas_used
282
283
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
284
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
285
286
        base_fee_per_gas_delta = (
287
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
288
        )
289
290
        expected_base_fee_per_gas = (
291
            parent_base_fee_per_gas - base_fee_per_gas_delta
292
        )
293
294
    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:
298
    <snip>
316
    if header.number < Uint(1):
317
        raise InvalidBlock
318
319
    parent_header = chain.blocks[-1].header
320
321
    if header.gas_used > header.gas_limit:
322
        raise InvalidBlock
323
324
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
325
        header.gas_limit,
326
        parent_header.gas_limit,
327
        parent_header.gas_used,
328
        parent_header.base_fee_per_gas,
329
    )
330
    if expected_base_fee_per_gas != header.base_fee_per_gas:
331
        raise InvalidBlock
332
    if header.timestamp <= parent_header.timestamp:
333
        raise InvalidBlock
334
    if header.number != parent_header.number + Uint(1):
335
        raise InvalidBlock
336
    if len(header.extra_data) > 32:
337
        raise InvalidBlock
338
    if header.difficulty != 0:
339
        raise InvalidBlock
340
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
341
        raise InvalidBlock
342
    if header.ommers_hash != EMPTY_OMMER_HASH:
343
        raise InvalidBlock
344
345
    block_parent_hash = keccak256(rlp.encode(parent_header))
346
    if header.parent_hash != block_parent_hash:
347
        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.

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.

def check_transaction(block_env: ethereum.forks.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Tuple[Address, Uint]:
356
    <snip>
395
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
396
    if tx.gas > gas_available:
397
        raise GasUsedExceedsLimitError("gas used exceeds limit")
398
    tx_chain_id = chain_id(tx)
399
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
400
        raise WrongChainIdError(
401
            expected=block_env.chain_id,
402
            actual=tx_chain_id,
403
        )
404
405
    sender_address = recover_sender(tx)
406
    sender_account = get_account(tx_state, sender_address)
407
408
    if isinstance(tx, FeeMarketTransaction):
409
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
410
            raise PriorityFeeGreaterThanMaxFeeError(
411
                "priority fee greater than max fee"
412
            )
413
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
414
            raise InsufficientMaxFeePerGasError(
415
                tx.max_fee_per_gas, block_env.base_fee_per_gas
416
            )
417
418
        priority_fee_per_gas = min(
419
            tx.max_priority_fee_per_gas,
420
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
421
        )
422
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
423
        max_gas_fee = tx.gas * tx.max_fee_per_gas
424
    else:
425
        if tx.gas_price < block_env.base_fee_per_gas:
426
            raise InvalidBlock
427
        effective_gas_price = tx.gas_price
428
        max_gas_fee = tx.gas * tx.gas_price
429
430
    if sender_account.nonce > Uint(tx.nonce):
431
        raise NonceMismatchError("nonce too low")
432
    elif sender_account.nonce < Uint(tx.nonce):
433
        raise NonceMismatchError("nonce too high")
434
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
435
        raise InsufficientBalanceError("insufficient sender balance")
436
    if sender_account.code_hash != EMPTY_CODE_HASH:
437
        raise InvalidSenderError("not EOA")
438
439
    return sender_address, effective_gas_price

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:
448
    <snip>
469
    receipt = Receipt(
470
        succeeded=error is None,
471
        cumulative_gas_used=cumulative_gas_used,
472
        bloom=logs_bloom(logs),
473
        logs=logs,
474
    )
475
476
    return encode_receipt(tx, receipt)

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. block_output : The block output for the current block. 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.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​withdrawals: Tuple[Withdrawal, ...]) -> ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput:
484
    <snip>
511
    block_output = vm.BlockOutput()
512
513
    for i, tx in enumerate(map(decode_transaction, transactions)):
514
        process_transaction(block_env, block_output, tx, Uint(i))
515
516
    process_withdrawals(block_env, block_output, withdrawals)
517
518
    return block_output

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.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
527
    <snip>
551
    tx_state = TransactionState(parent=block_env.state)
552
553
    trie_set(
554
        block_output.transactions_trie,
555
        rlp.encode(index),
556
        encode_transaction(tx),
557
    )
558
559
    intrinsic_gas = validate_transaction(tx)
560
561
    (
562
        sender,
563
        effective_gas_price,
564
    ) = check_transaction(
565
        block_env=block_env,
566
        block_output=block_output,
567
        tx=tx,
568
        tx_state=tx_state,
569
    )
570
571
    sender_account = get_account(tx_state, sender)
572
573
    effective_gas_fee = tx.gas * effective_gas_price
574
575
    gas = tx.gas - intrinsic_gas
576
    increment_nonce(tx_state, sender)
577
578
    sender_balance_after_gas_fee = (
579
        Uint(sender_account.balance) - effective_gas_fee
580
    )
581
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
582
583
    access_list_addresses = set()
584
    access_list_storage_keys = set()
585
    access_list_addresses.add(block_env.coinbase)
586
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
587
        for access in tx.access_list:
588
            access_list_addresses.add(access.account)
589
            for slot in access.slots:
590
                access_list_storage_keys.add((access.account, slot))
591
592
    tx_env = vm.TransactionEnvironment(
593
        origin=sender,
594
        gas_price=effective_gas_price,
595
        gas=gas,
596
        access_list_addresses=access_list_addresses,
597
        access_list_storage_keys=access_list_storage_keys,
598
        state=tx_state,
599
        index_in_block=index,
600
        tx_hash=get_transaction_hash(encode_transaction(tx)),
601
    )
602
603
    message = prepare_message(block_env, tx_env, tx)
604
605
    tx_output = process_message_call(message)
606
607
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
608
    tx_gas_refund = min(
609
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
610
    )
611
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
612
    tx_gas_left = tx.gas - tx_gas_used_after_refund
613
    gas_refund_amount = tx_gas_left * effective_gas_price
614
615
    # For non-1559 transactions effective_gas_price == tx.gas_price
616
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
617
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
618
619
    # refund gas
620
    create_ether(tx_state, sender, U256(gas_refund_amount))
621
622
    # transfer miner fees
623
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
624
625
    for address in tx_output.accounts_to_delete:
626
        destroy_account(tx_state, address)
627
628
    block_output.block_gas_used += tx_gas_used_after_refund
629
630
    receipt = make_receipt(
631
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
632
    )
633
634
    receipt_key = rlp.encode(Uint(index))
635
    block_output.receipt_keys += (receipt_key,)
636
637
    trie_set(
638
        block_output.receipts_trie,
639
        receipt_key,
640
        receipt,
641
    )
642
643
    block_output.block_logs += tx_output.logs
644
645
    incorporate_tx_into_block(tx_state)

process_withdrawals

Increase the balance of the withdrawing account.

def process_withdrawals(block_env: ethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutput, ​​withdrawals: Tuple[Withdrawal, ...]) -> None:
653
    <snip>
656
    wd_state = TransactionState(parent=block_env.state)
657
658
    for i, wd in enumerate(withdrawals):
659
        trie_set(
660
            block_output.withdrawals_trie,
661
            rlp.encode(Uint(i)),
662
            rlp.encode(wd),
663
        )
664
665
        create_ether(wd_state, wd.address, wd.amount * U256(10**9))
666
667
    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 passed through as a parameter is greater than or equal to the sum of the parent's gas and the adjustment delta then the limit for gas is too high and fails this function's check. Similarly, if the limit is less than or equal to the difference of the parent's gas and the adjustment delta or the predefined LIMIT_MINIMUM then this function's check fails because the gas limit doesn't allow for a sufficient or reasonable amount of gas to 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:
671
    <snip>
699
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
700
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
701
        return False
702
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
703
        return False
704
    if gas_limit < GasCosts.LIMIT_MINIMUM:
705
        return False
706
707
    return True