ethereum.forks.paris.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
@dataclass
class BlockChain:

blocks

82
    blocks: List[Block]

state

83
    state: State

chain_id

84
    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:
88
    <snip>
107
    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]:
111
    <snip>
131
    recent_blocks = chain.blocks[-255:]
132
    # TODO: This function has not been tested rigorously
133
    if len(recent_blocks) == 0:
134
        return []
135
136
    recent_block_hashes = []
137
138
    for block in recent_blocks:
139
        prev_block_hash = block.header.parent_hash
140
        recent_block_hashes.append(prev_block_hash)
141
142
    # We are computing the hash only for the most recent block and not for
143
    # the rest of the blocks as they have successors which have the hash of
144
    # the current block as parent hash.
145
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
146
    recent_block_hashes.append(most_recent_block_hash)
147
148
    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:
152
    <snip>
174
    validate_header(chain, block.header)
175
    if block.ommers != ():
176
        raise InvalidBlock
177
178
    block_state = BlockState(pre_state=chain.state)
179
180
    block_env = vm.BlockEnvironment(
181
        chain_id=chain.chain_id,
182
        state=block_state,
183
        block_gas_limit=block.header.gas_limit,
184
        block_hashes=get_last_256_block_hashes(chain),
185
        coinbase=block.header.coinbase,
186
        number=block.header.number,
187
        base_fee_per_gas=block.header.base_fee_per_gas,
188
        time=block.header.timestamp,
189
        prev_randao=block.header.prev_randao,
190
    )
191
192
    block_output = apply_body(
193
        block_env=block_env,
194
        transactions=block.transactions,
195
    )
196
    block_diff = extract_block_diff(block_state)
197
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
198
        block_diff.account_changes,
199
        block_diff.storage_changes,
200
        block_diff.storage_clears,
201
    )
202
    transactions_root = root(block_output.transactions_trie)
203
    receipt_root = root(block_output.receipts_trie)
204
    block_logs_bloom = logs_bloom(block_output.block_logs)
205
206
    if block_output.block_gas_used != block.header.gas_used:
207
        raise InvalidBlock(
208
            f"{block_output.block_gas_used} != {block.header.gas_used}"
209
        )
210
    if transactions_root != block.header.transactions_root:
211
        raise InvalidBlock
212
    if block_state_root != block.header.state_root:
213
        raise InvalidBlock
214
    if receipt_root != block.header.receipt_root:
215
        raise InvalidBlock
216
    if block_logs_bloom != block.header.bloom:
217
        raise InvalidBlock
218
219
    apply_changes_to_state(chain.state, block_diff)
220
    chain.blocks.append(block)
221
    if len(chain.blocks) > 255:
222
        # Real clients have to store more blocks to deal with reorgs, but the
223
        # protocol only requires the last 255
224
        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:
233
    <snip>
253
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
254
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
255
        raise InvalidBlock
256
257
    if parent_gas_used == parent_gas_target:
258
        expected_base_fee_per_gas = parent_base_fee_per_gas
259
    elif parent_gas_used > parent_gas_target:
260
        gas_used_delta = parent_gas_used - parent_gas_target
261
262
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
263
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
264
265
        base_fee_per_gas_delta = max(
266
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
267
            Uint(1),
268
        )
269
270
        expected_base_fee_per_gas = (
271
            parent_base_fee_per_gas + base_fee_per_gas_delta
272
        )
273
    else:
274
        gas_used_delta = parent_gas_target - parent_gas_used
275
276
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
277
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
278
279
        base_fee_per_gas_delta = (
280
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
281
        )
282
283
        expected_base_fee_per_gas = (
284
            parent_base_fee_per_gas - base_fee_per_gas_delta
285
        )
286
287
    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:
291
    <snip>
309
    if header.number < Uint(1):
310
        raise InvalidBlock
311
312
    parent_header = chain.blocks[-1].header
313
314
    if header.gas_used > header.gas_limit:
315
        raise InvalidBlock
316
317
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
318
        header.gas_limit,
319
        parent_header.gas_limit,
320
        parent_header.gas_used,
321
        parent_header.base_fee_per_gas,
322
    )
323
    if expected_base_fee_per_gas != header.base_fee_per_gas:
324
        raise InvalidBlock
325
    if header.timestamp <= parent_header.timestamp:
326
        raise InvalidBlock
327
    if header.number != parent_header.number + Uint(1):
328
        raise InvalidBlock
329
    if len(header.extra_data) > 32:
330
        raise InvalidBlock
331
    if header.difficulty != 0:
332
        raise InvalidBlock
333
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
334
        raise InvalidBlock
335
    if header.ommers_hash != EMPTY_OMMER_HASH:
336
        raise InvalidBlock
337
338
    block_parent_hash = keccak256(rlp.encode(parent_header))
339
    if header.parent_hash != block_parent_hash:
340
        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.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Tuple[Address, Uint]:
349
    <snip>
388
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
389
    if tx.gas > gas_available:
390
        raise GasUsedExceedsLimitError("gas used exceeds limit")
391
    sender_address = recover_sender(block_env.chain_id, tx)
392
    sender_account = get_account(tx_state, sender_address)
393
394
    if isinstance(tx, FeeMarketTransaction):
395
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
396
            raise PriorityFeeGreaterThanMaxFeeError(
397
                "priority fee greater than max fee"
398
            )
399
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
400
            raise InsufficientMaxFeePerGasError(
401
                tx.max_fee_per_gas, block_env.base_fee_per_gas
402
            )
403
404
        priority_fee_per_gas = min(
405
            tx.max_priority_fee_per_gas,
406
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
407
        )
408
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
409
        max_gas_fee = tx.gas * tx.max_fee_per_gas
410
    else:
411
        if tx.gas_price < block_env.base_fee_per_gas:
412
            raise InvalidBlock
413
        effective_gas_price = tx.gas_price
414
        max_gas_fee = tx.gas * tx.gas_price
415
416
    if sender_account.nonce > Uint(tx.nonce):
417
        raise NonceMismatchError("nonce too low")
418
    elif sender_account.nonce < Uint(tx.nonce):
419
        raise NonceMismatchError("nonce too high")
420
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
421
        raise InsufficientBalanceError("insufficient sender balance")
422
    if sender_account.code_hash != EMPTY_CODE_HASH:
423
        raise InvalidSenderError("not EOA")
424
425
    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:
434
    <snip>
455
    receipt = Receipt(
456
        succeeded=error is None,
457
        cumulative_gas_used=cumulative_gas_used,
458
        bloom=logs_bloom(logs),
459
        logs=logs,
460
    )
461
462
    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. transactions : Transactions included in the block.

Returns

block_output : The block output for the current block.

def apply_body(block_env: ethereum.forks.paris.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...]) -> ethereum.forks.paris.vm.BlockOutput:
469
    <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
    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.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
506
    <snip>
530
    tx_state = TransactionState(parent=block_env.state)
531
532
    trie_set(
533
        block_output.transactions_trie,
534
        rlp.encode(index),
535
        encode_transaction(tx),
536
    )
537
538
    intrinsic_gas = validate_transaction(tx)
539
540
    (
541
        sender,
542
        effective_gas_price,
543
    ) = check_transaction(
544
        block_env=block_env,
545
        block_output=block_output,
546
        tx=tx,
547
        tx_state=tx_state,
548
    )
549
550
    sender_account = get_account(tx_state, sender)
551
552
    effective_gas_fee = tx.gas * effective_gas_price
553
554
    gas = tx.gas - intrinsic_gas
555
    increment_nonce(tx_state, sender)
556
557
    sender_balance_after_gas_fee = (
558
        Uint(sender_account.balance) - effective_gas_fee
559
    )
560
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
561
562
    access_list_addresses = set()
563
    access_list_storage_keys = set()
564
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
565
        for access in tx.access_list:
566
            access_list_addresses.add(access.account)
567
            for slot in access.slots:
568
                access_list_storage_keys.add((access.account, slot))
569
570
    tx_env = vm.TransactionEnvironment(
571
        origin=sender,
572
        gas_price=effective_gas_price,
573
        gas=gas,
574
        access_list_addresses=access_list_addresses,
575
        access_list_storage_keys=access_list_storage_keys,
576
        state=tx_state,
577
        index_in_block=index,
578
        tx_hash=get_transaction_hash(encode_transaction(tx)),
579
    )
580
581
    message = prepare_message(block_env, tx_env, tx)
582
583
    tx_output = process_message_call(message)
584
585
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
586
    tx_gas_refund = min(
587
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
588
    )
589
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
590
    tx_gas_left = tx.gas - tx_gas_used_after_refund
591
    gas_refund_amount = tx_gas_left * effective_gas_price
592
593
    # For non-1559 transactions effective_gas_price == tx.gas_price
594
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
595
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
596
597
    # refund gas
598
    create_ether(tx_state, sender, U256(gas_refund_amount))
599
600
    # transfer miner fees
601
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
602
603
    for address in tx_output.accounts_to_delete:
604
        destroy_account(tx_state, address)
605
606
    block_output.block_gas_used += tx_gas_used_after_refund
607
608
    receipt = make_receipt(
609
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
610
    )
611
612
    receipt_key = rlp.encode(Uint(index))
613
    block_output.receipt_keys += (receipt_key,)
614
615
    trie_set(
616
        block_output.receipts_trie,
617
        receipt_key,
618
        receipt,
619
    )
620
621
    block_output.block_logs += tx_output.logs
622
623
    incorporate_tx_into_block(tx_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:
627
    <snip>
655
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
656
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
657
        return False
658
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
659
        return False
660
    if gas_limit < GasCosts.LIMIT_MINIMUM:
661
        return False
662
663
    return True