ethereum.muir_glacier.forkethereum.berlin.fork

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

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

GAS_LIMIT_ADJUSTMENT_FACTOR

59
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

60
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

61
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

62
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

63
BOMB_DELAY_BLOCKS = 9000000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

67
@dataclass
class BlockChain:

blocks

73
    blocks: List[Block]

state

74
    state: State

chain_id

75
    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:
79
    """
80
    Transforms the state from the previous hard fork (`old`) into the block
81
    chain object for this hard fork and returns it.
82
83
    When forks need to implement an irregular state transition, this function
84
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
85
    an example.
86
87
    Parameters
88
    ----------
89
    old :
90
        Previous block chain object.
91
92
    Returns
93
    -------
94
    new : `BlockChain`
95
        Upgraded block chain object for this hard fork.
96
    """
97
    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]:
101
    """
102
    Obtain the list of hashes of the previous 256 blocks in order of
103
    increasing block number.
104
105
    This function will return less hashes for the first 256 blocks.
106
107
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
108
    therefore this function retrieves them.
109
110
    Parameters
111
    ----------
112
    chain :
113
        History and current state.
114
115
    Returns
116
    -------
117
    recent_block_hashes : `List[Hash32]`
118
        Hashes of the recent 256 blocks in order of increasing block number.
119
    """
120
    recent_blocks = chain.blocks[-255:]
121
    # TODO: This function has not been tested rigorously
122
    if len(recent_blocks) == 0:
123
        return []
124
125
    recent_block_hashes = []
126
127
    for block in recent_blocks:
128
        prev_block_hash = block.header.parent_hash
129
        recent_block_hashes.append(prev_block_hash)
130
131
    # We are computing the hash only for the most recent block and not for
132
    # the rest of the blocks as they have successors which have the hash of
133
    # the current block as parent hash.
134
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
135
    recent_block_hashes.append(most_recent_block_hash)
136
137
    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:
141
    """
142
    Attempts to apply a block to an existing block chain.
143
144
    All parts of the block's contents need to be verified before being added
145
    to the chain. Blocks are verified by ensuring that the contents of the
146
    block make logical sense with the contents of the parent block. The
147
    information in the block's header must also match the corresponding
148
    information in the block.
149
150
    To implement Ethereum, in theory clients are only required to store the
151
    most recent 255 blocks of the chain since as far as execution is
152
    concerned, only those blocks are accessed. Practically, however, clients
153
    should store more blocks to handle reorgs.
154
155
    Parameters
156
    ----------
157
    chain :
158
        History and current state.
159
    block :
160
        Block to apply to `chain`.
161
    """
162
    parent_header = chain.blocks[-1].header
163
    validate_header(block.header, parent_header)
164
    validate_ommers(block.ommers, block.header, chain)
165
    apply_body_output = apply_body(
166
        chain.state,
167
        get_last_256_block_hashes(chain),
168
        block.header.coinbase,
169
        block.header.number,
170
        block.header.gas_limit,
171
        block.header.timestamp,
172
        block.header.difficulty,
173
        block.transactions,
174
        block.ommers,
175
        chain.chain_id,
176
    )
177
    if apply_body_output.block_gas_used != block.header.gas_used:
178
        raise InvalidBlock(
179
            f"{apply_body_output.block_gas_used} != {block.header.gas_used}"
180
        )
181
    if apply_body_output.transactions_root != block.header.transactions_root:
182
        raise InvalidBlock
183
    if apply_body_output.state_root != block.header.state_root:
184
        raise InvalidBlock
185
    if apply_body_output.receipt_root != block.header.receipt_root:
186
        raise InvalidBlock
187
    if apply_body_output.block_logs_bloom != block.header.bloom:
188
        raise InvalidBlock
189
190
    chain.blocks.append(block)
191
    if len(chain.blocks) > 255:
192
        # Real clients have to store more blocks to deal with reorgs, but the
193
        # protocol only requires the last 255
194
        chain.blocks = chain.blocks[-255:]

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

header : Header to check for correctness. parent_header : Parent Header of the header to check for correctness

def validate_header(header: Header, ​​parent_header: Header) -> None:
198
    """
199
    Verifies a block header.
200
201
    In order to consider a block's header valid, the logic for the
202
    quantities in the header should match the logic for the block itself.
203
    For example the header timestamp should be greater than the block's parent
204
    timestamp because the block was created *after* the parent block.
205
    Additionally, the block's number should be directly following the parent
206
    block's number since it is the next block in the sequence.
207
208
    Parameters
209
    ----------
210
    header :
211
        Header to check for correctness.
212
    parent_header :
213
        Parent Header of the header to check for correctness
214
    """
215
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
216
    if header.timestamp <= parent_header.timestamp:
217
        raise InvalidBlock
218
    if header.number != parent_header.number + Uint(1):
219
        raise InvalidBlock
220
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
221
        raise InvalidBlock
222
    if len(header.extra_data) > 32:
223
        raise InvalidBlock
224
225
    block_difficulty = calculate_block_difficulty(
226
        header.number,
227
        header.timestamp,
228
        parent_header.timestamp,
229
        parent_header.difficulty,
230
        parent_has_ommers,
231
    )
232
    if header.difficulty != block_difficulty:
233
        raise InvalidBlock
234
235
    block_parent_hash = keccak256(rlp.encode(parent_header))
236
    if header.parent_hash != block_parent_hash:
237
        raise InvalidBlock
238
239
    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:
243
    """
244
    Generate rlp hash of the header which is to be used for Proof-of-Work
245
    verification.
246
247
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
248
    while calculating this hash.
249
250
    A particular PoW is valid for a single hash, that hash is computed by
251
    this function. The `nonce` and `mix_digest` are omitted from this hash
252
    because they are being changed by miners in their search for a sufficient
253
    proof-of-work.
254
255
    Parameters
256
    ----------
257
    header :
258
        The header object for which the hash is to be generated.
259
260
    Returns
261
    -------
262
    hash : `Hash32`
263
        The PoW valid rlp hash of the passed in header.
264
    """
265
    header_data_without_pow_artefacts = (
266
        header.parent_hash,
267
        header.ommers_hash,
268
        header.coinbase,
269
        header.state_root,
270
        header.transactions_root,
271
        header.receipt_root,
272
        header.bloom,
273
        header.difficulty,
274
        header.number,
275
        header.gas_limit,
276
        header.gas_used,
277
        header.timestamp,
278
        header.extra_data,
279
    )
280
281
    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:
285
    """
286
    Validates the Proof of Work constraints.
287
288
    In order to verify that a miner's proof-of-work is valid for a block, a
289
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
290
    hash function. The mix digest is a hash of the header and the nonce that
291
    is passed through and it confirms whether or not proof-of-work was done
292
    on the correct block. The result is the actual hash value of the block.
293
294
    Parameters
295
    ----------
296
    header :
297
        Header of interest.
298
    """
299
    header_hash = generate_header_hash_for_pow(header)
300
    # TODO: Memoize this somewhere and read from that data instead of
301
    # calculating cache for every block validation.
302
    cache = generate_cache(header.number)
303
    mix_digest, result = hashimoto_light(
304
        header_hash, header.nonce, cache, dataset_size(header.number)
305
    )
306
    if mix_digest != header.mix_digest:
307
        raise InvalidBlock
308
309
    limit = Uint(U256.MAX_VALUE) + Uint(1)
310
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
311
        raise InvalidBlock

check_transaction

Check if the transaction is includable in the block.

Parameters

tx : The transaction. gas_available : The gas remaining in the block. chain_id : The ID of the current chain.

Returns

sender_address : The sender of the transaction.

Raises

InvalidBlock : If the transaction is not includable.

def check_transaction(tx: Transaction, ​​gas_available: Uint, ​​chain_id: U64) -> Address:
319
    """
320
    Check if the transaction is includable in the block.
321
322
    Parameters
323
    ----------
324
    tx :
325
        The transaction.
326
    gas_available :
327
        The gas remaining in the block.
328
    chain_id :
329
        The ID of the current chain.
330
331
    Returns
332
    -------
333
    sender_address :
334
        The sender of the transaction.
335
336
    Raises
337
    ------
338
    InvalidBlock :
339
        If the transaction is not includable.
340
    """
341
    if tx.gas > gas_available:
342
        raise InvalidBlock
343
    sender_address = recover_sender(chain_id, tx)
344
345
    return sender_address

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, ...]) -> ReceiptUnion[Bytes, Receipt]:
354
    """
355
    Make the receipt for a transaction that was executed.
356
357
    Parameters
358
    ----------
359
    tx :
360
        The executed transaction.
361
    error :
362
        Error in the top level frame of the transaction, if any.
363
    cumulative_gas_used :
364
        The total gas used so far in the block after the transaction was
365
        executed.
366
    logs :
367
        The logs produced by the transaction.
368
369
    Returns
370
    -------
371
    receipt :
372
        The receipt for the transaction.
373
    """
374
    receipt = Receipt(
375
        succeeded=error is None,
376
        cumulative_gas_used=cumulative_gas_used,
377
        bloom=logs_bloom(logs),
378
        logs=logs,
379
    )
380
377
    return receipt
381
    if isinstance(tx, AccessListTransaction):
382
        return b"\x01" + rlp.encode(receipt)
383
    else:
384
        return receipt

ApplyBodyOutput

Output from applying the block body to the present state.

Contains the following:

block_gas_used : ethereum.base_types.Uint Gas used for executing all transactions. transactions_root : ethereum.fork_types.Root Trie root of all the transactions in the block. receipt_root : ethereum.fork_types.Root Trie root of all the receipts in the block. block_logs_bloom : Bloom Logs bloom of all the logs included in all the transactions of the block. state_root : ethereum.fork_types.Root State root after all transactions have been executed.

387
@dataclass
class ApplyBodyOutput:

block_gas_used

407
    block_gas_used: Uint

transactions_root

408
    transactions_root: Root

receipt_root

409
    receipt_root: Root

block_logs_bloom

410
    block_logs_bloom: Bloom

state_root

411
    state_root: Root

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

state : Current account state. block_hashes : List of hashes of the previous 256 blocks in the order of increasing block number. coinbase : Address of account which receives block reward and transaction fees. block_number : Position of the block within the chain. block_gas_limit : Initial amount of gas available for execution in this block. block_time : Time the block was produced, measured in seconds since the epoch. block_difficulty : Difficulty of the block. transactions : Transactions included in the block. ommers : Headers of ancestor blocks which are not direct parents (formerly uncles.) chain_id : ID of the executing chain.

Returns

apply_body_output : ApplyBodyOutput Output of applying the block body to the state.

def apply_body(state: State, ​​block_hashes: List[Hash32], ​​coinbase: Address, ​​block_number: Uint, ​​block_gas_limit: Uint, ​​block_time: U256, ​​block_difficulty: Uint, ​​transactions: Tuple[TransactionUnion[LegacyTransaction, Bytes], ...], ​​ommers: Tuple[Header, ...], ​​chain_id: U64) -> ApplyBodyOutput:
426
    """
427
    Executes a block.
428
429
    Many of the contents of a block are stored in data structures called
430
    tries. There is a transactions trie which is similar to a ledger of the
431
    transactions stored in the current block. There is also a receipts trie
432
    which stores the results of executing a transaction, like the post state
433
    and gas used. This function creates and executes the block that is to be
434
    added to the chain.
435
436
    Parameters
437
    ----------
438
    state :
439
        Current account state.
440
    block_hashes :
441
        List of hashes of the previous 256 blocks in the order of
442
        increasing block number.
443
    coinbase :
444
        Address of account which receives block reward and transaction fees.
445
    block_number :
446
        Position of the block within the chain.
447
    block_gas_limit :
448
        Initial amount of gas available for execution in this block.
449
    block_time :
450
        Time the block was produced, measured in seconds since the epoch.
451
    block_difficulty :
452
        Difficulty of the block.
453
    transactions :
454
        Transactions included in the block.
455
    ommers :
456
        Headers of ancestor blocks which are not direct parents (formerly
457
        uncles.)
458
    chain_id :
459
        ID of the executing chain.
460
461
    Returns
462
    -------
463
    apply_body_output : `ApplyBodyOutput`
464
        Output of applying the block body to the state.
465
    """
466
    gas_available = block_gas_limit
460
    transactions_trie: Trie[Bytes, Optional[Transaction]] = Trie(
461
        secured=False, default=None
462
    )
463
    receipts_trie: Trie[Bytes, Optional[Receipt]] = Trie(
467
    transactions_trie: Trie[
468
        Bytes, Optional[Union[Bytes, LegacyTransaction]]
469
    ] = Trie(secured=False, default=None)
470
    receipts_trie: Trie[Bytes, Optional[Union[Bytes, Receipt]]] = Trie(
471
        secured=False, default=None
472
    )
473
    block_logs: Tuple[Log, ...] = ()
474
468
    for i, tx in enumerate(transactions):
469
        trie_set(transactions_trie, rlp.encode(Uint(i)), tx)
475
    for i, tx in enumerate(map(decode_transaction, transactions)):
476
        trie_set(
477
            transactions_trie, rlp.encode(Uint(i)), encode_transaction(tx)
478
        )
479
480
        sender_address = check_transaction(tx, gas_available, chain_id)
481
482
        env = vm.Environment(
483
            caller=sender_address,
484
            origin=sender_address,
485
            block_hashes=block_hashes,
486
            coinbase=coinbase,
487
            number=block_number,
488
            gas_limit=block_gas_limit,
489
            gas_price=tx.gas_price,
490
            time=block_time,
491
            difficulty=block_difficulty,
492
            state=state,
493
            chain_id=chain_id,
494
            traces=[],
495
        )
496
497
        gas_used, logs, error = process_transaction(env, tx)
498
        gas_available -= gas_used
499
500
        receipt = make_receipt(
501
            tx, error, (block_gas_limit - gas_available), logs
502
        )
503
504
        trie_set(
505
            receipts_trie,
506
            rlp.encode(Uint(i)),
507
            receipt,
508
        )
509
510
        block_logs += logs
511
512
    pay_rewards(state, block_number, coinbase, ommers)
513
514
    block_gas_used = block_gas_limit - gas_available
515
516
    block_logs_bloom = logs_bloom(block_logs)
517
518
    return ApplyBodyOutput(
519
        block_gas_used,
520
        root(transactions_trie),
521
        root(receipts_trie),
522
        block_logs_bloom,
523
        state_root(state),
524
    )

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:
530
    """
531
    Validates the ommers mentioned in the block.
532
533
    An ommer block is a block that wasn't canonically added to the
534
    blockchain because it wasn't validated as fast as the canonical block
535
    but was mined at the same time.
536
537
    To be considered valid, the ommers must adhere to the rules defined in
538
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
539
    there cannot be duplicate ommers in a block. Many of the other ommer
540
    constraints are listed in the in-line comments of this function.
541
542
    Parameters
543
    ----------
544
    ommers :
545
        List of ommers mentioned in the current block.
546
    block_header:
547
        The header of current block.
548
    chain :
549
        History and current state.
550
    """
551
    block_hash = keccak256(rlp.encode(block_header))
552
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
553
        raise InvalidBlock
554
555
    if len(ommers) == 0:
556
        # Nothing to validate
557
        return
558
559
    # Check that each ommer satisfies the constraints of a header
560
    for ommer in ommers:
561
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
562
            raise InvalidBlock
563
        ommer_parent_header = chain.blocks[
564
            -(block_header.number - ommer.number) - 1
565
        ].header
566
        validate_header(ommer, ommer_parent_header)
567
    if len(ommers) > 2:
568
        raise InvalidBlock
569
570
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
571
    if len(ommers_hashes) != len(set(ommers_hashes)):
572
        raise InvalidBlock
573
574
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
575
    recent_canonical_block_hashes = {
576
        keccak256(rlp.encode(block.header))
577
        for block in recent_canonical_blocks
578
    }
579
    recent_ommers_hashes: Set[Hash32] = set()
580
    for block in recent_canonical_blocks:
581
        recent_ommers_hashes = recent_ommers_hashes.union(
582
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
583
        )
584
585
    for ommer_index, ommer in enumerate(ommers):
586
        ommer_hash = ommers_hashes[ommer_index]
587
        if ommer_hash == block_hash:
588
            raise InvalidBlock
589
        if ommer_hash in recent_canonical_block_hashes:
590
            raise InvalidBlock
591
        if ommer_hash in recent_ommers_hashes:
592
            raise InvalidBlock
593
594
        # Ommer age with respect to the current block. For example, an age of
595
        # 1 indicates that the ommer is a sibling of previous block.
596
        ommer_age = block_header.number - ommer.number
597
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
598
            raise InvalidBlock
599
        if ommer.parent_hash not in recent_canonical_block_hashes:
600
            raise InvalidBlock
601
        if ommer.parent_hash == block_header.parent_hash:
602
            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:
611
    """
612
    Pay rewards to the block miner as well as the ommers miners.
613
614
    The miner of the canonical block is rewarded with the predetermined
615
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
616
    number of ommer blocks that were mined around the same time, and included
617
    in the canonical block's header. An ommer block is a block that wasn't
618
    added to the canonical blockchain because it wasn't validated as fast as
619
    the accepted block but was mined at the same time. Although not all blocks
620
    that are mined are added to the canonical chain, miners are still paid a
621
    reward for their efforts. This reward is called an ommer reward and is
622
    calculated based on the number associated with the ommer block that they
623
    mined.
624
625
    Parameters
626
    ----------
627
    state :
628
        Current account state.
629
    block_number :
630
        Position of the block within the chain.
631
    coinbase :
632
        Address of account which receives block reward and transaction fees.
633
    ommers :
634
        List of ommers mentioned in the current block.
635
    """
636
    ommer_count = U256(len(ommers))
637
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
638
    create_ether(state, coinbase, miner_reward)
639
640
    for ommer in ommers:
641
        # Ommer age with respect to the current block.
642
        ommer_age = U256(block_number - ommer.number)
643
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
644
        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

env : Environment for the Ethereum Virtual Machine. tx : Transaction to execute.

Returns

gas_left : ethereum.base_types.U256 Remaining gas after execution. logs : Tuple[ethereum.blocks.Log, ...] Logs generated during execution.

def process_transaction(env: ethereum.muir_glacier.vm.Environmentethereum.berlin.vm.Environment, ​​tx: Transaction) -> Tuple[Uint, Tuple[Log, ...], Optional[EthereumException]]:
650
    """
651
    Execute a transaction against the provided environment.
652
653
    This function processes the actions needed to execute a transaction.
654
    It decrements the sender's account after calculating the gas fee and
655
    refunds them the proper amount after execution. Calling contracts,
656
    deploying code, and incrementing nonces are all examples of actions that
657
    happen within this function or from a call made within this function.
658
659
    Accounts that are marked for deletion are processed and destroyed after
660
    execution.
661
662
    Parameters
663
    ----------
664
    env :
665
        Environment for the Ethereum Virtual Machine.
666
    tx :
667
        Transaction to execute.
668
669
    Returns
670
    -------
671
    gas_left : `ethereum.base_types.U256`
672
        Remaining gas after execution.
673
    logs : `Tuple[ethereum.blocks.Log, ...]`
674
        Logs generated during execution.
675
    """
676
    if not validate_transaction(tx):
677
        raise InvalidBlock
678
679
    sender = env.origin
680
    sender_account = get_account(env.state, sender)
681
    gas_fee = tx.gas * tx.gas_price
682
    if sender_account.nonce != tx.nonce:
683
        raise InvalidBlock
684
    if Uint(sender_account.balance) < gas_fee + Uint(tx.value):
685
        raise InvalidBlock
686
    if sender_account.code != bytearray():
687
        raise InvalidSenderError("not EOA")
688
689
    gas = tx.gas - calculate_intrinsic_cost(tx)
690
    increment_nonce(env.state, sender)
691
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
692
    set_account_balance(env.state, sender, U256(sender_balance_after_gas_fee))
693
694
    preaccessed_addresses = set()
695
    preaccessed_storage_keys = set()
696
    if isinstance(tx, AccessListTransaction):
697
        for address, keys in tx.access_list:
698
            preaccessed_addresses.add(address)
699
            for key in keys:
700
                preaccessed_storage_keys.add((address, key))
701
702
    message = prepare_message(
703
        sender,
704
        tx.to,
705
        tx.value,
706
        tx.data,
707
        gas,
708
        env,
709
        preaccessed_addresses=frozenset(preaccessed_addresses),
710
        preaccessed_storage_keys=frozenset(preaccessed_storage_keys),
711
    )
712
713
    output = process_message_call(message, env)
714
715
    gas_used = tx.gas - output.gas_left
716
    gas_refund = min(gas_used // Uint(2), Uint(output.refund_counter))
717
    gas_refund_amount = (output.gas_left + gas_refund) * tx.gas_price
718
    transaction_fee = (tx.gas - output.gas_left - gas_refund) * tx.gas_price
719
    total_gas_used = gas_used - gas_refund
720
721
    # refund gas
722
    sender_balance_after_refund = get_account(
723
        env.state, sender
724
    ).balance + U256(gas_refund_amount)
725
    set_account_balance(env.state, sender, sender_balance_after_refund)
726
727
    # transfer miner fees
728
    coinbase_balance_after_mining_fee = get_account(
729
        env.state, env.coinbase
730
    ).balance + U256(transaction_fee)
731
    if coinbase_balance_after_mining_fee != 0:
732
        set_account_balance(
733
            env.state, env.coinbase, coinbase_balance_after_mining_fee
734
        )
735
    elif account_exists_and_is_empty(env.state, env.coinbase):
736
        destroy_account(env.state, env.coinbase)
737
738
    for address in output.accounts_to_delete:
739
        destroy_account(env.state, address)
740
741
    for address in output.touched_accounts:
742
        if account_exists_and_is_empty(env.state, address):
743
            destroy_account(env.state, address)
744
745
    return total_gas_used, output.logs, output.error

compute_header_hash

Computes the hash of a block header.

The header hash of a block is the canonical hash that is used to refer to a specific block and completely distinguishes a block from another.

keccak256 is a function that produces a 256 bit hash of any input. It also takes in any number of bytes as an input and produces a single hash for them. A hash is a completely unique output for a single input. So an input corresponds to one unique hash that can be used to identify the input exactly.

Prior to using the keccak256 hash function, the header must be encoded using the Recursive-Length Prefix. See :ref:rlp. RLP encoding the header converts it into a space-efficient format that allows for easy transfer of data between nodes. The purpose of RLP is to encode arbitrarily nested arrays of binary data, and RLP is the primary encoding method used to serialize objects in Ethereum's execution layer. The only purpose of RLP is to encode structure; encoding specific data types (e.g. strings, floats) is left up to higher-order protocols.

Parameters

header : Header of interest.

Returns

hash : ethereum.crypto.hash.Hash32 Hash of the header.

def compute_header_hash(header: Header) -> Hash32:
749
    """
750
    Computes the hash of a block header.
751
752
    The header hash of a block is the canonical hash that is used to refer
753
    to a specific block and completely distinguishes a block from another.
754
755
    ``keccak256`` is a function that produces a 256 bit hash of any input.
756
    It also takes in any number of bytes as an input and produces a single
757
    hash for them. A hash is a completely unique output for a single input.
758
    So an input corresponds to one unique hash that can be used to identify
759
    the input exactly.
760
761
    Prior to using the ``keccak256`` hash function, the header must be
762
    encoded using the Recursive-Length Prefix. See :ref:`rlp`.
763
    RLP encoding the header converts it into a space-efficient format that
764
    allows for easy transfer of data between nodes. The purpose of RLP is to
765
    encode arbitrarily nested arrays of binary data, and RLP is the primary
766
    encoding method used to serialize objects in Ethereum's execution layer.
767
    The only purpose of RLP is to encode structure; encoding specific data
768
    types (e.g. strings, floats) is left up to higher-order protocols.
769
770
    Parameters
771
    ----------
772
    header :
773
        Header of interest.
774
775
    Returns
776
    -------
777
    hash : `ethereum.crypto.hash.Hash32`
778
        Hash of the header.
779
    """
780
    return keccak256(rlp.encode(header))

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:
784
    """
785
    Validates the gas limit for a block.
786
787
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
788
    quotient of the parent block's gas limit and the
789
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
790
    passed through as a parameter is greater than or equal to the *sum* of
791
    the parent's gas and the adjustment delta then the limit for gas is too
792
    high and fails this function's check. Similarly, if the limit is less
793
    than or equal to the *difference* of the parent's gas and the adjustment
794
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
795
    check fails because the gas limit doesn't allow for a sufficient or
796
    reasonable amount of gas to be used on a block.
797
798
    Parameters
799
    ----------
800
    gas_limit :
801
        Gas limit to validate.
802
803
    parent_gas_limit :
804
        Gas limit of the parent block.
805
806
    Returns
807
    -------
808
    check : `bool`
809
        True if gas limit constraints are satisfied, False otherwise.
810
    """
811
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
812
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
813
        return False
814
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
815
        return False
816
    if gas_limit < GAS_LIMIT_MINIMUM:
817
        return False
818
819
    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:
829
    """
830
    Computes difficulty of a block using its header and parent header.
831
832
    The difficulty is determined by the time the block was created after its
833
    parent. The ``offset`` is calculated using the parent block's difficulty,
834
    ``parent_difficulty``, and the timestamp between blocks. This offset is
835
    then added to the parent difficulty and is stored as the ``difficulty``
836
    variable. If the time between the block and its parent is too short, the
837
    offset will result in a positive number thus making the sum of
838
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
839
    avoid mass forking. But, if the time is long enough, then the offset
840
    results in a negative value making the block less difficult than
841
    its parent.
842
843
    The base standard for a block's difficulty is the predefined value
844
    set for the genesis block since it has no parent. So, a block
845
    can't be less difficult than the genesis block, therefore each block's
846
    difficulty is set to the maximum value between the calculated
847
    difficulty and the ``GENESIS_DIFFICULTY``.
848
849
    Parameters
850
    ----------
851
    block_number :
852
        Block number of the block.
853
    block_timestamp :
854
        Timestamp of the block.
855
    parent_timestamp :
856
        Timestamp of the parent block.
857
    parent_difficulty :
858
        difficulty of the parent block.
859
    parent_has_ommers:
860
        does the parent have ommers.
861
862
    Returns
863
    -------
864
    difficulty : `ethereum.base_types.Uint`
865
        Computed difficulty for a block.
866
    """
867
    offset = (
868
        int(parent_difficulty)
869
        // 2048
870
        * max(
871
            (2 if parent_has_ommers else 1)
872
            - int(block_timestamp - parent_timestamp) // 9,
873
            -99,
874
        )
875
    )
876
    difficulty = int(parent_difficulty) + offset
877
    # Historical Note: The difficulty bomb was not present in Ethereum at the
878
    # start of Frontier, but was added shortly after launch. However since the
879
    # bomb has no effect prior to block 200000 we pretend it existed from
880
    # genesis.
881
    # See https://github.com/ethereum/go-ethereum/pull/1588
882
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
883
    if num_bomb_periods >= 0:
884
        difficulty += 2**num_bomb_periods
885
886
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
887
    # the bomb. This bug does not matter because the difficulty is always much
888
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
889
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))