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

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