ethereum.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 rlp.rlp_hash(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[Exception], ​​cumulative_gas_used: Uint, ​​logs: Tuple[Log, ...]) -> Union[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
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[Union[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
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
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 = rlp.rlp_hash(block_header)
552
    if rlp.rlp_hash(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 = [rlp.rlp_hash(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
        rlp.rlp_hash(block.header) for block in recent_canonical_blocks
577
    }
578
    recent_ommers_hashes: Set[Hash32] = set()
579
    for block in recent_canonical_blocks:
580
        recent_ommers_hashes = recent_ommers_hashes.union(
581
            {rlp.rlp_hash(ommer) for ommer in block.ommers}
582
        )
583
584
    for ommer_index, ommer in enumerate(ommers):
585
        ommer_hash = ommers_hashes[ommer_index]
586
        if ommer_hash == block_hash:
587
            raise InvalidBlock
588
        if ommer_hash in recent_canonical_block_hashes:
589
            raise InvalidBlock
590
        if ommer_hash in recent_ommers_hashes:
591
            raise InvalidBlock
592
593
        # Ommer age with respect to the current block. For example, an age of
594
        # 1 indicates that the ommer is a sibling of previous block.
595
        ommer_age = block_header.number - ommer.number
596
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
597
            raise InvalidBlock
598
        if ommer.parent_hash not in recent_canonical_block_hashes:
599
            raise InvalidBlock
600
        if ommer.parent_hash == block_header.parent_hash:
601
            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:
610
    """
611
    Pay rewards to the block miner as well as the ommers miners.
612
613
    The miner of the canonical block is rewarded with the predetermined
614
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
615
    number of ommer blocks that were mined around the same time, and included
616
    in the canonical block's header. An ommer block is a block that wasn't
617
    added to the canonical blockchain because it wasn't validated as fast as
618
    the accepted block but was mined at the same time. Although not all blocks
619
    that are mined are added to the canonical chain, miners are still paid a
620
    reward for their efforts. This reward is called an ommer reward and is
621
    calculated based on the number associated with the ommer block that they
622
    mined.
623
624
    Parameters
625
    ----------
626
    state :
627
        Current account state.
628
    block_number :
629
        Position of the block within the chain.
630
    coinbase :
631
        Address of account which receives block reward and transaction fees.
632
    ommers :
633
        List of ommers mentioned in the current block.
634
    """
635
    ommer_count = U256(len(ommers))
636
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
637
    create_ether(state, coinbase, miner_reward)
638
639
    for ommer in ommers:
640
        # Ommer age with respect to the current block.
641
        ommer_age = U256(block_number - ommer.number)
642
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
643
        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.berlin.vm.Environment, ​​tx: Transaction) -> Tuple[Uint, Tuple[Log, ...], Optional[Exception]]:
649
    """
650
    Execute a transaction against the provided environment.
651
652
    This function processes the actions needed to execute a transaction.
653
    It decrements the sender's account after calculating the gas fee and
654
    refunds them the proper amount after execution. Calling contracts,
655
    deploying code, and incrementing nonces are all examples of actions that
656
    happen within this function or from a call made within this function.
657
658
    Accounts that are marked for deletion are processed and destroyed after
659
    execution.
660
661
    Parameters
662
    ----------
663
    env :
664
        Environment for the Ethereum Virtual Machine.
665
    tx :
666
        Transaction to execute.
667
668
    Returns
669
    -------
670
    gas_left : `ethereum.base_types.U256`
671
        Remaining gas after execution.
672
    logs : `Tuple[ethereum.blocks.Log, ...]`
673
        Logs generated during execution.
674
    """
675
    if not validate_transaction(tx):
676
        raise InvalidBlock
677
678
    sender = env.origin
679
    sender_account = get_account(env.state, sender)
680
    gas_fee = tx.gas * tx.gas_price
681
    if sender_account.nonce != tx.nonce:
682
        raise InvalidBlock
683
    if Uint(sender_account.balance) < gas_fee + Uint(tx.value):
684
        raise InvalidBlock
685
    if sender_account.code != bytearray():
686
        raise InvalidSenderError("not EOA")
687
688
    gas = tx.gas - calculate_intrinsic_cost(tx)
689
    increment_nonce(env.state, sender)
690
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
691
    set_account_balance(env.state, sender, U256(sender_balance_after_gas_fee))
692
693
    preaccessed_addresses = set()
694
    preaccessed_storage_keys = set()
695
    if isinstance(tx, AccessListTransaction):
696
        for address, keys in tx.access_list:
697
            preaccessed_addresses.add(address)
698
            for key in keys:
699
                preaccessed_storage_keys.add((address, key))
700
701
    message = prepare_message(
702
        sender,
703
        tx.to,
704
        tx.value,
705
        tx.data,
706
        gas,
707
        env,
708
        preaccessed_addresses=frozenset(preaccessed_addresses),
709
        preaccessed_storage_keys=frozenset(preaccessed_storage_keys),
710
    )
711
712
    output = process_message_call(message, env)
713
714
    gas_used = tx.gas - output.gas_left
715
    gas_refund = min(gas_used // Uint(2), Uint(output.refund_counter))
716
    gas_refund_amount = (output.gas_left + gas_refund) * tx.gas_price
717
    transaction_fee = (tx.gas - output.gas_left - gas_refund) * tx.gas_price
718
    total_gas_used = gas_used - gas_refund
719
720
    # refund gas
721
    sender_balance_after_refund = get_account(
722
        env.state, sender
723
    ).balance + U256(gas_refund_amount)
724
    set_account_balance(env.state, sender, sender_balance_after_refund)
725
726
    # transfer miner fees
727
    coinbase_balance_after_mining_fee = get_account(
728
        env.state, env.coinbase
729
    ).balance + U256(transaction_fee)
730
    if coinbase_balance_after_mining_fee != 0:
731
        set_account_balance(
732
            env.state, env.coinbase, coinbase_balance_after_mining_fee
733
        )
734
    elif account_exists_and_is_empty(env.state, env.coinbase):
735
        destroy_account(env.state, env.coinbase)
736
737
    for address in output.accounts_to_delete:
738
        destroy_account(env.state, address)
739
740
    for address in output.touched_accounts:
741
        if account_exists_and_is_empty(env.state, address):
742
            destroy_account(env.state, address)
743
744
    return total_gas_used, output.logs, output.error

validate_transaction

Verifies a transaction.

The gas in a transaction gets used to pay for the intrinsic cost of operations, therefore if there is insufficient gas then it would not be possible to execute a transaction and it will be declared invalid.

Additionally, the nonce of a transaction must not equal or exceed the limit defined in EIP-2681 <https://eips.ethereum.org/EIPS/eip-2681>_. In practice, defining the limit as 2**64-1 has no impact because sending 2**64-1 transactions is improbable. It's not strictly impossible though, 2**64-1 transactions is the entire capacity of the Ethereum blockchain at 2022 gas limits for a little over 22 years.

Parameters

tx : Transaction to validate.

Returns

verified : bool True if the transaction can be executed, or False otherwise.

def validate_transaction(tx: Transaction) -> bool:
748
    """
749
    Verifies a transaction.
750
751
    The gas in a transaction gets used to pay for the intrinsic cost of
752
    operations, therefore if there is insufficient gas then it would not
753
    be possible to execute a transaction and it will be declared invalid.
754
755
    Additionally, the nonce of a transaction must not equal or exceed the
756
    limit defined in `EIP-2681 <https://eips.ethereum.org/EIPS/eip-2681>`_.
757
    In practice, defining the limit as ``2**64-1`` has no impact because
758
    sending ``2**64-1`` transactions is improbable. It's not strictly
759
    impossible though, ``2**64-1`` transactions is the entire capacity of the
760
    Ethereum blockchain at 2022 gas limits for a little over 22 years.
761
762
    Parameters
763
    ----------
764
    tx :
765
        Transaction to validate.
766
767
    Returns
768
    -------
769
    verified : `bool`
770
        True if the transaction can be executed, or False otherwise.
771
    """
772
    if calculate_intrinsic_cost(tx) > Uint(tx.gas):
773
        return False
774
    if tx.nonce >= U256(U64.MAX_VALUE):
775
        return False
776
    return True

calculate_intrinsic_cost

Calculates the gas that is charged before execution is started.

The intrinsic cost of the transaction is charged before execution has begun. Functions/operations in the EVM cost money to execute so this intrinsic cost is for the operations that need to be paid for as part of the transaction. Data transfer, for example, is part of this intrinsic cost. It costs ether to send data over the wire and that ether is accounted for in the intrinsic cost calculated in this function. This intrinsic cost must be calculated and paid for before execution in order for all operations to be implemented.

Parameters

tx : Transaction to compute the intrinsic cost of.

Returns

verified : ethereum.base_types.Uint The intrinsic cost of the transaction.

def calculate_intrinsic_cost(tx: Transaction) -> Uint:
780
    """
781
    Calculates the gas that is charged before execution is started.
782
783
    The intrinsic cost of the transaction is charged before execution has
784
    begun. Functions/operations in the EVM cost money to execute so this
785
    intrinsic cost is for the operations that need to be paid for as part of
786
    the transaction. Data transfer, for example, is part of this intrinsic
787
    cost. It costs ether to send data over the wire and that ether is
788
    accounted for in the intrinsic cost calculated in this function. This
789
    intrinsic cost must be calculated and paid for before execution in order
790
    for all operations to be implemented.
791
792
    Parameters
793
    ----------
794
    tx :
795
        Transaction to compute the intrinsic cost of.
796
797
    Returns
798
    -------
799
    verified : `ethereum.base_types.Uint`
800
        The intrinsic cost of the transaction.
801
    """
802
    data_cost = 0
803
804
    for byte in tx.data:
805
        if byte == 0:
806
            data_cost += TX_DATA_COST_PER_ZERO
807
        else:
808
            data_cost += TX_DATA_COST_PER_NON_ZERO
809
810
    if tx.to == Bytes0(b""):
811
        create_cost = TX_CREATE_COST
812
    else:
813
        create_cost = 0
814
815
    access_list_cost = 0
816
    if isinstance(tx, AccessListTransaction):
817
        for _address, keys in tx.access_list:
818
            access_list_cost += TX_ACCESS_LIST_ADDRESS_COST
819
            access_list_cost += len(keys) * TX_ACCESS_LIST_STORAGE_KEY_COST
820
821
    return Uint(TX_BASE_COST + data_cost + create_cost + access_list_cost)

recover_sender

Extracts the sender address from a transaction.

The v, r, and s values are the three parts that make up the signature of a transaction. In order to recover the sender of a transaction the two components needed are the signature (v, r, and s) and the signing hash of the transaction. The sender's public key can be obtained with these two values and therefore the sender address can be retrieved.

Parameters

tx : Transaction of interest. chain_id : ID of the executing chain.

Returns

sender : ethereum.fork_types.Address The address of the account that signed the transaction.

def recover_sender(chain_id: U64, ​​tx: Transaction) -> Address:
825
    """
826
    Extracts the sender address from a transaction.
827
828
    The v, r, and s values are the three parts that make up the signature
829
    of a transaction. In order to recover the sender of a transaction the two
830
    components needed are the signature (``v``, ``r``, and ``s``) and the
831
    signing hash of the transaction. The sender's public key can be obtained
832
    with these two values and therefore the sender address can be retrieved.
833
834
    Parameters
835
    ----------
836
    tx :
837
        Transaction of interest.
838
    chain_id :
839
        ID of the executing chain.
840
841
    Returns
842
    -------
843
    sender : `ethereum.fork_types.Address`
844
        The address of the account that signed the transaction.
845
    """
846
    r, s = tx.r, tx.s
847
    if U256(0) >= r or r >= SECP256K1N:
848
        raise InvalidBlock
849
    if U256(0) >= s or s > SECP256K1N // U256(2):
850
        raise InvalidBlock
851
852
    if isinstance(tx, LegacyTransaction):
853
        v = tx.v
854
        if v == 27 or v == 28:
855
            public_key = secp256k1_recover(
856
                r, s, v - U256(27), signing_hash_pre155(tx)
857
            )
858
        else:
859
            chain_id_x2 = U256(chain_id) * U256(2)
860
            if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
861
                raise InvalidBlock
862
            public_key = secp256k1_recover(
863
                r,
864
                s,
865
                v - U256(35) - chain_id_x2,
866
                signing_hash_155(tx, chain_id),
867
            )
868
    elif isinstance(tx, AccessListTransaction):
869
        public_key = secp256k1_recover(
870
            r, s, tx.y_parity, signing_hash_2930(tx)
871
        )
872
873
    return Address(keccak256(public_key)[12:32])

signing_hash_pre155

Compute the hash of a transaction used in a legacy (pre EIP 155) signature.

Parameters

tx : Transaction of interest.

Returns

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

def signing_hash_pre155(tx: Transaction) -> Hash32:
877
    """
878
    Compute the hash of a transaction used in a legacy (pre EIP 155) signature.
879
880
    Parameters
881
    ----------
882
    tx :
883
        Transaction of interest.
884
885
    Returns
886
    -------
887
    hash : `ethereum.crypto.hash.Hash32`
888
        Hash of the transaction.
889
    """
890
    return keccak256(
891
        rlp.encode(
892
            (
893
                tx.nonce,
894
                tx.gas_price,
895
                tx.gas,
896
                tx.to,
897
                tx.value,
898
                tx.data,
899
            )
900
        )
901
    )

signing_hash_155

Compute the hash of a transaction used in a EIP 155 signature.

Parameters

tx : Transaction of interest. chain_id : The id of the current chain.

Returns

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

def signing_hash_155(tx: Transaction, ​​chain_id: U64) -> Hash32:
905
    """
906
    Compute the hash of a transaction used in a EIP 155 signature.
907
908
    Parameters
909
    ----------
910
    tx :
911
        Transaction of interest.
912
    chain_id :
913
        The id of the current chain.
914
915
    Returns
916
    -------
917
    hash : `ethereum.crypto.hash.Hash32`
918
        Hash of the transaction.
919
    """
920
    return keccak256(
921
        rlp.encode(
922
            (
923
                tx.nonce,
924
                tx.gas_price,
925
                tx.gas,
926
                tx.to,
927
                tx.value,
928
                tx.data,
929
                chain_id,
930
                Uint(0),
931
                Uint(0),
932
            )
933
        )
934
    )

signing_hash_2930

Compute the hash of a transaction used in a EIP 2930 signature.

Parameters

tx : Transaction of interest.

Returns

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

def signing_hash_2930(tx: AccessListTransaction) -> Hash32:
938
    """
939
    Compute the hash of a transaction used in a EIP 2930 signature.
940
941
    Parameters
942
    ----------
943
    tx :
944
        Transaction of interest.
945
946
    Returns
947
    -------
948
    hash : `ethereum.crypto.hash.Hash32`
949
        Hash of the transaction.
950
    """
951
    return keccak256(
952
        b"\x01"
953
        + rlp.encode(
954
            (
955
                tx.chain_id,
956
                tx.nonce,
957
                tx.gas_price,
958
                tx.gas,
959
                tx.to,
960
                tx.value,
961
                tx.data,
962
                tx.access_list,
963
            )
964
        )
965
    )

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:
969
    """
970
    Computes the hash of a block header.
971
972
    The header hash of a block is the canonical hash that is used to refer
973
    to a specific block and completely distinguishes a block from another.
974
975
    ``keccak256`` is a function that produces a 256 bit hash of any input.
976
    It also takes in any number of bytes as an input and produces a single
977
    hash for them. A hash is a completely unique output for a single input.
978
    So an input corresponds to one unique hash that can be used to identify
979
    the input exactly.
980
981
    Prior to using the ``keccak256`` hash function, the header must be
982
    encoded using the Recursive-Length Prefix. See :ref:`rlp`.
983
    RLP encoding the header converts it into a space-efficient format that
984
    allows for easy transfer of data between nodes. The purpose of RLP is to
985
    encode arbitrarily nested arrays of binary data, and RLP is the primary
986
    encoding method used to serialize objects in Ethereum's execution layer.
987
    The only purpose of RLP is to encode structure; encoding specific data
988
    types (e.g. strings, floats) is left up to higher-order protocols.
989
990
    Parameters
991
    ----------
992
    header :
993
        Header of interest.
994
995
    Returns
996
    -------
997
    hash : `ethereum.crypto.hash.Hash32`
998
        Hash of the header.
999
    """
1000
    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:
1004
    """
1005
    Validates the gas limit for a block.
1006
1007
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
1008
    quotient of the parent block's gas limit and the
1009
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
1010
    passed through as a parameter is greater than or equal to the *sum* of
1011
    the parent's gas and the adjustment delta then the limit for gas is too
1012
    high and fails this function's check. Similarly, if the limit is less
1013
    than or equal to the *difference* of the parent's gas and the adjustment
1014
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
1015
    check fails because the gas limit doesn't allow for a sufficient or
1016
    reasonable amount of gas to be used on a block.
1017
1018
    Parameters
1019
    ----------
1020
    gas_limit :
1021
        Gas limit to validate.
1022
1023
    parent_gas_limit :
1024
        Gas limit of the parent block.
1025
1026
    Returns
1027
    -------
1028
    check : `bool`
1029
        True if gas limit constraints are satisfied, False otherwise.
1030
    """
1031
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
1032
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
1033
        return False
1034
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
1035
        return False
1036
    if gas_limit < GAS_LIMIT_MINIMUM:
1037
        return False
1038
1039
    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:
1049
    """
1050
    Computes difficulty of a block using its header and parent header.
1051
1052
    The difficulty is determined by the time the block was created after its
1053
    parent. The ``offset`` is calculated using the parent block's difficulty,
1054
    ``parent_difficulty``, and the timestamp between blocks. This offset is
1055
    then added to the parent difficulty and is stored as the ``difficulty``
1056
    variable. If the time between the block and its parent is too short, the
1057
    offset will result in a positive number thus making the sum of
1058
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
1059
    avoid mass forking. But, if the time is long enough, then the offset
1060
    results in a negative value making the block less difficult than
1061
    its parent.
1062
1063
    The base standard for a block's difficulty is the predefined value
1064
    set for the genesis block since it has no parent. So, a block
1065
    can't be less difficult than the genesis block, therefore each block's
1066
    difficulty is set to the maximum value between the calculated
1067
    difficulty and the ``GENESIS_DIFFICULTY``.
1068
1069
    Parameters
1070
    ----------
1071
    block_number :
1072
        Block number of the block.
1073
    block_timestamp :
1074
        Timestamp of the block.
1075
    parent_timestamp :
1076
        Timestamp of the parent block.
1077
    parent_difficulty :
1078
        difficulty of the parent block.
1079
    parent_has_ommers:
1080
        does the parent have ommers.
1081
1082
    Returns
1083
    -------
1084
    difficulty : `ethereum.base_types.Uint`
1085
        Computed difficulty for a block.
1086
    """
1087
    offset = (
1088
        int(parent_difficulty)
1089
        // 2048
1090
        * max(
1091
            (2 if parent_has_ommers else 1)
1092
            - int(block_timestamp - parent_timestamp) // 9,
1093
            -99,
1094
        )
1095
    )
1096
    difficulty = int(parent_difficulty) + offset
1097
    # Historical Note: The difficulty bomb was not present in Ethereum at the
1098
    # start of Frontier, but was added shortly after launch. However since the
1099
    # bomb has no effect prior to block 200000 we pretend it existed from
1100
    # genesis.
1101
    # See https://github.com/ethereum/go-ethereum/pull/1588
1102
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
1103
    if num_bomb_periods >= 0:
1104
        difficulty += 2**num_bomb_periods
1105
1106
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
1107
    # the bomb. This bug does not matter because the difficulty is always much
1108
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
1109
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))