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

69
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

70
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

74
@final
75
@dataclass
class BlockChain:

blocks

81
    blocks: List[Block]

state

82
    state: State

chain_id

83
    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:
87
    <snip>
106
    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]:
110
    <snip>
130
    recent_blocks = chain.blocks[-255:]
131
    # TODO: This function has not been tested rigorously
132
    if len(recent_blocks) == 0:
133
        return []
134
135
    recent_block_hashes = []
136
137
    for block in recent_blocks:
138
        prev_block_hash = block.header.parent_hash
139
        recent_block_hashes.append(prev_block_hash)
140
141
    # We are computing the hash only for the most recent block and not for
142
    # the rest of the blocks as they have successors which have the hash of
143
    # the current block as parent hash.
144
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
145
    recent_block_hashes.append(most_recent_block_hash)
146
147
    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:
151
    <snip>
173
    validate_header(chain, block.header)
174
    if block.ommers != ():
175
        raise InvalidBlock
176
177
    block_state = BlockState(pre_state=chain.state)
178
179
    block_env = vm.BlockEnvironment(
180
        chain_id=chain.chain_id,
181
        state=block_state,
182
        block_gas_limit=block.header.gas_limit,
183
        block_hashes=get_last_256_block_hashes(chain),
184
        coinbase=block.header.coinbase,
185
        number=block.header.number,
186
        base_fee_per_gas=block.header.base_fee_per_gas,
187
        time=block.header.timestamp,
188
        prev_randao=block.header.prev_randao,
189
    )
190
191
    block_output = apply_body(
192
        block_env=block_env,
193
        transactions=block.transactions,
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
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
214
    apply_changes_to_state(chain.state, block_diff)
215
    chain.blocks.append(block)
216
    if len(chain.blocks) > 255:
217
        # Real clients have to store more blocks to deal with reorgs, but the
218
        # protocol only requires the last 255
219
        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:
228
    <snip>
248
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
249
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
250
        raise InvalidBlock
251
252
    if parent_gas_used == parent_gas_target:
253
        expected_base_fee_per_gas = parent_base_fee_per_gas
254
    elif parent_gas_used > parent_gas_target:
255
        gas_used_delta = parent_gas_used - parent_gas_target
256
257
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
258
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
259
260
        base_fee_per_gas_delta = max(
261
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
262
            Uint(1),
263
        )
264
265
        expected_base_fee_per_gas = (
266
            parent_base_fee_per_gas + base_fee_per_gas_delta
267
        )
268
    else:
269
        gas_used_delta = parent_gas_target - parent_gas_used
270
271
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
272
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
273
274
        base_fee_per_gas_delta = (
275
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
276
        )
277
278
        expected_base_fee_per_gas = (
279
            parent_base_fee_per_gas - base_fee_per_gas_delta
280
        )
281
282
    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:
286
    <snip>
304
    if header.number < Uint(1):
305
        raise InvalidBlock
306
307
    parent_header = chain.blocks[-1].header
308
309
    if header.gas_used > header.gas_limit:
310
        raise InvalidBlock
311
312
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
313
        header.gas_limit,
314
        parent_header.gas_limit,
315
        parent_header.gas_used,
316
        parent_header.base_fee_per_gas,
317
    )
318
    if expected_base_fee_per_gas != header.base_fee_per_gas:
319
        raise InvalidBlock
320
    if header.timestamp <= parent_header.timestamp:
321
        raise InvalidBlock
322
    if header.number != parent_header.number + Uint(1):
323
        raise InvalidBlock
324
    if len(header.extra_data) > 32:
325
        raise InvalidBlock
326
    if header.difficulty != 0:
327
        raise InvalidBlock
328
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
329
        raise InvalidBlock
330
    if header.ommers_hash != EMPTY_OMMER_HASH:
331
        raise InvalidBlock
332
333
    block_parent_hash = keccak256(rlp.encode(parent_header))
334
    if header.parent_hash != block_parent_hash:
335
        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]:
344
    <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 < tx.max_priority_fee_per_gas:
398
            raise PriorityFeeGreaterThanMaxFeeError(
399
                "priority fee greater than max fee"
400
            )
401
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
402
            raise InsufficientMaxFeePerGasError(
403
                tx.max_fee_per_gas, block_env.base_fee_per_gas
404
            )
405
406
        priority_fee_per_gas = min(
407
            tx.max_priority_fee_per_gas,
408
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
409
        )
410
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
411
        max_gas_fee = tx.gas * tx.max_fee_per_gas
412
    else:
413
        if tx.gas_price < block_env.base_fee_per_gas:
414
            raise InvalidBlock
415
        effective_gas_price = tx.gas_price
416
        max_gas_fee = tx.gas * tx.gas_price
417
418
    if sender_account.nonce > Uint(tx.nonce):
419
        raise NonceMismatchError("nonce too low")
420
    elif sender_account.nonce < Uint(tx.nonce):
421
        raise NonceMismatchError("nonce too high")
422
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
423
        raise InsufficientBalanceError("insufficient sender balance")
424
    if sender_account.code_hash != EMPTY_CODE_HASH:
425
        raise InvalidSenderError("not EOA")
426
427
    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:
436
    <snip>
457
    receipt = Receipt(
458
        succeeded=error is None,
459
        cumulative_gas_used=cumulative_gas_used,
460
        bloom=logs_bloom(logs),
461
        logs=logs,
462
    )
463
464
    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:
471
    <snip>
494
    block_output = vm.BlockOutput()
495
496
    for i, tx in enumerate(map(decode_transaction, transactions)):
497
        process_transaction(block_env, block_output, tx, Uint(i))
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.paris.vm.BlockEnvironment, ​​block_output: ethereum.forks.paris.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
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
567
        for access in tx.access_list:
568
            access_list_addresses.add(access.account)
569
            for slot in access.slots:
570
                access_list_storage_keys.add((access.account, slot))
571
572
    tx_env = vm.TransactionEnvironment(
573
        origin=sender,
574
        gas_price=effective_gas_price,
575
        gas=gas,
576
        access_list_addresses=access_list_addresses,
577
        access_list_storage_keys=access_list_storage_keys,
578
        state=tx_state,
579
        index_in_block=index,
580
        tx_hash=get_transaction_hash(encode_transaction(tx)),
581
    )
582
583
    message = prepare_message(block_env, tx_env, tx)
584
585
    tx_output = process_message_call(message)
586
587
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
588
    tx_gas_refund = min(
589
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
590
    )
591
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
592
    tx_gas_left = tx.gas - tx_gas_used_after_refund
593
    gas_refund_amount = tx_gas_left * effective_gas_price
594
595
    # For non-1559 transactions effective_gas_price == tx.gas_price
596
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
597
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
598
599
    # refund gas
600
    create_ether(tx_state, sender, U256(gas_refund_amount))
601
602
    # transfer miner fees
603
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
604
605
    for address in tx_output.accounts_to_delete:
606
        destroy_account(tx_state, address)
607
608
    block_output.block_gas_used += tx_gas_used_after_refund
609
610
    receipt = make_receipt(
611
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
612
    )
613
614
    receipt_key = rlp.encode(Uint(index))
615
    block_output.receipt_keys += (receipt_key,)
616
617
    trie_set(
618
        block_output.receipts_trie,
619
        receipt_key,
620
        receipt,
621
    )
622
623
    block_output.block_logs += tx_output.logs
624
625
    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:
629
    <snip>
657
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
658
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
659
        return False
660
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
661
        return False
662
    if gas_limit < GasCosts.LIMIT_MINIMUM:
663
        return False
664
665
    return True