ethereum.forks.arrow_glacier.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

74
BLOCK_REWARD = U256(2 * 10**18)

BASE_FEE_MAX_CHANGE_DENOMINATOR

75
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

76
ELASTICITY_MULTIPLIER = Uint(2)

MINIMUM_DIFFICULTY

77
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

78
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

79
BOMB_DELAY_BLOCKS = 10700000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

83
@dataclass
class BlockChain:

blocks

89
    blocks: List[Block]

state

90
    state: State

chain_id

91
    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:
95
    """
96
    Transforms the state from the previous hard fork (`old`) into the block
97
    chain object for this hard fork and returns it.
98
99
    When forks need to implement an irregular state transition, this function
100
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
101
    an example.
102
103
    Parameters
104
    ----------
105
    old :
106
        Previous block chain object.
107
108
    Returns
109
    -------
110
    new : `BlockChain`
111
        Upgraded block chain object for this hard fork.
112
113
    """
114
    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]:
118
    """
119
    Obtain the list of hashes of the previous 256 blocks in order of
120
    increasing block number.
121
122
    This function will return less hashes for the first 256 blocks.
123
124
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
125
    therefore this function retrieves them.
126
127
    Parameters
128
    ----------
129
    chain :
130
        History and current state.
131
132
    Returns
133
    -------
134
    recent_block_hashes : `List[Hash32]`
135
        Hashes of the recent 256 blocks in order of increasing block number.
136
137
    """
138
    recent_blocks = chain.blocks[-255:]
139
    # TODO: This function has not been tested rigorously
140
    if len(recent_blocks) == 0:
141
        return []
142
143
    recent_block_hashes = []
144
145
    for block in recent_blocks:
146
        prev_block_hash = block.header.parent_hash
147
        recent_block_hashes.append(prev_block_hash)
148
149
    # We are computing the hash only for the most recent block and not for
150
    # the rest of the blocks as they have successors which have the hash of
151
    # the current block as parent hash.
152
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
153
    recent_block_hashes.append(most_recent_block_hash)
154
155
    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:
159
    """
160
    Attempts to apply a block to an existing block chain.
161
162
    All parts of the block's contents need to be verified before being added
163
    to the chain. Blocks are verified by ensuring that the contents of the
164
    block make logical sense with the contents of the parent block. The
165
    information in the block's header must also match the corresponding
166
    information in the block.
167
168
    To implement Ethereum, in theory clients are only required to store the
169
    most recent 255 blocks of the chain since as far as execution is
170
    concerned, only those blocks are accessed. Practically, however, clients
171
    should store more blocks to handle reorgs.
172
173
    Parameters
174
    ----------
175
    chain :
176
        History and current state.
177
    block :
178
        Block to apply to `chain`.
179
180
    """
181
    validate_header(chain, block.header)
182
    validate_ommers(block.ommers, block.header, chain)
183
184
    block_state = BlockState(pre_state=chain.state)
185
186
    block_env = vm.BlockEnvironment(
187
        chain_id=chain.chain_id,
188
        state=block_state,
189
        block_gas_limit=block.header.gas_limit,
190
        block_hashes=get_last_256_block_hashes(chain),
191
        coinbase=block.header.coinbase,
192
        number=block.header.number,
193
        base_fee_per_gas=block.header.base_fee_per_gas,
194
        time=block.header.timestamp,
195
        difficulty=block.header.difficulty,
196
    )
197
198
    block_output = apply_body(
199
        block_env=block_env,
200
        transactions=block.transactions,
201
        ommers=block.ommers,
202
    )
203
    block_diff = extract_block_diff(block_state)
204
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
205
        block_diff.account_changes,
206
        block_diff.storage_changes,
207
        block_diff.storage_clears,
208
    )
209
    transactions_root = root(block_output.transactions_trie)
210
    receipt_root = root(block_output.receipts_trie)
211
    block_logs_bloom = logs_bloom(block_output.block_logs)
212
213
    if block_output.block_gas_used != block.header.gas_used:
214
        raise InvalidBlock(
215
            f"{block_output.block_gas_used} != {block.header.gas_used}"
216
        )
217
    if transactions_root != block.header.transactions_root:
218
        raise InvalidBlock
219
    if block_state_root != block.header.state_root:
220
        raise InvalidBlock
221
    if receipt_root != block.header.receipt_root:
222
        raise InvalidBlock
223
    if block_logs_bloom != block.header.bloom:
224
        raise InvalidBlock
225
226
    apply_changes_to_state(chain.state, block_diff)
227
    chain.blocks.append(block)
228
    if len(chain.blocks) > 255:
229
        # Real clients have to store more blocks to deal with reorgs, but the
230
        # protocol only requires the last 255
231
        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:
240
    """
241
    Calculates the base fee per gas for the block.
242
243
    Parameters
244
    ----------
245
    block_gas_limit :
246
        Gas limit of the block for which the base fee is being calculated.
247
    parent_gas_limit :
248
        Gas limit of the parent block.
249
    parent_gas_used :
250
        Gas used in the parent block.
251
    parent_base_fee_per_gas :
252
        Base fee per gas of the parent block.
253
254
    Returns
255
    -------
256
    base_fee_per_gas : `Uint`
257
        Base fee per gas for the block.
258
259
    """
260
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
261
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
262
        raise InvalidBlock
263
264
    if parent_gas_used == parent_gas_target:
265
        expected_base_fee_per_gas = parent_base_fee_per_gas
266
    elif parent_gas_used > parent_gas_target:
267
        gas_used_delta = parent_gas_used - parent_gas_target
268
269
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
270
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
271
272
        base_fee_per_gas_delta = max(
273
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
274
            Uint(1),
275
        )
276
277
        expected_base_fee_per_gas = (
278
            parent_base_fee_per_gas + base_fee_per_gas_delta
279
        )
280
    else:
281
        gas_used_delta = parent_gas_target - parent_gas_used
282
283
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
284
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
285
286
        base_fee_per_gas_delta = (
287
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
288
        )
289
290
        expected_base_fee_per_gas = (
291
            parent_base_fee_per_gas - base_fee_per_gas_delta
292
        )
293
294
    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:
298
    """
299
    Verifies a block header.
300
301
    In order to consider a block's header valid, the logic for the
302
    quantities in the header should match the logic for the block itself.
303
    For example the header timestamp should be greater than the block's parent
304
    timestamp because the block was created *after* the parent block.
305
    Additionally, the block's number should be directly following the parent
306
    block's number since it is the next block in the sequence.
307
308
    Parameters
309
    ----------
310
    chain :
311
        History and current state.
312
    header :
313
        Header to check for correctness.
314
315
    """
316
    if header.number < Uint(1):
317
        raise InvalidBlock
318
    parent_header_number = header.number - Uint(1)
319
    first_block_number = chain.blocks[0].header.number
320
    last_block_number = chain.blocks[-1].header.number
321
322
    if (
323
        parent_header_number < first_block_number
324
        or parent_header_number > last_block_number
325
    ):
326
        raise InvalidBlock
327
328
    parent_header = chain.blocks[
329
        parent_header_number - first_block_number
330
    ].header
331
332
    if header.gas_used > header.gas_limit:
333
        raise InvalidBlock
334
335
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
336
        header.gas_limit,
337
        parent_header.gas_limit,
338
        parent_header.gas_used,
339
        parent_header.base_fee_per_gas,
340
    )
341
    if expected_base_fee_per_gas != header.base_fee_per_gas:
342
        raise InvalidBlock
343
344
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
345
    if header.timestamp <= parent_header.timestamp:
346
        raise InvalidBlock
347
    if header.number != parent_header.number + Uint(1):
348
        raise InvalidBlock
349
    if len(header.extra_data) > 32:
350
        raise InvalidBlock
351
352
    block_difficulty = calculate_block_difficulty(
353
        header.number,
354
        header.timestamp,
355
        parent_header.timestamp,
356
        parent_header.difficulty,
357
        parent_has_ommers,
358
    )
359
    if header.difficulty != block_difficulty:
360
        raise InvalidBlock
361
362
    block_parent_hash = keccak256(rlp.encode(parent_header))
363
    if header.parent_hash != block_parent_hash:
364
        raise InvalidBlock
365
366
    validate_proof_of_work(header)

generate_header_hash_for_pow

Generate rlp hash of the header which is to be used for Proof-of-Work verification.

In other words, the PoW artefacts mix_digest and nonce are ignored while calculating this hash.

A particular PoW is valid for a single hash, that hash is computed by this function. The nonce and mix_digest are omitted from this hash because they are being changed by miners in their search for a sufficient proof-of-work.

Parameters

header : The header object for which the hash is to be generated.

Returns

hash : Hash32 The PoW valid rlp hash of the passed in header.

def generate_header_hash_for_pow(header: Header) -> Hash32:
370
    """
371
    Generate rlp hash of the header which is to be used for Proof-of-Work
372
    verification.
373
374
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
375
    while calculating this hash.
376
377
    A particular PoW is valid for a single hash, that hash is computed by
378
    this function. The `nonce` and `mix_digest` are omitted from this hash
379
    because they are being changed by miners in their search for a sufficient
380
    proof-of-work.
381
382
    Parameters
383
    ----------
384
    header :
385
        The header object for which the hash is to be generated.
386
387
    Returns
388
    -------
389
    hash : `Hash32`
390
        The PoW valid rlp hash of the passed in header.
391
392
    """
393
    header_data_without_pow_artefacts = (
394
        header.parent_hash,
395
        header.ommers_hash,
396
        header.coinbase,
397
        header.state_root,
398
        header.transactions_root,
399
        header.receipt_root,
400
        header.bloom,
401
        header.difficulty,
402
        header.number,
403
        header.gas_limit,
404
        header.gas_used,
405
        header.timestamp,
406
        header.extra_data,
407
        header.base_fee_per_gas,
408
    )
409
410
    return keccak256(rlp.encode(header_data_without_pow_artefacts))

validate_proof_of_work

Validates the Proof of Work constraints.

In order to verify that a miner's proof-of-work is valid for a block, a mix-digest and result are calculated using the hashimoto_light hash function. The mix digest is a hash of the header and the nonce that is passed through and it confirms whether or not proof-of-work was done on the correct block. The result is the actual hash value of the block.

Parameters

header : Header of interest.

def validate_proof_of_work(header: Header) -> None:
414
    """
415
    Validates the Proof of Work constraints.
416
417
    In order to verify that a miner's proof-of-work is valid for a block, a
418
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
419
    hash function. The mix digest is a hash of the header and the nonce that
420
    is passed through and it confirms whether or not proof-of-work was done
421
    on the correct block. The result is the actual hash value of the block.
422
423
    Parameters
424
    ----------
425
    header :
426
        Header of interest.
427
428
    """
429
    header_hash = generate_header_hash_for_pow(header)
430
    # TODO: Memoize this somewhere and read from that data instead of
431
    # calculating cache for every block validation.
432
    cache = generate_cache(header.number)
433
    mix_digest, result = hashimoto_light(
434
        header_hash, header.nonce, cache, dataset_size(header.number)
435
    )
436
    if mix_digest != header.mix_digest:
437
        raise InvalidBlock
438
439
    limit = Uint(U256.MAX_VALUE) + Uint(1)
440
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
441
        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.arrow_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.arrow_glacier.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Tuple[Address, Uint]:
450
    """
451
    Check if the transaction is includable in the block.
452
453
    Parameters
454
    ----------
455
    block_env :
456
        The block scoped environment.
457
    block_output :
458
        The block output for the current block.
459
    tx :
460
        The transaction.
461
    tx_state :
462
        The transaction state tracker.
463
464
    Returns
465
    -------
466
    sender_address :
467
        The sender of the transaction.
468
    effective_gas_price :
469
        The price to charge for gas when the transaction is executed.
470
471
    Raises
472
    ------
473
    InvalidBlock :
474
        If the transaction is not includable.
475
    GasUsedExceedsLimitError :
476
        If the gas used by the transaction exceeds the block's gas limit.
477
    NonceMismatchError :
478
        If the nonce of the transaction is not equal to the sender's nonce.
479
    InsufficientBalanceError :
480
        If the sender's balance is not enough to pay for the transaction.
481
    InvalidSenderError :
482
        If the transaction is from an address that does not exist anymore.
483
    PriorityFeeGreaterThanMaxFeeError :
484
        If the priority fee is greater than the maximum fee per gas.
485
    InsufficientMaxFeePerGasError :
486
        If the maximum fee per gas is insufficient for the transaction.
487
488
    """
489
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
490
    if tx.gas > gas_available:
491
        raise GasUsedExceedsLimitError("gas used exceeds limit")
492
    sender_address = recover_sender(block_env.chain_id, tx)
493
    sender_account = get_account(tx_state, sender_address)
494
495
    if isinstance(tx, FeeMarketTransaction):
496
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
497
            raise PriorityFeeGreaterThanMaxFeeError(
498
                "priority fee greater than max fee"
499
            )
500
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
501
            raise InsufficientMaxFeePerGasError(
502
                tx.max_fee_per_gas, block_env.base_fee_per_gas
503
            )
504
505
        priority_fee_per_gas = min(
506
            tx.max_priority_fee_per_gas,
507
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
508
        )
509
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
510
        max_gas_fee = tx.gas * tx.max_fee_per_gas
511
    else:
512
        if tx.gas_price < block_env.base_fee_per_gas:
513
            raise InvalidBlock
514
        effective_gas_price = tx.gas_price
515
        max_gas_fee = tx.gas * tx.gas_price
516
517
    if sender_account.nonce > Uint(tx.nonce):
518
        raise NonceMismatchError("nonce too low")
519
    elif sender_account.nonce < Uint(tx.nonce):
520
        raise NonceMismatchError("nonce too high")
521
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
522
        raise InsufficientBalanceError("insufficient sender balance")
523
    if sender_account.code_hash != EMPTY_CODE_HASH:
524
        raise InvalidSenderError("not EOA")
525
526
    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:
535
    """
536
    Make the receipt for a transaction that was executed.
537
538
    Parameters
539
    ----------
540
    tx :
541
        The executed transaction.
542
    error :
543
        Error in the top level frame of the transaction, if any.
544
    cumulative_gas_used :
545
        The total gas used so far in the block after the transaction was
546
        executed.
547
    logs :
548
        The logs produced by the transaction.
549
550
    Returns
551
    -------
552
    receipt :
553
        The receipt for the transaction.
554
555
    """
556
    receipt = Receipt(
557
        succeeded=error is None,
558
        cumulative_gas_used=cumulative_gas_used,
559
        bloom=logs_bloom(logs),
560
        logs=logs,
561
    )
562
563
    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. ommers : Headers of ancestor blocks which are not direct parents (formerly uncles.)

Returns

block_output : The block output for the current block.

def apply_body(block_env: ethereum.forks.arrow_glacier.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.arrow_glacier.vm.BlockOutput:
571
    """
572
    Executes a block.
573
574
    Many of the contents of a block are stored in data structures called
575
    tries. There is a transactions trie which is similar to a ledger of the
576
    transactions stored in the current block. There is also a receipts trie
577
    which stores the results of executing a transaction, like the post state
578
    and gas used. This function creates and executes the block that is to be
579
    added to the chain.
580
581
    Parameters
582
    ----------
583
    block_env :
584
        The block scoped environment.
585
    transactions :
586
        Transactions included in the block.
587
    ommers :
588
        Headers of ancestor blocks which are not direct parents (formerly
589
        uncles.)
590
591
    Returns
592
    -------
593
    block_output :
594
        The block output for the current block.
595
596
    """
597
    block_output = vm.BlockOutput()
598
599
    for i, tx in enumerate(map(decode_transaction, transactions)):
600
        process_transaction(block_env, block_output, tx, Uint(i))
601
602
    pay_rewards(block_env, ommers)
603
604
    return block_output

validate_ommers

Validates the ommers mentioned in the block.

An ommer block is a block that wasn't canonically added to the blockchain because it wasn't validated as fast as the canonical block but was mined at the same time.

To be considered valid, the ommers must adhere to the rules defined in the Ethereum protocol. The maximum amount of ommers is 2 per block and there cannot be duplicate ommers in a block. Many of the other ommer constraints are listed in the in-line comments of this function.

Parameters

ommers : List of ommers mentioned in the current block. block_header: The header of current block. chain : History and current state.

def validate_ommers(ommers: Tuple[Header, ...], ​​block_header: Header, ​​chain: BlockChain) -> None:
610
    """
611
    Validates the ommers mentioned in the block.
612
613
    An ommer block is a block that wasn't canonically added to the
614
    blockchain because it wasn't validated as fast as the canonical block
615
    but was mined at the same time.
616
617
    To be considered valid, the ommers must adhere to the rules defined in
618
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
619
    there cannot be duplicate ommers in a block. Many of the other ommer
620
    constraints are listed in the in-line comments of this function.
621
622
    Parameters
623
    ----------
624
    ommers :
625
        List of ommers mentioned in the current block.
626
    block_header:
627
        The header of current block.
628
    chain :
629
        History and current state.
630
631
    """
632
    block_hash = keccak256(rlp.encode(block_header))
633
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
634
        raise InvalidBlock
635
636
    if len(ommers) == 0:
637
        # Nothing to validate
638
        return
639
640
    # Check that each ommer satisfies the constraints of a header
641
    for ommer in ommers:
642
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
643
            raise InvalidBlock
644
        validate_header(chain, ommer)
645
    if len(ommers) > 2:
646
        raise InvalidBlock
647
648
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
649
    if len(ommers_hashes) != len(set(ommers_hashes)):
650
        raise InvalidBlock
651
652
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
653
    recent_canonical_block_hashes = {
654
        keccak256(rlp.encode(block.header))
655
        for block in recent_canonical_blocks
656
    }
657
    recent_ommers_hashes: Set[Hash32] = set()
658
    for block in recent_canonical_blocks:
659
        recent_ommers_hashes = recent_ommers_hashes.union(
660
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
661
        )
662
663
    for ommer_index, ommer in enumerate(ommers):
664
        ommer_hash = ommers_hashes[ommer_index]
665
        if ommer_hash == block_hash:
666
            raise InvalidBlock
667
        if ommer_hash in recent_canonical_block_hashes:
668
            raise InvalidBlock
669
        if ommer_hash in recent_ommers_hashes:
670
            raise InvalidBlock
671
672
        # Ommer age with respect to the current block. For example, an age of
673
        # 1 indicates that the ommer is a sibling of previous block.
674
        ommer_age = block_header.number - ommer.number
675
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
676
            raise InvalidBlock
677
        if ommer.parent_hash not in recent_canonical_block_hashes:
678
            raise InvalidBlock
679
        if ommer.parent_hash == block_header.parent_hash:
680
            raise InvalidBlock

pay_rewards

Pay rewards to the block miner as well as the ommers miners.

The miner of the canonical block is rewarded with the predetermined block reward, BLOCK_REWARD, plus a variable award based off of the number of ommer blocks that were mined around the same time, and included in the canonical block's header. An ommer block is a block that wasn't added to the canonical blockchain because it wasn't validated as fast as the accepted block but was mined at the same time. Although not all blocks that are mined are added to the canonical chain, miners are still paid a reward for their efforts. This reward is called an ommer reward and is calculated based on the number associated with the ommer block that they mined.

Parameters

block_env : The block scoped environment. ommers : List of ommers mentioned in the current block.

def pay_rewards(block_env: ethereum.forks.arrow_glacier.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
687
    """
688
    Pay rewards to the block miner as well as the ommers miners.
689
690
    The miner of the canonical block is rewarded with the predetermined
691
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
692
    number of ommer blocks that were mined around the same time, and included
693
    in the canonical block's header. An ommer block is a block that wasn't
694
    added to the canonical blockchain because it wasn't validated as fast as
695
    the accepted block but was mined at the same time. Although not all blocks
696
    that are mined are added to the canonical chain, miners are still paid a
697
    reward for their efforts. This reward is called an ommer reward and is
698
    calculated based on the number associated with the ommer block that they
699
    mined.
700
701
    Parameters
702
    ----------
703
    block_env :
704
        The block scoped environment.
705
    ommers :
706
        List of ommers mentioned in the current block.
707
708
    """
709
    rewards_state = TransactionState(parent=block_env.state)
710
    ommer_count = U256(len(ommers))
711
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
712
    create_ether(rewards_state, block_env.coinbase, miner_reward)
713
714
    for ommer in ommers:
715
        # Ommer age with respect to the current block.
716
        ommer_age = U256(block_env.number - ommer.number)
717
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
718
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
719
720
    incorporate_tx_into_block(rewards_state)

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.arrow_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.arrow_glacier.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
729
    """
730
    Execute a transaction against the provided environment.
731
732
    This function processes the actions needed to execute a transaction.
733
    It decrements the sender's account balance after calculating the gas fee
734
    and refunds them the proper amount after execution. Calling contracts,
735
    deploying code, and incrementing nonces are all examples of actions that
736
    happen within this function or from a call made within this function.
737
738
    Accounts that are marked for deletion are processed and destroyed after
739
    execution.
740
741
    Parameters
742
    ----------
743
    block_env :
744
        Environment for the Ethereum Virtual Machine.
745
    block_output :
746
        The block output for the current block.
747
    tx :
748
        Transaction to execute.
749
    index:
750
        Index of the transaction in the block.
751
752
    """
753
    tx_state = TransactionState(parent=block_env.state)
754
755
    trie_set(
756
        block_output.transactions_trie,
757
        rlp.encode(index),
758
        encode_transaction(tx),
759
    )
760
761
    intrinsic_gas = validate_transaction(tx)
762
763
    (
764
        sender,
765
        effective_gas_price,
766
    ) = check_transaction(
767
        block_env=block_env,
768
        block_output=block_output,
769
        tx=tx,
770
        tx_state=tx_state,
771
    )
772
773
    sender_account = get_account(tx_state, sender)
774
775
    effective_gas_fee = tx.gas * effective_gas_price
776
777
    gas = tx.gas - intrinsic_gas
778
    increment_nonce(tx_state, sender)
779
780
    sender_balance_after_gas_fee = (
781
        Uint(sender_account.balance) - effective_gas_fee
782
    )
783
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
784
785
    access_list_addresses = set()
786
    access_list_storage_keys = set()
787
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
788
        for access in tx.access_list:
789
            access_list_addresses.add(access.account)
790
            for slot in access.slots:
791
                access_list_storage_keys.add((access.account, slot))
792
793
    tx_env = vm.TransactionEnvironment(
794
        origin=sender,
795
        gas_price=effective_gas_price,
796
        gas=gas,
797
        access_list_addresses=access_list_addresses,
798
        access_list_storage_keys=access_list_storage_keys,
799
        state=tx_state,
800
        index_in_block=index,
801
        tx_hash=get_transaction_hash(encode_transaction(tx)),
802
    )
803
804
    message = prepare_message(block_env, tx_env, tx)
805
806
    tx_output = process_message_call(message)
807
808
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
809
    tx_gas_refund = min(
810
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
811
    )
812
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
813
    tx_gas_left = tx.gas - tx_gas_used_after_refund
814
    gas_refund_amount = tx_gas_left * effective_gas_price
815
816
    # For non-1559 transactions effective_gas_price == tx.gas_price
817
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
818
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
819
820
    # refund gas
821
    sender_balance_after_refund = get_account(tx_state, sender).balance + U256(
822
        gas_refund_amount
823
    )
824
    set_account_balance(tx_state, sender, sender_balance_after_refund)
825
826
    # transfer miner fees
827
    coinbase_balance_after_mining_fee = get_account(
828
        tx_state, block_env.coinbase
829
    ).balance + U256(transaction_fee)
830
    if coinbase_balance_after_mining_fee != 0:
831
        set_account_balance(
832
            tx_state,
833
            block_env.coinbase,
834
            coinbase_balance_after_mining_fee,
835
        )
836
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
837
        destroy_account(tx_state, block_env.coinbase)
838
839
    for address in tx_output.accounts_to_delete:
840
        destroy_account(tx_state, address)
841
842
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
843
844
    block_output.block_gas_used += tx_gas_used_after_refund
845
846
    receipt = make_receipt(
847
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
848
    )
849
850
    receipt_key = rlp.encode(Uint(index))
851
    block_output.receipt_keys += (receipt_key,)
852
853
    trie_set(
854
        block_output.receipts_trie,
855
        receipt_key,
856
        receipt,
857
    )
858
859
    block_output.block_logs += tx_output.logs
860
861
    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:
865
    """
866
    Validates the gas limit for a block.
867
868
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
869
    quotient of the parent block's gas limit and the
870
    ``LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
871
    passed through as a parameter is greater than or equal to the *sum* of
872
    the parent's gas and the adjustment delta then the limit for gas is too
873
    high and fails this function's check. Similarly, if the limit is less
874
    than or equal to the *difference* of the parent's gas and the adjustment
875
    delta *or* the predefined ``LIMIT_MINIMUM`` then this function's
876
    check fails because the gas limit doesn't allow for a sufficient or
877
    reasonable amount of gas to be used on a block.
878
879
    Parameters
880
    ----------
881
    gas_limit :
882
        Gas limit to validate.
883
884
    parent_gas_limit :
885
        Gas limit of the parent block.
886
887
    Returns
888
    -------
889
    check : `bool`
890
        True if gas limit constraints are satisfied, False otherwise.
891
892
    """
893
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
894
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
895
        return False
896
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
897
        return False
898
    if gas_limit < GasCosts.LIMIT_MINIMUM:
899
        return False
900
901
    return True

calculate_block_difficulty

Computes difficulty of a block using its header and parent header.

The difficulty is determined by the time the block was created after its parent. The offset is calculated using the parent block's difficulty, parent_difficulty, and the timestamp between blocks. This offset is then added to the parent difficulty and is stored as the difficulty variable. If the time between the block and its parent is too short, the offset will result in a positive number thus making the sum of parent_difficulty and offset to be a greater value in order to avoid mass forking. But, if the time is long enough, then the offset results in a negative value making the block less difficult than its parent.

The base standard for a block's difficulty is the predefined value set for the genesis block since it has no parent. So, a block can't be less difficult than the genesis block, therefore each block's difficulty is set to the maximum value between the calculated difficulty and the MINIMUM_DIFFICULTY.

Parameters

block_number : Block number of the block. block_timestamp : Timestamp of the block. parent_timestamp : Timestamp of the parent block. parent_difficulty : difficulty of the parent block. parent_has_ommers: does the parent have ommers.

Returns

difficulty : ethereum.base_types.Uint Computed difficulty for a block.

def calculate_block_difficulty(block_number: Uint, ​​block_timestamp: U256, ​​parent_timestamp: U256, ​​parent_difficulty: Uint, ​​parent_has_ommers: bool) -> Uint:
911
    """
912
    Computes difficulty of a block using its header and parent header.
913
914
    The difficulty is determined by the time the block was created after its
915
    parent. The ``offset`` is calculated using the parent block's difficulty,
916
    ``parent_difficulty``, and the timestamp between blocks. This offset is
917
    then added to the parent difficulty and is stored as the ``difficulty``
918
    variable. If the time between the block and its parent is too short, the
919
    offset will result in a positive number thus making the sum of
920
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
921
    avoid mass forking. But, if the time is long enough, then the offset
922
    results in a negative value making the block less difficult than
923
    its parent.
924
925
    The base standard for a block's difficulty is the predefined value
926
    set for the genesis block since it has no parent. So, a block
927
    can't be less difficult than the genesis block, therefore each block's
928
    difficulty is set to the maximum value between the calculated
929
    difficulty and the ``MINIMUM_DIFFICULTY``.
930
931
    Parameters
932
    ----------
933
    block_number :
934
        Block number of the block.
935
    block_timestamp :
936
        Timestamp of the block.
937
    parent_timestamp :
938
        Timestamp of the parent block.
939
    parent_difficulty :
940
        difficulty of the parent block.
941
    parent_has_ommers:
942
        does the parent have ommers.
943
944
    Returns
945
    -------
946
    difficulty : `ethereum.base_types.Uint`
947
        Computed difficulty for a block.
948
949
    """
950
    offset = (
951
        int(parent_difficulty)
952
        // 2048
953
        * max(
954
            (2 if parent_has_ommers else 1)
955
            - int(block_timestamp - parent_timestamp) // 9,
956
            -99,
957
        )
958
    )
959
    difficulty = int(parent_difficulty) + offset
960
    # Historical Note: The difficulty bomb was not present in Ethereum at the
961
    # start of Frontier, but was added shortly after launch. However since the
962
    # bomb has no effect prior to block 200000 we pretend it existed from
963
    # genesis.
964
    # See https://github.com/ethereum/go-ethereum/pull/1588
965
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
966
    if num_bomb_periods >= 0:
967
        difficulty += 2**num_bomb_periods
968
969
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
970
    # the bomb. This bug does not matter because the difficulty is always much
971
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
972
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))