ethereum.forks.gray_glacier.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

BASE_FEE_MAX_CHANGE_DENOMINATOR

68
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

69
ELASTICITY_MULTIPLIER = Uint(2)

GAS_LIMIT_ADJUSTMENT_FACTOR

70
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

71
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

72
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

73
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

74
BOMB_DELAY_BLOCKS = 11400000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

78
@dataclass
class BlockChain:

blocks

84
    blocks: List[Block]

state

85
    state: State

chain_id

86
    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:
90
    """
91
    Transforms the state from the previous hard fork (`old`) into the block
92
    chain object for this hard fork and returns it.
93
94
    When forks need to implement an irregular state transition, this function
95
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
96
    an example.
97
98
    Parameters
99
    ----------
100
    old :
101
        Previous block chain object.
102
103
    Returns
104
    -------
105
    new : `BlockChain`
106
        Upgraded block chain object for this hard fork.
107
108
    """
109
    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]:
113
    """
114
    Obtain the list of hashes of the previous 256 blocks in order of
115
    increasing block number.
116
117
    This function will return less hashes for the first 256 blocks.
118
119
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
120
    therefore this function retrieves them.
121
122
    Parameters
123
    ----------
124
    chain :
125
        History and current state.
126
127
    Returns
128
    -------
129
    recent_block_hashes : `List[Hash32]`
130
        Hashes of the recent 256 blocks in order of increasing block number.
131
132
    """
133
    recent_blocks = chain.blocks[-255:]
134
    # TODO: This function has not been tested rigorously
135
    if len(recent_blocks) == 0:
136
        return []
137
138
    recent_block_hashes = []
139
140
    for block in recent_blocks:
141
        prev_block_hash = block.header.parent_hash
142
        recent_block_hashes.append(prev_block_hash)
143
144
    # We are computing the hash only for the most recent block and not for
145
    # the rest of the blocks as they have successors which have the hash of
146
    # the current block as parent hash.
147
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
148
    recent_block_hashes.append(most_recent_block_hash)
149
150
    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:
154
    """
155
    Attempts to apply a block to an existing block chain.
156
157
    All parts of the block's contents need to be verified before being added
158
    to the chain. Blocks are verified by ensuring that the contents of the
159
    block make logical sense with the contents of the parent block. The
160
    information in the block's header must also match the corresponding
161
    information in the block.
162
163
    To implement Ethereum, in theory clients are only required to store the
164
    most recent 255 blocks of the chain since as far as execution is
165
    concerned, only those blocks are accessed. Practically, however, clients
166
    should store more blocks to handle reorgs.
167
168
    Parameters
169
    ----------
170
    chain :
171
        History and current state.
172
    block :
173
        Block to apply to `chain`.
174
175
    """
176
    validate_header(chain, block.header)
177
    validate_ommers(block.ommers, block.header, chain)
178
179
    block_env = vm.BlockEnvironment(
180
        chain_id=chain.chain_id,
181
        state=chain.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
        difficulty=block.header.difficulty,
189
    )
190
191
    block_output = apply_body(
192
        block_env=block_env,
193
        transactions=block.transactions,
194
        ommers=block.ommers,
195
    )
196
    block_state_root = state_root(block_env.state)
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
    chain.blocks.append(block)
215
    if len(chain.blocks) > 255:
216
        # Real clients have to store more blocks to deal with reorgs, but the
217
        # protocol only requires the last 255
218
        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:
227
    """
228
    Calculates the base fee per gas for the block.
229
230
    Parameters
231
    ----------
232
    block_gas_limit :
233
        Gas limit of the block for which the base fee is being calculated.
234
    parent_gas_limit :
235
        Gas limit of the parent block.
236
    parent_gas_used :
237
        Gas used in the parent block.
238
    parent_base_fee_per_gas :
239
        Base fee per gas of the parent block.
240
241
    Returns
242
    -------
243
    base_fee_per_gas : `Uint`
244
        Base fee per gas for the block.
245
246
    """
247
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
248
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
249
        raise InvalidBlock
250
251
    if parent_gas_used == parent_gas_target:
252
        expected_base_fee_per_gas = parent_base_fee_per_gas
253
    elif parent_gas_used > parent_gas_target:
254
        gas_used_delta = parent_gas_used - parent_gas_target
255
256
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
257
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
258
259
        base_fee_per_gas_delta = max(
260
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
261
            Uint(1),
262
        )
263
264
        expected_base_fee_per_gas = (
265
            parent_base_fee_per_gas + base_fee_per_gas_delta
266
        )
267
    else:
268
        gas_used_delta = parent_gas_target - parent_gas_used
269
270
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
271
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
272
273
        base_fee_per_gas_delta = (
274
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
275
        )
276
277
        expected_base_fee_per_gas = (
278
            parent_base_fee_per_gas - base_fee_per_gas_delta
279
        )
280
281
    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:
285
    """
286
    Verifies a block header.
287
288
    In order to consider a block's header valid, the logic for the
289
    quantities in the header should match the logic for the block itself.
290
    For example the header timestamp should be greater than the block's parent
291
    timestamp because the block was created *after* the parent block.
292
    Additionally, the block's number should be directly following the parent
293
    block's number since it is the next block in the sequence.
294
295
    Parameters
296
    ----------
297
    chain :
298
        History and current state.
299
    header :
300
        Header to check for correctness.
301
302
    """
303
    if header.number < Uint(1):
304
        raise InvalidBlock
305
    parent_header_number = header.number - Uint(1)
306
    first_block_number = chain.blocks[0].header.number
307
    last_block_number = chain.blocks[-1].header.number
308
309
    if (
310
        parent_header_number < first_block_number
311
        or parent_header_number > last_block_number
312
    ):
313
        raise InvalidBlock
314
315
    parent_header = chain.blocks[
316
        parent_header_number - first_block_number
317
    ].header
318
319
    if header.gas_used > header.gas_limit:
320
        raise InvalidBlock
321
322
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
323
        header.gas_limit,
324
        parent_header.gas_limit,
325
        parent_header.gas_used,
326
        parent_header.base_fee_per_gas,
327
    )
328
    if expected_base_fee_per_gas != header.base_fee_per_gas:
329
        raise InvalidBlock
330
331
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
332
    if header.timestamp <= parent_header.timestamp:
333
        raise InvalidBlock
334
    if header.number != parent_header.number + Uint(1):
335
        raise InvalidBlock
336
    if len(header.extra_data) > 32:
337
        raise InvalidBlock
338
339
    block_difficulty = calculate_block_difficulty(
340
        header.number,
341
        header.timestamp,
342
        parent_header.timestamp,
343
        parent_header.difficulty,
344
        parent_has_ommers,
345
    )
346
    if header.difficulty != block_difficulty:
347
        raise InvalidBlock
348
349
    block_parent_hash = keccak256(rlp.encode(parent_header))
350
    if header.parent_hash != block_parent_hash:
351
        raise InvalidBlock
352
353
    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:
357
    """
358
    Generate rlp hash of the header which is to be used for Proof-of-Work
359
    verification.
360
361
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
362
    while calculating this hash.
363
364
    A particular PoW is valid for a single hash, that hash is computed by
365
    this function. The `nonce` and `mix_digest` are omitted from this hash
366
    because they are being changed by miners in their search for a sufficient
367
    proof-of-work.
368
369
    Parameters
370
    ----------
371
    header :
372
        The header object for which the hash is to be generated.
373
374
    Returns
375
    -------
376
    hash : `Hash32`
377
        The PoW valid rlp hash of the passed in header.
378
379
    """
380
    header_data_without_pow_artefacts = (
381
        header.parent_hash,
382
        header.ommers_hash,
383
        header.coinbase,
384
        header.state_root,
385
        header.transactions_root,
386
        header.receipt_root,
387
        header.bloom,
388
        header.difficulty,
389
        header.number,
390
        header.gas_limit,
391
        header.gas_used,
392
        header.timestamp,
393
        header.extra_data,
394
        header.base_fee_per_gas,
395
    )
396
397
    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:
401
    """
402
    Validates the Proof of Work constraints.
403
404
    In order to verify that a miner's proof-of-work is valid for a block, a
405
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
406
    hash function. The mix digest is a hash of the header and the nonce that
407
    is passed through and it confirms whether or not proof-of-work was done
408
    on the correct block. The result is the actual hash value of the block.
409
410
    Parameters
411
    ----------
412
    header :
413
        Header of interest.
414
415
    """
416
    header_hash = generate_header_hash_for_pow(header)
417
    # TODO: Memoize this somewhere and read from that data instead of
418
    # calculating cache for every block validation.
419
    cache = generate_cache(header.number)
420
    mix_digest, result = hashimoto_light(
421
        header_hash, header.nonce, cache, dataset_size(header.number)
422
    )
423
    if mix_digest != header.mix_digest:
424
        raise InvalidBlock
425
426
    limit = Uint(U256.MAX_VALUE) + Uint(1)
427
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
428
        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. 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.gray_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.gray_glacier.vm.BlockOutput, ​​tx: Transaction) -> Tuple[Address, Uint]:
436
    """
437
    Check if the transaction is includable in the block.
438
439
    Parameters
440
    ----------
441
    block_env :
442
        The block scoped environment.
443
    block_output :
444
        The block output for the current block.
445
    tx :
446
        The transaction.
447
448
    Returns
449
    -------
450
    sender_address :
451
        The sender of the transaction.
452
    effective_gas_price :
453
        The price to charge for gas when the transaction is executed.
454
455
    Raises
456
    ------
457
    InvalidBlock :
458
        If the transaction is not includable.
459
    GasUsedExceedsLimitError :
460
        If the gas used by the transaction exceeds the block's gas limit.
461
    NonceMismatchError :
462
        If the nonce of the transaction is not equal to the sender's nonce.
463
    InsufficientBalanceError :
464
        If the sender's balance is not enough to pay for the transaction.
465
    InvalidSenderError :
466
        If the transaction is from an address that does not exist anymore.
467
    PriorityFeeGreaterThanMaxFeeError:
468
        If the priority fee is greater than the maximum fee per gas.
469
    InsufficientMaxFeePerGasError :
470
        If the maximum fee per gas is insufficient for the transaction.
471
472
    """
473
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
474
    if tx.gas > gas_available:
475
        raise GasUsedExceedsLimitError("gas used exceeds limit")
476
    sender_address = recover_sender(block_env.chain_id, tx)
477
    sender_account = get_account(block_env.state, sender_address)
478
479
    if isinstance(tx, FeeMarketTransaction):
480
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
481
            raise PriorityFeeGreaterThanMaxFeeError(
482
                "priority fee greater than max fee"
483
            )
484
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
485
            raise InsufficientMaxFeePerGasError(
486
                tx.max_fee_per_gas, block_env.base_fee_per_gas
487
            )
488
489
        priority_fee_per_gas = min(
490
            tx.max_priority_fee_per_gas,
491
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
492
        )
493
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
494
        max_gas_fee = tx.gas * tx.max_fee_per_gas
495
    else:
496
        if tx.gas_price < block_env.base_fee_per_gas:
497
            raise InvalidBlock
498
        effective_gas_price = tx.gas_price
499
        max_gas_fee = tx.gas * tx.gas_price
500
501
    if sender_account.nonce > Uint(tx.nonce):
502
        raise NonceMismatchError("nonce too low")
503
    elif sender_account.nonce < Uint(tx.nonce):
504
        raise NonceMismatchError("nonce too high")
505
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
506
        raise InsufficientBalanceError("insufficient sender balance")
507
    if sender_account.code_hash != EMPTY_CODE_HASH:
508
        raise InvalidSenderError("not EOA")
509
510
    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:
519
    """
520
    Make the receipt for a transaction that was executed.
521
522
    Parameters
523
    ----------
524
    tx :
525
        The executed transaction.
526
    error :
527
        Error in the top level frame of the transaction, if any.
528
    cumulative_gas_used :
529
        The total gas used so far in the block after the transaction was
530
        executed.
531
    logs :
532
        The logs produced by the transaction.
533
534
    Returns
535
    -------
536
    receipt :
537
        The receipt for the transaction.
538
539
    """
540
    receipt = Receipt(
541
        succeeded=error is None,
542
        cumulative_gas_used=cumulative_gas_used,
543
        bloom=logs_bloom(logs),
544
        logs=logs,
545
    )
546
547
    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.gray_glacier.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.gray_glacier.vm.BlockOutput:
555
    """
556
    Executes a block.
557
558
    Many of the contents of a block are stored in data structures called
559
    tries. There is a transactions trie which is similar to a ledger of the
560
    transactions stored in the current block. There is also a receipts trie
561
    which stores the results of executing a transaction, like the post state
562
    and gas used. This function creates and executes the block that is to be
563
    added to the chain.
564
565
    Parameters
566
    ----------
567
    block_env :
568
        The block scoped environment.
569
    transactions :
570
        Transactions included in the block.
571
    ommers :
572
        Headers of ancestor blocks which are not direct parents (formerly
573
        uncles.)
574
575
    Returns
576
    -------
577
    block_output :
578
        The block output for the current block.
579
580
    """
581
    block_output = vm.BlockOutput()
582
583
    for i, tx in enumerate(map(decode_transaction, transactions)):
584
        process_transaction(block_env, block_output, tx, Uint(i))
585
586
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
587
588
    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:
594
    """
595
    Validates the ommers mentioned in the block.
596
597
    An ommer block is a block that wasn't canonically added to the
598
    blockchain because it wasn't validated as fast as the canonical block
599
    but was mined at the same time.
600
601
    To be considered valid, the ommers must adhere to the rules defined in
602
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
603
    there cannot be duplicate ommers in a block. Many of the other ommer
604
    constraints are listed in the in-line comments of this function.
605
606
    Parameters
607
    ----------
608
    ommers :
609
        List of ommers mentioned in the current block.
610
    block_header:
611
        The header of current block.
612
    chain :
613
        History and current state.
614
615
    """
616
    block_hash = keccak256(rlp.encode(block_header))
617
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
618
        raise InvalidBlock
619
620
    if len(ommers) == 0:
621
        # Nothing to validate
622
        return
623
624
    # Check that each ommer satisfies the constraints of a header
625
    for ommer in ommers:
626
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
627
            raise InvalidBlock
628
        validate_header(chain, ommer)
629
    if len(ommers) > 2:
630
        raise InvalidBlock
631
632
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
633
    if len(ommers_hashes) != len(set(ommers_hashes)):
634
        raise InvalidBlock
635
636
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
637
    recent_canonical_block_hashes = {
638
        keccak256(rlp.encode(block.header))
639
        for block in recent_canonical_blocks
640
    }
641
    recent_ommers_hashes: Set[Hash32] = set()
642
    for block in recent_canonical_blocks:
643
        recent_ommers_hashes = recent_ommers_hashes.union(
644
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
645
        )
646
647
    for ommer_index, ommer in enumerate(ommers):
648
        ommer_hash = ommers_hashes[ommer_index]
649
        if ommer_hash == block_hash:
650
            raise InvalidBlock
651
        if ommer_hash in recent_canonical_block_hashes:
652
            raise InvalidBlock
653
        if ommer_hash in recent_ommers_hashes:
654
            raise InvalidBlock
655
656
        # Ommer age with respect to the current block. For example, an age of
657
        # 1 indicates that the ommer is a sibling of previous block.
658
        ommer_age = block_header.number - ommer.number
659
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
660
            raise InvalidBlock
661
        if ommer.parent_hash not in recent_canonical_block_hashes:
662
            raise InvalidBlock
663
        if ommer.parent_hash == block_header.parent_hash:
664
            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

state : Current account state. block_number : Position of the block within the chain. coinbase : Address of account which receives block reward and transaction fees. ommers : List of ommers mentioned in the current block.

def pay_rewards(state: State, ​​block_number: Uint, ​​coinbase: Address, ​​ommers: Tuple[Header, ...]) -> None:
673
    """
674
    Pay rewards to the block miner as well as the ommers miners.
675
676
    The miner of the canonical block is rewarded with the predetermined
677
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
678
    number of ommer blocks that were mined around the same time, and included
679
    in the canonical block's header. An ommer block is a block that wasn't
680
    added to the canonical blockchain because it wasn't validated as fast as
681
    the accepted block but was mined at the same time. Although not all blocks
682
    that are mined are added to the canonical chain, miners are still paid a
683
    reward for their efforts. This reward is called an ommer reward and is
684
    calculated based on the number associated with the ommer block that they
685
    mined.
686
687
    Parameters
688
    ----------
689
    state :
690
        Current account state.
691
    block_number :
692
        Position of the block within the chain.
693
    coinbase :
694
        Address of account which receives block reward and transaction fees.
695
    ommers :
696
        List of ommers mentioned in the current block.
697
698
    """
699
    ommer_count = U256(len(ommers))
700
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
701
    create_ether(state, coinbase, miner_reward)
702
703
    for ommer in ommers:
704
        # Ommer age with respect to the current block.
705
        ommer_age = U256(block_number - ommer.number)
706
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
707
        create_ether(state, ommer.coinbase, ommer_miner_reward)

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.gray_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.gray_glacier.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
716
    """
717
    Execute a transaction against the provided environment.
718
719
    This function processes the actions needed to execute a transaction.
720
    It decrements the sender's account balance after calculating the gas fee
721
    and refunds them the proper amount after execution. Calling contracts,
722
    deploying code, and incrementing nonces are all examples of actions that
723
    happen within this function or from a call made within this function.
724
725
    Accounts that are marked for deletion are processed and destroyed after
726
    execution.
727
728
    Parameters
729
    ----------
730
    block_env :
731
        Environment for the Ethereum Virtual Machine.
732
    block_output :
733
        The block output for the current block.
734
    tx :
735
        Transaction to execute.
736
    index:
737
        Index of the transaction in the block.
738
739
    """
740
    trie_set(
741
        block_output.transactions_trie,
742
        rlp.encode(index),
743
        encode_transaction(tx),
744
    )
745
746
    intrinsic_gas = validate_transaction(tx)
747
748
    (
749
        sender,
750
        effective_gas_price,
751
    ) = check_transaction(
752
        block_env=block_env,
753
        block_output=block_output,
754
        tx=tx,
755
    )
756
757
    sender_account = get_account(block_env.state, sender)
758
759
    effective_gas_fee = tx.gas * effective_gas_price
760
761
    gas = tx.gas - intrinsic_gas
762
    increment_nonce(block_env.state, sender)
763
764
    sender_balance_after_gas_fee = (
765
        Uint(sender_account.balance) - effective_gas_fee
766
    )
767
    set_account_balance(
768
        block_env.state, sender, U256(sender_balance_after_gas_fee)
769
    )
770
771
    access_list_addresses = set()
772
    access_list_storage_keys = set()
773
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
774
        for access in tx.access_list:
775
            access_list_addresses.add(access.account)
776
            for slot in access.slots:
777
                access_list_storage_keys.add((access.account, slot))
778
779
    tx_env = vm.TransactionEnvironment(
780
        origin=sender,
781
        gas_price=effective_gas_price,
782
        gas=gas,
783
        access_list_addresses=access_list_addresses,
784
        access_list_storage_keys=access_list_storage_keys,
785
        index_in_block=index,
786
        tx_hash=get_transaction_hash(encode_transaction(tx)),
787
    )
788
789
    message = prepare_message(block_env, tx_env, tx)
790
791
    tx_output = process_message_call(message)
792
793
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
794
    tx_gas_refund = min(
795
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
796
    )
797
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
798
    tx_gas_left = tx.gas - tx_gas_used_after_refund
799
    gas_refund_amount = tx_gas_left * effective_gas_price
800
801
    # For non-1559 transactions effective_gas_price == tx.gas_price
802
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
803
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
804
805
    # refund gas
806
    sender_balance_after_refund = get_account(
807
        block_env.state, sender
808
    ).balance + U256(gas_refund_amount)
809
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
810
811
    # transfer miner fees
812
    coinbase_balance_after_mining_fee = get_account(
813
        block_env.state, block_env.coinbase
814
    ).balance + U256(transaction_fee)
815
    if coinbase_balance_after_mining_fee != 0:
816
        set_account_balance(
817
            block_env.state,
818
            block_env.coinbase,
819
            coinbase_balance_after_mining_fee,
820
        )
821
    elif account_exists_and_is_empty(block_env.state, block_env.coinbase):
822
        destroy_account(block_env.state, block_env.coinbase)
823
824
    for address in tx_output.accounts_to_delete:
825
        destroy_account(block_env.state, address)
826
827
    destroy_touched_empty_accounts(block_env.state, tx_output.touched_accounts)
828
829
    block_output.block_gas_used += tx_gas_used_after_refund
830
831
    receipt = make_receipt(
832
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
833
    )
834
835
    receipt_key = rlp.encode(Uint(index))
836
    block_output.receipt_keys += (receipt_key,)
837
838
    trie_set(
839
        block_output.receipts_trie,
840
        receipt_key,
841
        receipt,
842
    )
843
844
    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:
848
    """
849
    Validates the gas limit for a block.
850
851
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
852
    quotient of the parent block's gas limit and the
853
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
854
    passed through as a parameter is greater than or equal to the *sum* of
855
    the parent's gas and the adjustment delta then the limit for gas is too
856
    high and fails this function's check. Similarly, if the limit is less
857
    than or equal to the *difference* of the parent's gas and the adjustment
858
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
859
    check fails because the gas limit doesn't allow for a sufficient or
860
    reasonable amount of gas to be used on a block.
861
862
    Parameters
863
    ----------
864
    gas_limit :
865
        Gas limit to validate.
866
867
    parent_gas_limit :
868
        Gas limit of the parent block.
869
870
    Returns
871
    -------
872
    check : `bool`
873
        True if gas limit constraints are satisfied, False otherwise.
874
875
    """
876
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
877
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
878
        return False
879
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
880
        return False
881
    if gas_limit < GAS_LIMIT_MINIMUM:
882
        return False
883
884
    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:
894
    """
895
    Computes difficulty of a block using its header and parent header.
896
897
    The difficulty is determined by the time the block was created after its
898
    parent. The ``offset`` is calculated using the parent block's difficulty,
899
    ``parent_difficulty``, and the timestamp between blocks. This offset is
900
    then added to the parent difficulty and is stored as the ``difficulty``
901
    variable. If the time between the block and its parent is too short, the
902
    offset will result in a positive number thus making the sum of
903
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
904
    avoid mass forking. But, if the time is long enough, then the offset
905
    results in a negative value making the block less difficult than
906
    its parent.
907
908
    The base standard for a block's difficulty is the predefined value
909
    set for the genesis block since it has no parent. So, a block
910
    can't be less difficult than the genesis block, therefore each block's
911
    difficulty is set to the maximum value between the calculated
912
    difficulty and the ``MINIMUM_DIFFICULTY``.
913
914
    Parameters
915
    ----------
916
    block_number :
917
        Block number of the block.
918
    block_timestamp :
919
        Timestamp of the block.
920
    parent_timestamp :
921
        Timestamp of the parent block.
922
    parent_difficulty :
923
        difficulty of the parent block.
924
    parent_has_ommers:
925
        does the parent have ommers.
926
927
    Returns
928
    -------
929
    difficulty : `ethereum.base_types.Uint`
930
        Computed difficulty for a block.
931
932
    """
933
    offset = (
934
        int(parent_difficulty)
935
        // 2048
936
        * max(
937
            (2 if parent_has_ommers else 1)
938
            - int(block_timestamp - parent_timestamp) // 9,
939
            -99,
940
        )
941
    )
942
    difficulty = int(parent_difficulty) + offset
943
    # Historical Note: The difficulty bomb was not present in Ethereum at the
944
    # start of Frontier, but was added shortly after launch. However since the
945
    # bomb has no effect prior to block 200000 we pretend it existed from
946
    # genesis.
947
    # See https://github.com/ethereum/go-ethereum/pull/1588
948
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
949
    if num_bomb_periods >= 0:
950
        difficulty += 2**num_bomb_periods
951
952
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
953
    # the bomb. This bug does not matter because the difficulty is always much
954
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
955
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))