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

68
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

69
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

73
@final
74
@dataclass
class BlockChain:

blocks

80
    blocks: List[Block]

state

81
    state: State

chain_id

82
    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:
86
    <snip>
105
    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]:
109
    <snip>
129
    recent_blocks = chain.blocks[-255:]
130
    # TODO: This function has not been tested rigorously
131
    if len(recent_blocks) == 0:
132
        return []
133
134
    recent_block_hashes = []
135
136
    for block in recent_blocks:
137
        prev_block_hash = block.header.parent_hash
138
        recent_block_hashes.append(prev_block_hash)
139
140
    # We are computing the hash only for the most recent block and not for
141
    # the rest of the blocks as they have successors which have the hash of
142
    # the current block as parent hash.
143
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
144
    recent_block_hashes.append(most_recent_block_hash)
145
146
    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:
150
    <snip>
172
    validate_header(chain, block.header)
173
    if block.ommers != ():
174
        raise InvalidBlock
175
176
    block_state = BlockState(pre_state=chain.state)
177
178
    block_env = vm.BlockEnvironment(
179
        chain_id=chain.chain_id,
180
        state=block_state,
181
        block_gas_limit=block.header.gas_limit,
182
        block_hashes=get_last_256_block_hashes(chain),
183
        coinbase=block.header.coinbase,
184
        number=block.header.number,
185
        base_fee_per_gas=block.header.base_fee_per_gas,
186
        time=block.header.timestamp,
187
        prev_randao=block.header.prev_randao,
188
    )
189
190
    block_output = apply_body(
191
        block_env=block_env,
192
        transactions=block.transactions,
193
        withdrawals=block.withdrawals,
194
    )
195
    block_diff = extract_block_diff(block_state)
196
    block_state_root = chain.state.compute_state_root(block_diff)
197
    transactions_root = root(block_output.transactions_trie)
198
    receipt_root = root(block_output.receipts_trie)
199
    block_logs_bloom = logs_bloom(block_output.block_logs)
200
    withdrawals_root = root(block_output.withdrawals_trie)
201
202
    if block_output.block_gas_used != block.header.gas_used:
203
        raise InvalidBlock(
204
            f"{block_output.block_gas_used} != {block.header.gas_used}"
205
        )
206
    if transactions_root != block.header.transactions_root:
207
        raise InvalidBlock
208
    if block_state_root != block.header.state_root:
209
        raise InvalidBlock
210
    if receipt_root != block.header.receipt_root:
211
        raise InvalidBlock
212
    if block_logs_bloom != block.header.bloom:
213
        raise InvalidBlock
214
    if withdrawals_root != block.header.withdrawals_root:
215
        raise InvalidBlock
216
217
    apply_changes_to_state(chain.state, block_diff)
218
    chain.blocks.append(block)
219
    if len(chain.blocks) > 255:
220
        # Real clients have to store more blocks to deal with reorgs, but the
221
        # protocol only requires the last 255
222
        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:
231
    <snip>
251
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
252
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
253
        raise InvalidBlock
254
255
    if parent_gas_used == parent_gas_target:
256
        expected_base_fee_per_gas = parent_base_fee_per_gas
257
    elif parent_gas_used > parent_gas_target:
258
        gas_used_delta = parent_gas_used - parent_gas_target
259
260
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
261
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
262
263
        base_fee_per_gas_delta = max(
264
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
265
            Uint(1),
266
        )
267
268
        expected_base_fee_per_gas = (
269
            parent_base_fee_per_gas + base_fee_per_gas_delta
270
        )
271
    else:
272
        gas_used_delta = parent_gas_target - parent_gas_used
273
274
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
275
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
276
277
        base_fee_per_gas_delta = (
278
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
279
        )
280
281
        expected_base_fee_per_gas = (
282
            parent_base_fee_per_gas - base_fee_per_gas_delta
283
        )
284
285
    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:
289
    <snip>
307
    if header.number < Uint(1):
308
        raise InvalidBlock
309
310
    parent_header = chain.blocks[-1].header
311
312
    if header.gas_used > header.gas_limit:
313
        raise InvalidBlock
314
315
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
316
        header.gas_limit,
317
        parent_header.gas_limit,
318
        parent_header.gas_used,
319
        parent_header.base_fee_per_gas,
320
    )
321
    if expected_base_fee_per_gas != header.base_fee_per_gas:
322
        raise InvalidBlock
323
    if header.timestamp <= parent_header.timestamp:
324
        raise InvalidBlock
325
    if header.number != parent_header.number + Uint(1):
326
        raise InvalidBlock
327
    if len(header.extra_data) > 32:
328
        raise InvalidBlock
329
    if header.difficulty != 0:
330
        raise InvalidBlock
331
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
332
        raise InvalidBlock
333
    if header.ommers_hash != EMPTY_OMMER_HASH:
334
        raise InvalidBlock
335
336
    block_parent_hash = keccak256(rlp.encode(parent_header))
337
    if header.parent_hash != block_parent_hash:
338
        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]:
347
    <snip>
384
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
385
    if tx.gas > gas_available:
386
        raise GasUsedExceedsLimitError("gas used exceeds limit")
387
    tx_chain_id = chain_id(tx)
388
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
389
        raise WrongChainIdError(
390
            expected=block_env.chain_id,
391
            actual=tx_chain_id,
392
        )
393
394
    sender_address = recover_sender(tx)
395
    sender_account = get_account(tx_state, sender_address)
396
397
    if isinstance(tx, FeeMarketTransaction):
398
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
399
            raise InsufficientMaxFeePerGasError(
400
                tx.max_fee_per_gas, block_env.base_fee_per_gas
401
            )
402
403
        priority_fee_per_gas = min(
404
            tx.max_priority_fee_per_gas,
405
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
406
        )
407
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
408
        max_gas_fee = tx.gas * tx.max_fee_per_gas
409
    else:
410
        if tx.gas_price < block_env.base_fee_per_gas:
411
            raise InvalidBlock
412
        effective_gas_price = tx.gas_price
413
        max_gas_fee = tx.gas * tx.gas_price
414
415
    if sender_account.nonce > Uint(tx.nonce):
416
        raise NonceMismatchError("nonce too low")
417
    elif sender_account.nonce < Uint(tx.nonce):
418
        raise NonceMismatchError("nonce too high")
419
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
420
        raise InsufficientBalanceError("insufficient sender balance")
421
    if sender_account.code_hash != EMPTY_CODE_HASH:
422
        raise InvalidSenderError("not EOA")
423
424
    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:
433
    <snip>
454
    receipt = Receipt(
455
        succeeded=error is None,
456
        cumulative_gas_used=cumulative_gas_used,
457
        bloom=logs_bloom(logs),
458
        logs=logs,
459
    )
460
461
    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:
469
    <snip>
496
    block_output = vm.BlockOutput()
497
498
    for i, tx in enumerate(map(decode_transaction, transactions)):
499
        process_transaction(block_env, block_output, tx, Uint(i))
500
501
    process_withdrawals(block_env, block_output, withdrawals)
502
503
    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:
512
    <snip>
536
    tx_state = TransactionState(parent=block_env.state)
537
538
    trie_set(
539
        block_output.transactions_trie,
540
        rlp.encode(index),
541
        encode_transaction(tx),
542
    )
543
544
    intrinsic_gas = validate_transaction(tx)
545
546
    (
547
        sender,
548
        effective_gas_price,
549
    ) = check_transaction(
550
        block_env=block_env,
551
        block_output=block_output,
552
        tx=tx,
553
        tx_state=tx_state,
554
    )
555
556
    sender_account = get_account(tx_state, sender)
557
558
    effective_gas_fee = tx.gas * effective_gas_price
559
560
    gas = tx.gas - intrinsic_gas
561
    increment_nonce(tx_state, sender)
562
563
    sender_balance_after_gas_fee = (
564
        Uint(sender_account.balance) - effective_gas_fee
565
    )
566
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
567
568
    access_list_addresses = set()
569
    access_list_storage_keys = set()
570
    access_list_addresses.add(block_env.coinbase)
571
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
572
        for access in tx.access_list:
573
            access_list_addresses.add(access.account)
574
            for slot in access.slots:
575
                access_list_storage_keys.add((access.account, slot))
576
577
    tx_env = vm.TransactionEnvironment(
578
        origin=sender,
579
        gas_price=effective_gas_price,
580
        gas=gas,
581
        access_list_addresses=access_list_addresses,
582
        access_list_storage_keys=access_list_storage_keys,
583
        state=tx_state,
584
        index_in_block=index,
585
        tx_hash=get_transaction_hash(encode_transaction(tx)),
586
    )
587
588
    message = prepare_message(block_env, tx_env, tx)
589
590
    tx_output = process_message_call(message)
591
592
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
593
    tx_gas_refund = min(
594
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
595
    )
596
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
597
    tx_gas_left = tx.gas - tx_gas_used_after_refund
598
    gas_refund_amount = tx_gas_left * effective_gas_price
599
600
    # For non-1559 transactions effective_gas_price == tx.gas_price
601
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
602
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
603
604
    # refund gas
605
    create_ether(tx_state, sender, U256(gas_refund_amount))
606
607
    # transfer miner fees
608
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
609
610
    for address in tx_output.accounts_to_delete:
611
        destroy_account(tx_state, address)
612
613
    block_output.block_gas_used += tx_gas_used_after_refund
614
615
    receipt = make_receipt(
616
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
617
    )
618
619
    receipt_key = rlp.encode(Uint(index))
620
    block_output.receipt_keys += (receipt_key,)
621
622
    trie_set(
623
        block_output.receipts_trie,
624
        receipt_key,
625
        receipt,
626
    )
627
628
    block_output.block_logs += tx_output.logs
629
630
    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:
638
    <snip>
641
    wd_state = TransactionState(parent=block_env.state)
642
643
    for i, wd in enumerate(withdrawals):
644
        trie_set(
645
            block_output.withdrawals_trie,
646
            rlp.encode(Uint(i)),
647
            rlp.encode(wd),
648
        )
649
650
        create_ether(wd_state, wd.address, U256(wd.amount) * U256(10**9))
651
652
    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:
656
    <snip>
684
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
685
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
686
        return False
687
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
688
        return False
689
    if gas_limit < GasCosts.LIMIT_MINIMUM:
690
        return False
691
692
    return True