ethereum.arrow_glacier.forkethereum.gray_glacier.fork

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

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

BASE_FEE_MAX_CHANGE_DENOMINATOR

61
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

62
ELASTICITY_MULTIPLIER = Uint(2)

GAS_LIMIT_ADJUSTMENT_FACTOR

63
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

64
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

65
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

66
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

67
BOMB_DELAY_BLOCKS = 10700000
67
BOMB_DELAY_BLOCKS = 11400000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

71
@dataclass
class BlockChain:

blocks

77
    blocks: List[Block]

state

78
    state: State

chain_id

79
    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:
83
    """
84
    Transforms the state from the previous hard fork (`old`) into the block
85
    chain object for this hard fork and returns it.
86
87
    When forks need to implement an irregular state transition, this function
88
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
89
    an example.
90
91
    Parameters
92
    ----------
93
    old :
94
        Previous block chain object.
95
96
    Returns
97
    -------
98
    new : `BlockChain`
99
        Upgraded block chain object for this hard fork.
100
    """
101
    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]:
105
    """
106
    Obtain the list of hashes of the previous 256 blocks in order of
107
    increasing block number.
108
109
    This function will return less hashes for the first 256 blocks.
110
111
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
112
    therefore this function retrieves them.
113
114
    Parameters
115
    ----------
116
    chain :
117
        History and current state.
118
119
    Returns
120
    -------
121
    recent_block_hashes : `List[Hash32]`
122
        Hashes of the recent 256 blocks in order of increasing block number.
123
    """
124
    recent_blocks = chain.blocks[-255:]
125
    # TODO: This function has not been tested rigorously
126
    if len(recent_blocks) == 0:
127
        return []
128
129
    recent_block_hashes = []
130
131
    for block in recent_blocks:
132
        prev_block_hash = block.header.parent_hash
133
        recent_block_hashes.append(prev_block_hash)
134
135
    # We are computing the hash only for the most recent block and not for
136
    # the rest of the blocks as they have successors which have the hash of
137
    # the current block as parent hash.
138
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
139
    recent_block_hashes.append(most_recent_block_hash)
140
141
    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:
145
    """
146
    Attempts to apply a block to an existing block chain.
147
148
    All parts of the block's contents need to be verified before being added
149
    to the chain. Blocks are verified by ensuring that the contents of the
150
    block make logical sense with the contents of the parent block. The
151
    information in the block's header must also match the corresponding
152
    information in the block.
153
154
    To implement Ethereum, in theory clients are only required to store the
155
    most recent 255 blocks of the chain since as far as execution is
156
    concerned, only those blocks are accessed. Practically, however, clients
157
    should store more blocks to handle reorgs.
158
159
    Parameters
160
    ----------
161
    chain :
162
        History and current state.
163
    block :
164
        Block to apply to `chain`.
165
    """
166
    validate_header(chain, block.header)
167
    validate_ommers(block.ommers, block.header, chain)
168
169
    block_env = vm.BlockEnvironment(
170
        chain_id=chain.chain_id,
171
        state=chain.state,
172
        block_gas_limit=block.header.gas_limit,
173
        block_hashes=get_last_256_block_hashes(chain),
174
        coinbase=block.header.coinbase,
175
        number=block.header.number,
176
        base_fee_per_gas=block.header.base_fee_per_gas,
177
        time=block.header.timestamp,
178
        difficulty=block.header.difficulty,
179
    )
180
181
    block_output = apply_body(
182
        block_env=block_env,
183
        transactions=block.transactions,
184
        ommers=block.ommers,
185
    )
186
    block_state_root = state_root(block_env.state)
187
    transactions_root = root(block_output.transactions_trie)
188
    receipt_root = root(block_output.receipts_trie)
189
    block_logs_bloom = logs_bloom(block_output.block_logs)
190
191
    if block_output.block_gas_used != block.header.gas_used:
192
        raise InvalidBlock(
193
            f"{block_output.block_gas_used} != {block.header.gas_used}"
194
        )
195
    if transactions_root != block.header.transactions_root:
196
        raise InvalidBlock
197
    if block_state_root != block.header.state_root:
198
        raise InvalidBlock
199
    if receipt_root != block.header.receipt_root:
200
        raise InvalidBlock
201
    if block_logs_bloom != block.header.bloom:
202
        raise InvalidBlock
203
204
    chain.blocks.append(block)
205
    if len(chain.blocks) > 255:
206
        # Real clients have to store more blocks to deal with reorgs, but the
207
        # protocol only requires the last 255
208
        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:
217
    """
218
    Calculates the base fee per gas for the block.
219
220
    Parameters
221
    ----------
222
    block_gas_limit :
223
        Gas limit of the block for which the base fee is being calculated.
224
    parent_gas_limit :
225
        Gas limit of the parent block.
226
    parent_gas_used :
227
        Gas used in the parent block.
228
    parent_base_fee_per_gas :
229
        Base fee per gas of the parent block.
230
231
    Returns
232
    -------
233
    base_fee_per_gas : `Uint`
234
        Base fee per gas for the block.
235
    """
236
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
237
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
238
        raise InvalidBlock
239
240
    if parent_gas_used == parent_gas_target:
241
        expected_base_fee_per_gas = parent_base_fee_per_gas
242
    elif parent_gas_used > parent_gas_target:
243
        gas_used_delta = parent_gas_used - parent_gas_target
244
245
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
246
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
247
248
        base_fee_per_gas_delta = max(
249
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
250
            Uint(1),
251
        )
252
253
        expected_base_fee_per_gas = (
254
            parent_base_fee_per_gas + base_fee_per_gas_delta
255
        )
256
    else:
257
        gas_used_delta = parent_gas_target - parent_gas_used
258
259
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
260
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
261
262
        base_fee_per_gas_delta = (
263
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
264
        )
265
266
        expected_base_fee_per_gas = (
267
            parent_base_fee_per_gas - base_fee_per_gas_delta
268
        )
269
270
    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:
274
    """
275
    Verifies a block header.
276
277
    In order to consider a block's header valid, the logic for the
278
    quantities in the header should match the logic for the block itself.
279
    For example the header timestamp should be greater than the block's parent
280
    timestamp because the block was created *after* the parent block.
281
    Additionally, the block's number should be directly following the parent
282
    block's number since it is the next block in the sequence.
283
284
    Parameters
285
    ----------
286
    chain :
287
        History and current state.
288
    header :
289
        Header to check for correctness.
290
    """
291
    if header.number < Uint(1):
292
        raise InvalidBlock
293
    parent_header_number = header.number - Uint(1)
294
    first_block_number = chain.blocks[0].header.number
295
    last_block_number = chain.blocks[-1].header.number
296
297
    if (
298
        parent_header_number < first_block_number
299
        or parent_header_number > last_block_number
300
    ):
301
        raise InvalidBlock
302
303
    parent_header = chain.blocks[
304
        parent_header_number - first_block_number
305
    ].header
306
307
    if header.gas_used > header.gas_limit:
308
        raise InvalidBlock
309
310
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
311
        header.gas_limit,
312
        parent_header.gas_limit,
313
        parent_header.gas_used,
314
        parent_header.base_fee_per_gas,
315
    )
316
    if expected_base_fee_per_gas != header.base_fee_per_gas:
317
        raise InvalidBlock
318
319
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
320
    if header.timestamp <= parent_header.timestamp:
321
        raise InvalidBlock
322
    if header.number != parent_header.number + Uint(1):
323
        raise InvalidBlock
324
    if len(header.extra_data) > 32:
325
        raise InvalidBlock
326
327
    block_difficulty = calculate_block_difficulty(
328
        header.number,
329
        header.timestamp,
330
        parent_header.timestamp,
331
        parent_header.difficulty,
332
        parent_has_ommers,
333
    )
334
    if header.difficulty != block_difficulty:
335
        raise InvalidBlock
336
337
    block_parent_hash = keccak256(rlp.encode(parent_header))
338
    if header.parent_hash != block_parent_hash:
339
        raise InvalidBlock
340
341
    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:
345
    """
346
    Generate rlp hash of the header which is to be used for Proof-of-Work
347
    verification.
348
349
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
350
    while calculating this hash.
351
352
    A particular PoW is valid for a single hash, that hash is computed by
353
    this function. The `nonce` and `mix_digest` are omitted from this hash
354
    because they are being changed by miners in their search for a sufficient
355
    proof-of-work.
356
357
    Parameters
358
    ----------
359
    header :
360
        The header object for which the hash is to be generated.
361
362
    Returns
363
    -------
364
    hash : `Hash32`
365
        The PoW valid rlp hash of the passed in header.
366
    """
367
    header_data_without_pow_artefacts = (
368
        header.parent_hash,
369
        header.ommers_hash,
370
        header.coinbase,
371
        header.state_root,
372
        header.transactions_root,
373
        header.receipt_root,
374
        header.bloom,
375
        header.difficulty,
376
        header.number,
377
        header.gas_limit,
378
        header.gas_used,
379
        header.timestamp,
380
        header.extra_data,
381
        header.base_fee_per_gas,
382
    )
383
384
    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:
388
    """
389
    Validates the Proof of Work constraints.
390
391
    In order to verify that a miner's proof-of-work is valid for a block, a
392
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
393
    hash function. The mix digest is a hash of the header and the nonce that
394
    is passed through and it confirms whether or not proof-of-work was done
395
    on the correct block. The result is the actual hash value of the block.
396
397
    Parameters
398
    ----------
399
    header :
400
        Header of interest.
401
    """
402
    header_hash = generate_header_hash_for_pow(header)
403
    # TODO: Memoize this somewhere and read from that data instead of
404
    # calculating cache for every block validation.
405
    cache = generate_cache(header.number)
406
    mix_digest, result = hashimoto_light(
407
        header_hash, header.nonce, cache, dataset_size(header.number)
408
    )
409
    if mix_digest != header.mix_digest:
410
        raise InvalidBlock
411
412
    limit = Uint(U256.MAX_VALUE) + Uint(1)
413
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
414
        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.arrow_glacier.vm.BlockEnvironmentethereum.gray_glacier.vm.BlockEnvironment, ​​block_output: ethereum.arrow_glacier.vm.BlockOutputethereum.gray_glacier.vm.BlockOutput, ​​tx: Transaction) -> Tuple[Address, Uint]:
422
    """
423
    Check if the transaction is includable in the block.
424
425
    Parameters
426
    ----------
427
    block_env :
428
        The block scoped environment.
429
    block_output :
430
        The block output for the current block.
431
    tx :
432
        The transaction.
433
434
    Returns
435
    -------
436
    sender_address :
437
        The sender of the transaction.
438
    effective_gas_price :
439
        The price to charge for gas when the transaction is executed.
440
441
    Raises
442
    ------
443
    InvalidBlock :
444
        If the transaction is not includable.
445
    """
446
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
447
    if tx.gas > gas_available:
448
        raise InvalidBlock
449
    sender_address = recover_sender(block_env.chain_id, tx)
450
    sender_account = get_account(block_env.state, sender_address)
451
452
    if isinstance(tx, FeeMarketTransaction):
453
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
454
            raise InvalidBlock
455
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
456
            raise InvalidBlock
457
458
        priority_fee_per_gas = min(
459
            tx.max_priority_fee_per_gas,
460
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
461
        )
462
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
463
        max_gas_fee = tx.gas * tx.max_fee_per_gas
464
    else:
465
        if tx.gas_price < block_env.base_fee_per_gas:
466
            raise InvalidBlock
467
        effective_gas_price = tx.gas_price
468
        max_gas_fee = tx.gas * tx.gas_price
469
470
    if sender_account.nonce != tx.nonce:
471
        raise InvalidBlock
472
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
473
        raise InvalidBlock
474
    if sender_account.code:
475
        raise InvalidSenderError("not EOA")
476
477
    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]:
486
    """
487
    Make the receipt for a transaction that was executed.
488
489
    Parameters
490
    ----------
491
    tx :
492
        The executed transaction.
493
    error :
494
        Error in the top level frame of the transaction, if any.
495
    cumulative_gas_used :
496
        The total gas used so far in the block after the transaction was
497
        executed.
498
    logs :
499
        The logs produced by the transaction.
500
501
    Returns
502
    -------
503
    receipt :
504
        The receipt for the transaction.
505
    """
506
    receipt = Receipt(
507
        succeeded=error is None,
508
        cumulative_gas_used=cumulative_gas_used,
509
        bloom=logs_bloom(logs),
510
        logs=logs,
511
    )
512
513
    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.arrow_glacier.vm.BlockEnvironmentethereum.gray_glacier.vm.BlockEnvironment, ​​transactions: Tuple[Union[LegacyTransaction, Bytes], ...], ​​ommers: Tuple[Header, ...]) -> ethereum.arrow_glacier.vm.BlockOutputethereum.gray_glacier.vm.BlockOutput:
521
    """
522
    Executes a block.
523
524
    Many of the contents of a block are stored in data structures called
525
    tries. There is a transactions trie which is similar to a ledger of the
526
    transactions stored in the current block. There is also a receipts trie
527
    which stores the results of executing a transaction, like the post state
528
    and gas used. This function creates and executes the block that is to be
529
    added to the chain.
530
531
    Parameters
532
    ----------
533
    block_env :
534
        The block scoped environment.
535
    transactions :
536
        Transactions included in the block.
537
    ommers :
538
        Headers of ancestor blocks which are not direct parents (formerly
539
        uncles.)
540
541
    Returns
542
    -------
543
    block_output :
544
        The block output for the current block.
545
    """
546
    block_output = vm.BlockOutput()
547
548
    for i, tx in enumerate(map(decode_transaction, transactions)):
549
        process_transaction(block_env, block_output, tx, Uint(i))
550
551
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
552
553
    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:
559
    """
560
    Validates the ommers mentioned in the block.
561
562
    An ommer block is a block that wasn't canonically added to the
563
    blockchain because it wasn't validated as fast as the canonical block
564
    but was mined at the same time.
565
566
    To be considered valid, the ommers must adhere to the rules defined in
567
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
568
    there cannot be duplicate ommers in a block. Many of the other ommer
569
    constraints are listed in the in-line comments of this function.
570
571
    Parameters
572
    ----------
573
    ommers :
574
        List of ommers mentioned in the current block.
575
    block_header:
576
        The header of current block.
577
    chain :
578
        History and current state.
579
    """
580
    block_hash = keccak256(rlp.encode(block_header))
581
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
582
        raise InvalidBlock
583
584
    if len(ommers) == 0:
585
        # Nothing to validate
586
        return
587
588
    # Check that each ommer satisfies the constraints of a header
589
    for ommer in ommers:
590
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
591
            raise InvalidBlock
592
        validate_header(chain, ommer)
593
    if len(ommers) > 2:
594
        raise InvalidBlock
595
596
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
597
    if len(ommers_hashes) != len(set(ommers_hashes)):
598
        raise InvalidBlock
599
600
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
601
    recent_canonical_block_hashes = {
602
        keccak256(rlp.encode(block.header))
603
        for block in recent_canonical_blocks
604
    }
605
    recent_ommers_hashes: Set[Hash32] = set()
606
    for block in recent_canonical_blocks:
607
        recent_ommers_hashes = recent_ommers_hashes.union(
608
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
609
        )
610
611
    for ommer_index, ommer in enumerate(ommers):
612
        ommer_hash = ommers_hashes[ommer_index]
613
        if ommer_hash == block_hash:
614
            raise InvalidBlock
615
        if ommer_hash in recent_canonical_block_hashes:
616
            raise InvalidBlock
617
        if ommer_hash in recent_ommers_hashes:
618
            raise InvalidBlock
619
620
        # Ommer age with respect to the current block. For example, an age of
621
        # 1 indicates that the ommer is a sibling of previous block.
622
        ommer_age = block_header.number - ommer.number
623
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
624
            raise InvalidBlock
625
        if ommer.parent_hash not in recent_canonical_block_hashes:
626
            raise InvalidBlock
627
        if ommer.parent_hash == block_header.parent_hash:
628
            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:
637
    """
638
    Pay rewards to the block miner as well as the ommers miners.
639
640
    The miner of the canonical block is rewarded with the predetermined
641
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
642
    number of ommer blocks that were mined around the same time, and included
643
    in the canonical block's header. An ommer block is a block that wasn't
644
    added to the canonical blockchain because it wasn't validated as fast as
645
    the accepted block but was mined at the same time. Although not all blocks
646
    that are mined are added to the canonical chain, miners are still paid a
647
    reward for their efforts. This reward is called an ommer reward and is
648
    calculated based on the number associated with the ommer block that they
649
    mined.
650
651
    Parameters
652
    ----------
653
    state :
654
        Current account state.
655
    block_number :
656
        Position of the block within the chain.
657
    coinbase :
658
        Address of account which receives block reward and transaction fees.
659
    ommers :
660
        List of ommers mentioned in the current block.
661
    """
662
    ommer_count = U256(len(ommers))
663
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
664
    create_ether(state, coinbase, miner_reward)
665
666
    for ommer in ommers:
667
        # Ommer age with respect to the current block.
668
        ommer_age = U256(block_number - ommer.number)
669
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
670
        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 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.arrow_glacier.vm.BlockEnvironmentethereum.gray_glacier.vm.BlockEnvironment, ​​block_output: ethereum.arrow_glacier.vm.BlockOutputethereum.gray_glacier.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
679
    """
680
    Execute a transaction against the provided environment.
681
682
    This function processes the actions needed to execute a transaction.
683
    It decrements the sender's account after calculating the gas fee and
684
    refunds them the proper amount after execution. Calling contracts,
685
    deploying code, and incrementing nonces are all examples of actions that
686
    happen within this function or from a call made within this function.
687
688
    Accounts that are marked for deletion are processed and destroyed after
689
    execution.
690
691
    Parameters
692
    ----------
693
    block_env :
694
        Environment for the Ethereum Virtual Machine.
695
    block_output :
696
        The block output for the current block.
697
    tx :
698
        Transaction to execute.
699
    index:
700
        Index of the transaction in the block.
701
    """
702
    trie_set(
703
        block_output.transactions_trie,
704
        rlp.encode(index),
705
        encode_transaction(tx),
706
    )
707
708
    intrinsic_gas = validate_transaction(tx)
709
710
    (
711
        sender,
712
        effective_gas_price,
713
    ) = check_transaction(
714
        block_env=block_env,
715
        block_output=block_output,
716
        tx=tx,
717
    )
718
719
    sender_account = get_account(block_env.state, sender)
720
721
    effective_gas_fee = tx.gas * effective_gas_price
722
723
    gas = tx.gas - intrinsic_gas
724
    increment_nonce(block_env.state, sender)
725
726
    sender_balance_after_gas_fee = (
727
        Uint(sender_account.balance) - effective_gas_fee
728
    )
729
    set_account_balance(
730
        block_env.state, sender, U256(sender_balance_after_gas_fee)
731
    )
732
733
    access_list_addresses = set()
734
    access_list_storage_keys = set()
735
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
736
        for access in tx.access_list:
737
            access_list_addresses.add(access.account)
738
            for slot in access.slots:
739
                access_list_storage_keys.add((access.account, slot))
740
741
    tx_env = vm.TransactionEnvironment(
742
        origin=sender,
743
        gas_price=effective_gas_price,
744
        gas=gas,
745
        access_list_addresses=access_list_addresses,
746
        access_list_storage_keys=access_list_storage_keys,
747
        index_in_block=index,
748
        tx_hash=get_transaction_hash(encode_transaction(tx)),
749
        traces=[],
750
    )
751
752
    message = prepare_message(block_env, tx_env, tx)
753
754
    tx_output = process_message_call(message)
755
756
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
757
    tx_gas_refund = min(
758
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
759
    )
760
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
761
    tx_gas_left = tx.gas - tx_gas_used_after_refund
762
    gas_refund_amount = tx_gas_left * effective_gas_price
763
764
    # For non-1559 transactions effective_gas_price == tx.gas_price
765
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
766
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
767
768
    # refund gas
769
    sender_balance_after_refund = get_account(
770
        block_env.state, sender
771
    ).balance + U256(gas_refund_amount)
772
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
773
774
    # transfer miner fees
775
    coinbase_balance_after_mining_fee = get_account(
776
        block_env.state, block_env.coinbase
777
    ).balance + U256(transaction_fee)
778
    if coinbase_balance_after_mining_fee != 0:
779
        set_account_balance(
780
            block_env.state,
781
            block_env.coinbase,
782
            coinbase_balance_after_mining_fee,
783
        )
784
    elif account_exists_and_is_empty(block_env.state, block_env.coinbase):
785
        destroy_account(block_env.state, block_env.coinbase)
786
787
    for address in tx_output.accounts_to_delete:
788
        destroy_account(block_env.state, address)
789
790
    destroy_touched_empty_accounts(block_env.state, tx_output.touched_accounts)
791
792
    block_output.block_gas_used += tx_gas_used_after_refund
793
794
    receipt = make_receipt(
795
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
796
    )
797
798
    receipt_key = rlp.encode(Uint(index))
799
    block_output.receipt_keys += (receipt_key,)
800
801
    trie_set(
802
        block_output.receipts_trie,
803
        receipt_key,
804
        receipt,
805
    )
806
807
    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:
811
    """
812
    Validates the gas limit for a block.
813
814
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
815
    quotient of the parent block's gas limit and the
816
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
817
    passed through as a parameter is greater than or equal to the *sum* of
818
    the parent's gas and the adjustment delta then the limit for gas is too
819
    high and fails this function's check. Similarly, if the limit is less
820
    than or equal to the *difference* of the parent's gas and the adjustment
821
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
822
    check fails because the gas limit doesn't allow for a sufficient or
823
    reasonable amount of gas to be used on a block.
824
825
    Parameters
826
    ----------
827
    gas_limit :
828
        Gas limit to validate.
829
830
    parent_gas_limit :
831
        Gas limit of the parent block.
832
833
    Returns
834
    -------
835
    check : `bool`
836
        True if gas limit constraints are satisfied, False otherwise.
837
    """
838
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
839
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
840
        return False
841
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
842
        return False
843
    if gas_limit < GAS_LIMIT_MINIMUM:
844
        return False
845
846
    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 GENESIS_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:
856
    """
857
    Computes difficulty of a block using its header and parent header.
858
859
    The difficulty is determined by the time the block was created after its
860
    parent. The ``offset`` is calculated using the parent block's difficulty,
861
    ``parent_difficulty``, and the timestamp between blocks. This offset is
862
    then added to the parent difficulty and is stored as the ``difficulty``
863
    variable. If the time between the block and its parent is too short, the
864
    offset will result in a positive number thus making the sum of
865
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
866
    avoid mass forking. But, if the time is long enough, then the offset
867
    results in a negative value making the block less difficult than
868
    its parent.
869
870
    The base standard for a block's difficulty is the predefined value
871
    set for the genesis block since it has no parent. So, a block
872
    can't be less difficult than the genesis block, therefore each block's
873
    difficulty is set to the maximum value between the calculated
874
    difficulty and the ``GENESIS_DIFFICULTY``.
875
876
    Parameters
877
    ----------
878
    block_number :
879
        Block number of the block.
880
    block_timestamp :
881
        Timestamp of the block.
882
    parent_timestamp :
883
        Timestamp of the parent block.
884
    parent_difficulty :
885
        difficulty of the parent block.
886
    parent_has_ommers:
887
        does the parent have ommers.
888
889
    Returns
890
    -------
891
    difficulty : `ethereum.base_types.Uint`
892
        Computed difficulty for a block.
893
    """
894
    offset = (
895
        int(parent_difficulty)
896
        // 2048
897
        * max(
898
            (2 if parent_has_ommers else 1)
899
            - int(block_timestamp - parent_timestamp) // 9,
900
            -99,
901
        )
902
    )
903
    difficulty = int(parent_difficulty) + offset
904
    # Historical Note: The difficulty bomb was not present in Ethereum at the
905
    # start of Frontier, but was added shortly after launch. However since the
906
    # bomb has no effect prior to block 200000 we pretend it existed from
907
    # genesis.
908
    # See https://github.com/ethereum/go-ethereum/pull/1588
909
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
910
    if num_bomb_periods >= 0:
911
        difficulty += 2**num_bomb_periods
912
913
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
914
    # the bomb. This bug does not matter because the difficulty is always much
915
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
916
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))