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

71
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

72
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

76
@final
77
@dataclass
class BlockChain:

blocks

83
    blocks: List[Block]

state

84
    state: State

chain_id

85
    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:
89
    <snip>
108
    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]:
112
    <snip>
132
    recent_blocks = chain.blocks[-255:]
133
    # TODO: This function has not been tested rigorously
134
    if len(recent_blocks) == 0:
135
        return []
136
137
    recent_block_hashes = []
138
139
    for block in recent_blocks:
140
        prev_block_hash = block.header.parent_hash
141
        recent_block_hashes.append(prev_block_hash)
142
143
    # We are computing the hash only for the most recent block and not for
144
    # the rest of the blocks as they have successors which have the hash of
145
    # the current block as parent hash.
146
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
147
    recent_block_hashes.append(most_recent_block_hash)
148
149
    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:
153
    <snip>
175
    validate_header(chain, block.header)
176
    if block.ommers != ():
177
        raise InvalidBlock
178
179
    block_state = BlockState(pre_state=chain.state)
180
181
    block_env = vm.BlockEnvironment(
182
        chain_id=chain.chain_id,
183
        state=block_state,
184
        block_gas_limit=block.header.gas_limit,
185
        block_hashes=get_last_256_block_hashes(chain),
186
        coinbase=block.header.coinbase,
187
        number=block.header.number,
188
        base_fee_per_gas=block.header.base_fee_per_gas,
189
        time=block.header.timestamp,
190
        prev_randao=block.header.prev_randao,
191
    )
192
193
    block_output = apply_body(
194
        block_env=block_env,
195
        transactions=block.transactions,
196
        withdrawals=block.withdrawals,
197
    )
198
    block_diff = extract_block_diff(block_state)
199
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
200
        block_diff.account_changes,
201
        block_diff.storage_changes,
202
        block_diff.storage_clears,
203
    )
204
    transactions_root = root(block_output.transactions_trie)
205
    receipt_root = root(block_output.receipts_trie)
206
    block_logs_bloom = logs_bloom(block_output.block_logs)
207
    withdrawals_root = root(block_output.withdrawals_trie)
208
209
    if block_output.block_gas_used != block.header.gas_used:
210
        raise InvalidBlock(
211
            f"{block_output.block_gas_used} != {block.header.gas_used}"
212
        )
213
    if transactions_root != block.header.transactions_root:
214
        raise InvalidBlock
215
    if block_state_root != block.header.state_root:
216
        raise InvalidBlock
217
    if receipt_root != block.header.receipt_root:
218
        raise InvalidBlock
219
    if block_logs_bloom != block.header.bloom:
220
        raise InvalidBlock
221
    if withdrawals_root != block.header.withdrawals_root:
222
        raise InvalidBlock
223
224
    apply_changes_to_state(chain.state, block_diff)
225
    chain.blocks.append(block)
226
    if len(chain.blocks) > 255:
227
        # Real clients have to store more blocks to deal with reorgs, but the
228
        # protocol only requires the last 255
229
        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:
238
    <snip>
258
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
259
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
260
        raise InvalidBlock
261
262
    if parent_gas_used == parent_gas_target:
263
        expected_base_fee_per_gas = parent_base_fee_per_gas
264
    elif parent_gas_used > parent_gas_target:
265
        gas_used_delta = parent_gas_used - parent_gas_target
266
267
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
268
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
269
270
        base_fee_per_gas_delta = max(
271
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
272
            Uint(1),
273
        )
274
275
        expected_base_fee_per_gas = (
276
            parent_base_fee_per_gas + base_fee_per_gas_delta
277
        )
278
    else:
279
        gas_used_delta = parent_gas_target - parent_gas_used
280
281
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
282
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
283
284
        base_fee_per_gas_delta = (
285
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
286
        )
287
288
        expected_base_fee_per_gas = (
289
            parent_base_fee_per_gas - base_fee_per_gas_delta
290
        )
291
292
    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:
296
    <snip>
314
    if header.number < Uint(1):
315
        raise InvalidBlock
316
317
    parent_header = chain.blocks[-1].header
318
319
    if header.gas_used > header.gas_limit:
320
        raise InvalidBlock
321
322
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
323
        header.gas_limit,
324
        parent_header.gas_limit,
325
        parent_header.gas_used,
326
        parent_header.base_fee_per_gas,
327
    )
328
    if expected_base_fee_per_gas != header.base_fee_per_gas:
329
        raise InvalidBlock
330
    if header.timestamp <= parent_header.timestamp:
331
        raise InvalidBlock
332
    if header.number != parent_header.number + Uint(1):
333
        raise InvalidBlock
334
    if len(header.extra_data) > 32:
335
        raise InvalidBlock
336
    if header.difficulty != 0:
337
        raise InvalidBlock
338
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
339
        raise InvalidBlock
340
    if header.ommers_hash != EMPTY_OMMER_HASH:
341
        raise InvalidBlock
342
343
    block_parent_hash = keccak256(rlp.encode(parent_header))
344
    if header.parent_hash != block_parent_hash:
345
        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]:
354
    <snip>
393
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
394
    if tx.gas > gas_available:
395
        raise GasUsedExceedsLimitError("gas used exceeds limit")
396
    sender_address = recover_sender(block_env.chain_id, tx)
397
    sender_account = get_account(tx_state, sender_address)
398
399
    if isinstance(tx, FeeMarketTransaction):
400
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
401
            raise PriorityFeeGreaterThanMaxFeeError(
402
                "priority fee greater than max fee"
403
            )
404
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
405
            raise InsufficientMaxFeePerGasError(
406
                tx.max_fee_per_gas, block_env.base_fee_per_gas
407
            )
408
409
        priority_fee_per_gas = min(
410
            tx.max_priority_fee_per_gas,
411
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
412
        )
413
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
414
        max_gas_fee = tx.gas * tx.max_fee_per_gas
415
    else:
416
        if tx.gas_price < block_env.base_fee_per_gas:
417
            raise InvalidBlock
418
        effective_gas_price = tx.gas_price
419
        max_gas_fee = tx.gas * tx.gas_price
420
421
    if sender_account.nonce > Uint(tx.nonce):
422
        raise NonceMismatchError("nonce too low")
423
    elif sender_account.nonce < Uint(tx.nonce):
424
        raise NonceMismatchError("nonce too high")
425
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
426
        raise InsufficientBalanceError("insufficient sender balance")
427
    if sender_account.code_hash != EMPTY_CODE_HASH:
428
        raise InvalidSenderError("not EOA")
429
430
    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:
439
    <snip>
460
    receipt = Receipt(
461
        succeeded=error is None,
462
        cumulative_gas_used=cumulative_gas_used,
463
        bloom=logs_bloom(logs),
464
        logs=logs,
465
    )
466
467
    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:
475
    <snip>
502
    block_output = vm.BlockOutput()
503
504
    for i, tx in enumerate(map(decode_transaction, transactions)):
505
        process_transaction(block_env, block_output, tx, Uint(i))
506
507
    process_withdrawals(block_env, block_output, withdrawals)
508
509
    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:
518
    <snip>
542
    tx_state = TransactionState(parent=block_env.state)
543
544
    trie_set(
545
        block_output.transactions_trie,
546
        rlp.encode(index),
547
        encode_transaction(tx),
548
    )
549
550
    intrinsic_gas = validate_transaction(tx)
551
552
    (
553
        sender,
554
        effective_gas_price,
555
    ) = check_transaction(
556
        block_env=block_env,
557
        block_output=block_output,
558
        tx=tx,
559
        tx_state=tx_state,
560
    )
561
562
    sender_account = get_account(tx_state, sender)
563
564
    effective_gas_fee = tx.gas * effective_gas_price
565
566
    gas = tx.gas - intrinsic_gas
567
    increment_nonce(tx_state, sender)
568
569
    sender_balance_after_gas_fee = (
570
        Uint(sender_account.balance) - effective_gas_fee
571
    )
572
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
573
574
    access_list_addresses = set()
575
    access_list_storage_keys = set()
576
    access_list_addresses.add(block_env.coinbase)
577
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
578
        for access in tx.access_list:
579
            access_list_addresses.add(access.account)
580
            for slot in access.slots:
581
                access_list_storage_keys.add((access.account, slot))
582
583
    tx_env = vm.TransactionEnvironment(
584
        origin=sender,
585
        gas_price=effective_gas_price,
586
        gas=gas,
587
        access_list_addresses=access_list_addresses,
588
        access_list_storage_keys=access_list_storage_keys,
589
        state=tx_state,
590
        index_in_block=index,
591
        tx_hash=get_transaction_hash(encode_transaction(tx)),
592
    )
593
594
    message = prepare_message(block_env, tx_env, tx)
595
596
    tx_output = process_message_call(message)
597
598
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
599
    tx_gas_refund = min(
600
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
601
    )
602
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
603
    tx_gas_left = tx.gas - tx_gas_used_after_refund
604
    gas_refund_amount = tx_gas_left * effective_gas_price
605
606
    # For non-1559 transactions effective_gas_price == tx.gas_price
607
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
608
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
609
610
    # refund gas
611
    create_ether(tx_state, sender, U256(gas_refund_amount))
612
613
    # transfer miner fees
614
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
615
616
    for address in tx_output.accounts_to_delete:
617
        destroy_account(tx_state, address)
618
619
    block_output.block_gas_used += tx_gas_used_after_refund
620
621
    receipt = make_receipt(
622
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
623
    )
624
625
    receipt_key = rlp.encode(Uint(index))
626
    block_output.receipt_keys += (receipt_key,)
627
628
    trie_set(
629
        block_output.receipts_trie,
630
        receipt_key,
631
        receipt,
632
    )
633
634
    block_output.block_logs += tx_output.logs
635
636
    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:
644
    <snip>
647
    wd_state = TransactionState(parent=block_env.state)
648
649
    for i, wd in enumerate(withdrawals):
650
        trie_set(
651
            block_output.withdrawals_trie,
652
            rlp.encode(Uint(i)),
653
            rlp.encode(wd),
654
        )
655
656
        create_ether(wd_state, wd.address, wd.amount * U256(10**9))
657
658
    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:
662
    <snip>
690
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
691
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
692
        return False
693
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
694
        return False
695
    if gas_limit < GasCosts.LIMIT_MINIMUM:
696
        return False
697
698
    return True