ethereum.forks.shanghai.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BASE_FEE_MAX_CHANGE_DENOMINATOR

65
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

66
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

70
@final
71
@dataclass
class BlockChain:

blocks

77
    blocks: List[Block]

state

78
    state: State

chain_id

79
    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:
83
    <snip>
102
    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]:
106
    <snip>
126
    recent_blocks = chain.blocks[-255:]
127
    if len(recent_blocks) == 0:
128
        return []
129
130
    recent_block_hashes = []
131
132
    for block in recent_blocks:
133
        prev_block_hash = block.header.parent_hash
134
        recent_block_hashes.append(prev_block_hash)
135
136
    # We are computing the hash only for the most recent block and not for
137
    # the rest of the blocks as they have successors which have the hash of
138
    # the current block as parent hash.
139
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
140
    recent_block_hashes.append(most_recent_block_hash)
141
142
    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:
146
    <snip>
168
    validate_header(chain, block.header)
169
    if block.ommers != ():
170
        raise InvalidBlock
171
172
    block_state = BlockState(pre_state=chain.state)
173
174
    block_env = vm.BlockEnvironment(
175
        chain_id=chain.chain_id,
176
        state=block_state,
177
        block_gas_limit=block.header.gas_limit,
178
        block_hashes=get_last_256_block_hashes(chain),
179
        coinbase=block.header.coinbase,
180
        number=block.header.number,
181
        base_fee_per_gas=block.header.base_fee_per_gas,
182
        time=block.header.timestamp,
183
        prev_randao=block.header.prev_randao,
184
    )
185
186
    block_output = apply_body(
187
        block_env=block_env,
188
        transactions=block.transactions,
189
        withdrawals=block.withdrawals,
190
    )
191
    block_diff = extract_block_diff(block_state)
192
    block_state_root = chain.state.compute_state_root(block_diff)
193
    transactions_root = root(block_output.transactions_trie)
194
    receipt_root = root(block_output.receipts_trie)
195
    block_logs_bloom = logs_bloom(block_output.block_logs)
196
    withdrawals_root = root(block_output.withdrawals_trie)
197
198
    if block_output.block_gas_used != block.header.gas_used:
199
        raise InvalidBlock(
200
            f"{block_output.block_gas_used} != {block.header.gas_used}"
201
        )
202
    if transactions_root != block.header.transactions_root:
203
        raise InvalidBlock
204
    if block_state_root != block.header.state_root:
205
        raise InvalidBlock
206
    if receipt_root != block.header.receipt_root:
207
        raise InvalidBlock
208
    if block_logs_bloom != block.header.bloom:
209
        raise InvalidBlock
210
    if withdrawals_root != block.header.withdrawals_root:
211
        raise InvalidBlock
212
213
    apply_changes_to_state(chain.state, block_diff)
214
    chain.blocks.append(block)
215
    if len(chain.blocks) > 255:
216
        # Real clients have to store more blocks to deal with reorgs, but the
217
        # protocol only requires the last 255
218
        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:
227
    <snip>
247
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
248
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
249
        raise InvalidBlock
250
251
    if parent_gas_used == parent_gas_target:
252
        expected_base_fee_per_gas = parent_base_fee_per_gas
253
    elif parent_gas_used > parent_gas_target:
254
        gas_used_delta = parent_gas_used - parent_gas_target
255
256
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
257
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
258
259
        base_fee_per_gas_delta = max(
260
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
261
            Uint(1),
262
        )
263
264
        expected_base_fee_per_gas = (
265
            parent_base_fee_per_gas + base_fee_per_gas_delta
266
        )
267
    else:
268
        gas_used_delta = parent_gas_target - parent_gas_used
269
270
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
271
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
272
273
        base_fee_per_gas_delta = (
274
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
275
        )
276
277
        expected_base_fee_per_gas = (
278
            parent_base_fee_per_gas - base_fee_per_gas_delta
279
        )
280
281
    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:
285
    <snip>
303
    if header.number < Uint(1):
304
        raise InvalidBlock
305
306
    parent_header = chain.blocks[-1].header
307
308
    if header.gas_used > header.gas_limit:
309
        raise InvalidBlock
310
311
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
312
        header.gas_limit,
313
        parent_header.gas_limit,
314
        parent_header.gas_used,
315
        parent_header.base_fee_per_gas,
316
    )
317
    if expected_base_fee_per_gas != header.base_fee_per_gas:
318
        raise InvalidBlock
319
    if header.timestamp <= parent_header.timestamp:
320
        raise InvalidBlock
321
    if header.number != parent_header.number + Uint(1):
322
        raise InvalidBlock
323
    if len(header.extra_data) > 32:
324
        raise InvalidBlock
325
    if header.difficulty != 0:
326
        raise InvalidBlock
327
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
328
        raise InvalidBlock
329
    if header.ommers_hash != EMPTY_OMMER_HASH:
330
        raise InvalidBlock
331
332
    block_parent_hash = keccak256(rlp.encode(parent_header))
333
    if header.parent_hash != block_parent_hash:
334
        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. InsufficientMaxFeePerGasError : If the maximum fee per gas is insufficient for the transaction.

def check_transaction(​block_env: ethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState​) -> Tuple[Address, Uint]:
343
    <snip>
380
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
381
    if tx.gas > gas_available:
382
        raise GasUsedExceedsLimitError("gas used exceeds limit")
383
    tx_chain_id = chain_id(tx)
384
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
385
        raise WrongChainIdError(
386
            expected=block_env.chain_id,
387
            actual=tx_chain_id,
388
        )
389
390
    sender_address = recover_sender(tx)
391
    sender_account = get_account(tx_state, sender_address)
392
393
    if isinstance(tx, FeeMarketTransaction):
394
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
395
            raise InsufficientMaxFeePerGasError(
396
                tx.max_fee_per_gas, block_env.base_fee_per_gas
397
            )
398
399
        priority_fee_per_gas = min(
400
            tx.max_priority_fee_per_gas,
401
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
402
        )
403
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
404
        max_gas_fee = tx.gas * tx.max_fee_per_gas
405
    else:
406
        if tx.gas_price < block_env.base_fee_per_gas:
407
            raise InvalidBlock
408
        effective_gas_price = tx.gas_price
409
        max_gas_fee = tx.gas * tx.gas_price
410
411
    if sender_account.nonce > Uint(tx.nonce):
412
        raise NonceMismatchError("nonce too low")
413
    elif sender_account.nonce < Uint(tx.nonce):
414
        raise NonceMismatchError("nonce too high")
415
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
416
        raise InsufficientBalanceError("insufficient sender balance")
417
    if sender_account.code_hash != EMPTY_CODE_HASH:
418
        raise InvalidSenderError("not EOA")
419
420
    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:
429
    <snip>
450
    receipt = Receipt(
451
        succeeded=error is None,
452
        cumulative_gas_used=cumulative_gas_used,
453
        bloom=logs_bloom(logs),
454
        logs=logs,
455
    )
456
457
    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.shanghai.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​withdrawals: Tuple[Withdrawal, ...]​) -> ethereum.forks.shanghai.vm.BlockOutput:
465
    <snip>
492
    block_output = vm.BlockOutput()
493
494
    for i, tx in enumerate(map(decode_transaction, transactions)):
495
        process_transaction(block_env, block_output, tx, Uint(i))
496
497
    process_withdrawals(block_env, block_output, withdrawals)
498
499
    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.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint​) -> None:
508
    <snip>
532
    tx_state = TransactionState(parent=block_env.state)
533
534
    trie_set(
535
        block_output.transactions_trie,
536
        rlp.encode(index),
537
        encode_transaction(tx),
538
    )
539
540
    intrinsic_gas = validate_transaction(tx)
541
542
    (
543
        sender,
544
        effective_gas_price,
545
    ) = check_transaction(
546
        block_env=block_env,
547
        block_output=block_output,
548
        tx=tx,
549
        tx_state=tx_state,
550
    )
551
552
    sender_account = get_account(tx_state, sender)
553
554
    effective_gas_fee = tx.gas * effective_gas_price
555
556
    gas = tx.gas - intrinsic_gas
557
    increment_nonce(tx_state, sender)
558
559
    sender_balance_after_gas_fee = (
560
        Uint(sender_account.balance) - effective_gas_fee
561
    )
562
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
563
564
    access_list_addresses = set()
565
    access_list_storage_keys = set()
566
    access_list_addresses.add(block_env.coinbase)
567
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
568
        for access in tx.access_list:
569
            access_list_addresses.add(access.account)
570
            for slot in access.slots:
571
                access_list_storage_keys.add((access.account, slot))
572
573
    tx_env = vm.TransactionEnvironment(
574
        origin=sender,
575
        gas_price=effective_gas_price,
576
        gas=gas,
577
        access_list_addresses=access_list_addresses,
578
        access_list_storage_keys=access_list_storage_keys,
579
        state=tx_state,
580
        index_in_block=index,
581
        tx_hash=get_transaction_hash(encode_transaction(tx)),
582
    )
583
584
    message = prepare_message(block_env, tx_env, tx)
585
586
    tx_output = process_message_call(message)
587
588
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
589
    tx_gas_refund = min(
590
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
591
    )
592
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
593
    tx_gas_left = tx.gas - tx_gas_used_after_refund
594
    gas_refund_amount = tx_gas_left * effective_gas_price
595
596
    # For non-1559 transactions effective_gas_price == tx.gas_price
597
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
598
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
599
600
    # refund gas
601
    create_ether(tx_state, sender, U256(gas_refund_amount))
602
603
    # transfer miner fees
604
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
605
606
    for address in tx_output.accounts_to_delete:
607
        destroy_account(tx_state, address)
608
609
    block_output.block_gas_used += tx_gas_used_after_refund
610
611
    receipt = make_receipt(
612
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
613
    )
614
615
    receipt_key = rlp.encode(Uint(index))
616
    block_output.receipt_keys += (receipt_key,)
617
618
    trie_set(
619
        block_output.receipts_trie,
620
        receipt_key,
621
        receipt,
622
    )
623
624
    block_output.block_logs += tx_output.logs
625
626
    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:
634
    <snip>
637
    wd_state = TransactionState(parent=block_env.state)
638
639
    for i, wd in enumerate(withdrawals):
640
        trie_set(
641
            block_output.withdrawals_trie,
642
            rlp.encode(Uint(i)),
643
            rlp.encode(wd),
644
        )
645
646
        create_ether(wd_state, wd.address, U256(wd.amount) * U256(10**9))
647
648
    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:
652
    <snip>
680
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
681
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
682
        return False
683
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
684
        return False
685
    if gas_limit < GasCosts.LIMIT_MINIMUM:
686
        return False
687
688
    return True