ethereum.paris.fork

Ethereum Specification ^^^^^^^^^^^^^^^^^^^^^^

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

Introduction

Entry point for the Ethereum specification.

BASE_FEE_MAX_CHANGE_DENOMINATOR

57
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

58
ELASTICITY_MULTIPLIER = Uint(2)

GAS_LIMIT_ADJUSTMENT_FACTOR

59
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

60
GAS_LIMIT_MINIMUM = Uint(5000)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

64
@dataclass
class BlockChain:

blocks

70
    blocks: List[Block]

state

71
    state: State

chain_id

72
    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:
76
    """
77
    Transforms the state from the previous hard fork (`old`) into the block
78
    chain object for this hard fork and returns it.
79
80
    When forks need to implement an irregular state transition, this function
81
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
82
    an example.
83
84
    Parameters
85
    ----------
86
    old :
87
        Previous block chain object.
88
89
    Returns
90
    -------
91
    new : `BlockChain`
92
        Upgraded block chain object for this hard fork.
93
    """
94
    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]:
98
    """
99
    Obtain the list of hashes of the previous 256 blocks in order of
100
    increasing block number.
101
102
    This function will return less hashes for the first 256 blocks.
103
104
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
105
    therefore this function retrieves them.
106
107
    Parameters
108
    ----------
109
    chain :
110
        History and current state.
111
112
    Returns
113
    -------
114
    recent_block_hashes : `List[Hash32]`
115
        Hashes of the recent 256 blocks in order of increasing block number.
116
    """
117
    recent_blocks = chain.blocks[-255:]
118
    # TODO: This function has not been tested rigorously
119
    if len(recent_blocks) == 0:
120
        return []
121
122
    recent_block_hashes = []
123
124
    for block in recent_blocks:
125
        prev_block_hash = block.header.parent_hash
126
        recent_block_hashes.append(prev_block_hash)
127
128
    # We are computing the hash only for the most recent block and not for
129
    # the rest of the blocks as they have successors which have the hash of
130
    # the current block as parent hash.
131
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
132
    recent_block_hashes.append(most_recent_block_hash)
133
134
    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:
138
    """
139
    Attempts to apply a block to an existing block chain.
140
141
    All parts of the block's contents need to be verified before being added
142
    to the chain. Blocks are verified by ensuring that the contents of the
143
    block make logical sense with the contents of the parent block. The
144
    information in the block's header must also match the corresponding
145
    information in the block.
146
147
    To implement Ethereum, in theory clients are only required to store the
148
    most recent 255 blocks of the chain since as far as execution is
149
    concerned, only those blocks are accessed. Practically, however, clients
150
    should store more blocks to handle reorgs.
151
152
    Parameters
153
    ----------
154
    chain :
155
        History and current state.
156
    block :
157
        Block to apply to `chain`.
158
    """
159
    validate_header(chain, block.header)
160
    if block.ommers != ():
161
        raise InvalidBlock
162
163
    block_env = vm.BlockEnvironment(
164
        chain_id=chain.chain_id,
165
        state=chain.state,
166
        block_gas_limit=block.header.gas_limit,
167
        block_hashes=get_last_256_block_hashes(chain),
168
        coinbase=block.header.coinbase,
169
        number=block.header.number,
170
        base_fee_per_gas=block.header.base_fee_per_gas,
171
        time=block.header.timestamp,
172
        prev_randao=block.header.prev_randao,
173
    )
174
175
    block_output = apply_body(
176
        block_env=block_env,
177
        transactions=block.transactions,
178
    )
179
    block_state_root = state_root(block_env.state)
180
    transactions_root = root(block_output.transactions_trie)
181
    receipt_root = root(block_output.receipts_trie)
182
    block_logs_bloom = logs_bloom(block_output.block_logs)
183
184
    if block_output.block_gas_used != block.header.gas_used:
185
        raise InvalidBlock(
186
            f"{block_output.block_gas_used} != {block.header.gas_used}"
187
        )
188
    if transactions_root != block.header.transactions_root:
189
        raise InvalidBlock
190
    if block_state_root != block.header.state_root:
191
        raise InvalidBlock
192
    if receipt_root != block.header.receipt_root:
193
        raise InvalidBlock
194
    if block_logs_bloom != block.header.bloom:
195
        raise InvalidBlock
196
197
    chain.blocks.append(block)
198
    if len(chain.blocks) > 255:
199
        # Real clients have to store more blocks to deal with reorgs, but the
200
        # protocol only requires the last 255
201
        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:
210
    """
211
    Calculates the base fee per gas for the block.
212
213
    Parameters
214
    ----------
215
    block_gas_limit :
216
        Gas limit of the block for which the base fee is being calculated.
217
    parent_gas_limit :
218
        Gas limit of the parent block.
219
    parent_gas_used :
220
        Gas used in the parent block.
221
    parent_base_fee_per_gas :
222
        Base fee per gas of the parent block.
223
224
    Returns
225
    -------
226
    base_fee_per_gas : `Uint`
227
        Base fee per gas for the block.
228
    """
229
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
230
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
231
        raise InvalidBlock
232
233
    if parent_gas_used == parent_gas_target:
234
        expected_base_fee_per_gas = parent_base_fee_per_gas
235
    elif parent_gas_used > parent_gas_target:
236
        gas_used_delta = parent_gas_used - parent_gas_target
237
238
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
239
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
240
241
        base_fee_per_gas_delta = max(
242
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
243
            Uint(1),
244
        )
245
246
        expected_base_fee_per_gas = (
247
            parent_base_fee_per_gas + base_fee_per_gas_delta
248
        )
249
    else:
250
        gas_used_delta = parent_gas_target - parent_gas_used
251
252
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
253
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
254
255
        base_fee_per_gas_delta = (
256
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
257
        )
258
259
        expected_base_fee_per_gas = (
260
            parent_base_fee_per_gas - base_fee_per_gas_delta
261
        )
262
263
    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:
267
    """
268
    Verifies a block header.
269
270
    In order to consider a block's header valid, the logic for the
271
    quantities in the header should match the logic for the block itself.
272
    For example the header timestamp should be greater than the block's parent
273
    timestamp because the block was created *after* the parent block.
274
    Additionally, the block's number should be directly following the parent
275
    block's number since it is the next block in the sequence.
276
277
    Parameters
278
    ----------
279
    chain :
280
        History and current state.
281
    header :
282
        Header to check for correctness.
283
    """
284
    if header.number < Uint(1):
285
        raise InvalidBlock
286
287
    parent_header = chain.blocks[-1].header
288
289
    if header.gas_used > header.gas_limit:
290
        raise InvalidBlock
291
292
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
293
        header.gas_limit,
294
        parent_header.gas_limit,
295
        parent_header.gas_used,
296
        parent_header.base_fee_per_gas,
297
    )
298
    if expected_base_fee_per_gas != header.base_fee_per_gas:
299
        raise InvalidBlock
300
    if header.timestamp <= parent_header.timestamp:
301
        raise InvalidBlock
302
    if header.number != parent_header.number + Uint(1):
303
        raise InvalidBlock
304
    if len(header.extra_data) > 32:
305
        raise InvalidBlock
306
    if header.difficulty != 0:
307
        raise InvalidBlock
308
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
309
        raise InvalidBlock
310
    if header.ommers_hash != EMPTY_OMMER_HASH:
311
        raise InvalidBlock
312
313
    block_parent_hash = keccak256(rlp.encode(parent_header))
314
    if header.parent_hash != block_parent_hash:
315
        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.

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.

def check_transaction(block_env: ethereum.paris.vm.BlockEnvironment, ​​block_output: ethereum.paris.vm.BlockOutput, ​​tx: Transaction) -> Tuple[Address, Uint]:
323
    """
324
    Check if the transaction is includable in the block.
325
326
    Parameters
327
    ----------
328
    block_env :
329
        The block scoped environment.
330
    block_output :
331
        The block output for the current block.
332
    tx :
333
        The transaction.
334
335
    Returns
336
    -------
337
    sender_address :
338
        The sender of the transaction.
339
    effective_gas_price :
340
        The price to charge for gas when the transaction is executed.
341
342
    Raises
343
    ------
344
    InvalidBlock :
345
        If the transaction is not includable.
346
    """
347
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
348
    if tx.gas > gas_available:
349
        raise InvalidBlock
350
    sender_address = recover_sender(block_env.chain_id, tx)
351
    sender_account = get_account(block_env.state, sender_address)
352
353
    if isinstance(tx, FeeMarketTransaction):
354
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
355
            raise InvalidBlock
356
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
357
            raise InvalidBlock
358
359
        priority_fee_per_gas = min(
360
            tx.max_priority_fee_per_gas,
361
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
362
        )
363
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
364
        max_gas_fee = tx.gas * tx.max_fee_per_gas
365
    else:
366
        if tx.gas_price < block_env.base_fee_per_gas:
367
            raise InvalidBlock
368
        effective_gas_price = tx.gas_price
369
        max_gas_fee = tx.gas * tx.gas_price
370
371
    if sender_account.nonce != tx.nonce:
372
        raise InvalidBlock
373
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
374
        raise InvalidBlock
375
    if sender_account.code:
376
        raise InvalidSenderError("not EOA")
377
378
    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, ...]) -> Union[Bytes, Receipt]:
387
    """
388
    Make the receipt for a transaction that was executed.
389
390
    Parameters
391
    ----------
392
    tx :
393
        The executed transaction.
394
    error :
395
        Error in the top level frame of the transaction, if any.
396
    cumulative_gas_used :
397
        The total gas used so far in the block after the transaction was
398
        executed.
399
    logs :
400
        The logs produced by the transaction.
401
402
    Returns
403
    -------
404
    receipt :
405
        The receipt for the transaction.
406
    """
407
    receipt = Receipt(
408
        succeeded=error is None,
409
        cumulative_gas_used=cumulative_gas_used,
410
        bloom=logs_bloom(logs),
411
        logs=logs,
412
    )
413
414
    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.paris.vm.BlockEnvironment, ​​transactions: Tuple[Union[LegacyTransaction, Bytes], ...]) -> ethereum.paris.vm.BlockOutput:
421
    """
422
    Executes a block.
423
424
    Many of the contents of a block are stored in data structures called
425
    tries. There is a transactions trie which is similar to a ledger of the
426
    transactions stored in the current block. There is also a receipts trie
427
    which stores the results of executing a transaction, like the post state
428
    and gas used. This function creates and executes the block that is to be
429
    added to the chain.
430
431
    Parameters
432
    ----------
433
    block_env :
434
        The block scoped environment.
435
    transactions :
436
        Transactions included in the block.
437
438
    Returns
439
    -------
440
    block_output :
441
        The block output for the current block.
442
    """
443
    block_output = vm.BlockOutput()
444
445
    for i, tx in enumerate(map(decode_transaction, transactions)):
446
        process_transaction(block_env, block_output, tx, Uint(i))
447
448
    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 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.paris.vm.BlockEnvironment, ​​block_output: ethereum.paris.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
457
    """
458
    Execute a transaction against the provided environment.
459
460
    This function processes the actions needed to execute a transaction.
461
    It decrements the sender's account after calculating the gas fee and
462
    refunds them the proper amount after execution. Calling contracts,
463
    deploying code, and incrementing nonces are all examples of actions that
464
    happen within this function or from a call made within this function.
465
466
    Accounts that are marked for deletion are processed and destroyed after
467
    execution.
468
469
    Parameters
470
    ----------
471
    block_env :
472
        Environment for the Ethereum Virtual Machine.
473
    block_output :
474
        The block output for the current block.
475
    tx :
476
        Transaction to execute.
477
    index:
478
        Index of the transaction in the block.
479
    """
480
    trie_set(
481
        block_output.transactions_trie,
482
        rlp.encode(index),
483
        encode_transaction(tx),
484
    )
485
486
    intrinsic_gas = validate_transaction(tx)
487
488
    (
489
        sender,
490
        effective_gas_price,
491
    ) = check_transaction(
492
        block_env=block_env,
493
        block_output=block_output,
494
        tx=tx,
495
    )
496
497
    sender_account = get_account(block_env.state, sender)
498
499
    effective_gas_fee = tx.gas * effective_gas_price
500
501
    gas = tx.gas - intrinsic_gas
502
    increment_nonce(block_env.state, sender)
503
504
    sender_balance_after_gas_fee = (
505
        Uint(sender_account.balance) - effective_gas_fee
506
    )
507
    set_account_balance(
508
        block_env.state, sender, U256(sender_balance_after_gas_fee)
509
    )
510
511
    access_list_addresses = set()
512
    access_list_storage_keys = set()
513
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
514
        for access in tx.access_list:
515
            access_list_addresses.add(access.account)
516
            for slot in access.slots:
517
                access_list_storage_keys.add((access.account, slot))
518
519
    tx_env = vm.TransactionEnvironment(
520
        origin=sender,
521
        gas_price=effective_gas_price,
522
        gas=gas,
523
        access_list_addresses=access_list_addresses,
524
        access_list_storage_keys=access_list_storage_keys,
525
        index_in_block=index,
526
        tx_hash=get_transaction_hash(encode_transaction(tx)),
527
        traces=[],
528
    )
529
530
    message = prepare_message(block_env, tx_env, tx)
531
532
    tx_output = process_message_call(message)
533
534
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
535
    tx_gas_refund = min(
536
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
537
    )
538
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
539
    tx_gas_left = tx.gas - tx_gas_used_after_refund
540
    gas_refund_amount = tx_gas_left * effective_gas_price
541
542
    # For non-1559 transactions effective_gas_price == tx.gas_price
543
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
544
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
545
546
    # refund gas
547
    sender_balance_after_refund = get_account(
548
        block_env.state, sender
549
    ).balance + U256(gas_refund_amount)
550
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
551
552
    # transfer miner fees
553
    coinbase_balance_after_mining_fee = get_account(
554
        block_env.state, block_env.coinbase
555
    ).balance + U256(transaction_fee)
556
    if coinbase_balance_after_mining_fee != 0:
557
        set_account_balance(
558
            block_env.state,
559
            block_env.coinbase,
560
            coinbase_balance_after_mining_fee,
561
        )
562
    elif account_exists_and_is_empty(block_env.state, block_env.coinbase):
563
        destroy_account(block_env.state, block_env.coinbase)
564
565
    for address in tx_output.accounts_to_delete:
566
        destroy_account(block_env.state, address)
567
568
    block_output.block_gas_used += tx_gas_used_after_refund
569
570
    receipt = make_receipt(
571
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
572
    )
573
574
    receipt_key = rlp.encode(Uint(index))
575
    block_output.receipt_keys += (receipt_key,)
576
577
    trie_set(
578
        block_output.receipts_trie,
579
        receipt_key,
580
        receipt,
581
    )
582
583
    block_output.block_logs += tx_output.logs

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 GAS_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 GAS_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:
587
    """
588
    Validates the gas limit for a block.
589
590
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
591
    quotient of the parent block's gas limit and the
592
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
593
    passed through as a parameter is greater than or equal to the *sum* of
594
    the parent's gas and the adjustment delta then the limit for gas is too
595
    high and fails this function's check. Similarly, if the limit is less
596
    than or equal to the *difference* of the parent's gas and the adjustment
597
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
598
    check fails because the gas limit doesn't allow for a sufficient or
599
    reasonable amount of gas to be used on a block.
600
601
    Parameters
602
    ----------
603
    gas_limit :
604
        Gas limit to validate.
605
606
    parent_gas_limit :
607
        Gas limit of the parent block.
608
609
    Returns
610
    -------
611
    check : `bool`
612
        True if gas limit constraints are satisfied, False otherwise.
613
    """
614
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
615
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
616
        return False
617
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
618
        return False
619
    if gas_limit < GAS_LIMIT_MINIMUM:
620
        return False
621
622
    return True