ethereum.forks.spurious_dragon.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

62
BLOCK_REWARD = U256(5 * 10**18)

MINIMUM_DIFFICULTY

63
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

64
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

67
@final
68
@dataclass
class BlockChain:

blocks

74
    blocks: List[Block]

state

75
    state: State

chain_id

76
    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:
80
    <snip>
99
    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]:
103
    <snip>
123
    recent_blocks = chain.blocks[-255:]
124
    # TODO: This function has not been tested rigorously
125
    if len(recent_blocks) == 0:
126
        return []
127
128
    recent_block_hashes = []
129
130
    for block in recent_blocks:
131
        prev_block_hash = block.header.parent_hash
132
        recent_block_hashes.append(prev_block_hash)
133
134
    # We are computing the hash only for the most recent block and not for
135
    # the rest of the blocks as they have successors which have the hash of
136
    # the current block as parent hash.
137
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
138
    recent_block_hashes.append(most_recent_block_hash)
139
140
    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:
144
    <snip>
166
    validate_header(chain, block.header)
167
    validate_ommers(block.ommers, block.header, chain)
168
169
    block_state = BlockState(pre_state=chain.state)
170
171
    block_env = vm.BlockEnvironment(
172
        chain_id=chain.chain_id,
173
        state=block_state,
174
        block_gas_limit=block.header.gas_limit,
175
        block_hashes=get_last_256_block_hashes(chain),
176
        coinbase=block.header.coinbase,
177
        number=block.header.number,
178
        time=block.header.timestamp,
179
        difficulty=block.header.difficulty,
180
    )
181
182
    block_output = apply_body(
183
        block_env=block_env,
184
        transactions=block.transactions,
185
        ommers=block.ommers,
186
    )
187
    block_diff = extract_block_diff(block_state)
188
    block_state_root = chain.state.compute_state_root(block_diff)
189
    transactions_root = root(block_output.transactions_trie)
190
    receipt_root = root(block_output.receipts_trie)
191
    block_logs_bloom = logs_bloom(block_output.block_logs)
192
193
    if block_output.block_gas_used != block.header.gas_used:
194
        raise InvalidBlock(
195
            f"{block_output.block_gas_used} != {block.header.gas_used}"
196
        )
197
    if transactions_root != block.header.transactions_root:
198
        raise InvalidBlock
199
    if block_state_root != block.header.state_root:
200
        raise InvalidBlock
201
    if receipt_root != block.header.receipt_root:
202
        raise InvalidBlock
203
    if block_logs_bloom != block.header.bloom:
204
        raise InvalidBlock
205
206
    apply_changes_to_state(chain.state, block_diff)
207
    chain.blocks.append(block)
208
    if len(chain.blocks) > 255:
209
        # Real clients have to store more blocks to deal with reorgs, but the
210
        # protocol only requires the last 255
211
        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

chain : History and current state. header : Header to check for correctness.

def validate_header(chain: BlockChain, ​​header: Header) -> None:
215
    <snip>
233
    if header.number < Uint(1):
234
        raise InvalidBlock
235
    parent_header_number = header.number - Uint(1)
236
    first_block_number = chain.blocks[0].header.number
237
    last_block_number = chain.blocks[-1].header.number
238
239
    if (
240
        parent_header_number < first_block_number
241
        or parent_header_number > last_block_number
242
    ):
243
        raise InvalidBlock
244
245
    parent_header = chain.blocks[
246
        parent_header_number - first_block_number
247
    ].header
248
249
    if header.gas_used > header.gas_limit:
250
        raise InvalidBlock
251
252
    if header.timestamp <= parent_header.timestamp:
253
        raise InvalidBlock
254
    if header.number != parent_header.number + Uint(1):
255
        raise InvalidBlock
256
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
257
        raise InvalidBlock
258
    if len(header.extra_data) > 32:
259
        raise InvalidBlock
260
261
    block_difficulty = calculate_block_difficulty(
262
        header.number,
263
        header.timestamp,
264
        parent_header.timestamp,
265
        parent_header.difficulty,
266
    )
267
    if header.difficulty != block_difficulty:
268
        raise InvalidBlock
269
270
    block_parent_hash = keccak256(rlp.encode(parent_header))
271
    if header.parent_hash != block_parent_hash:
272
        raise InvalidBlock
273
274
    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:
278
    <snip>
301
    header_data_without_pow_artefacts = (
302
        header.parent_hash,
303
        header.ommers_hash,
304
        header.coinbase,
305
        header.state_root,
306
        header.transactions_root,
307
        header.receipt_root,
308
        header.bloom,
309
        header.difficulty,
310
        header.number,
311
        header.gas_limit,
312
        header.gas_used,
313
        header.timestamp,
314
        header.extra_data,
315
    )
316
317
    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:
321
    <snip>
336
    header_hash = generate_header_hash_for_pow(header)
337
    # TODO: Memoize this somewhere and read from that data instead of
338
    # calculating cache for every block validation.
339
    cache = generate_cache(header.number)
340
    mix_digest, result = hashimoto_light(
341
        header_hash, header.nonce, cache, dataset_size(header.number)
342
    )
343
    if mix_digest != header.mix_digest:
344
        raise InvalidBlock
345
346
    limit = Uint(U256.MAX_VALUE) + Uint(1)
347
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
348
        raise InvalidBlock

check_transaction

Check if the transaction is includable in the block.

Parameters

block_env : The block scoped environment. block_output : The block output for the current block. tx : The transaction. tx_state : The transaction state tracker.

Returns

sender_address : The sender of the transaction.

Raises

GasUsedExceedsLimitError : If the gas used by the transaction exceeds the block's gas limit. NonceMismatchError : If the nonce of the transaction is not equal to the sender's nonce. InsufficientBalanceError : If the sender's balance is not enough to pay for the transaction. InvalidSenderError : If the transaction is from an address that does not exist anymore.

def check_transaction(block_env: ethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​block_output: ethereum.forks.spurious_dragon.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
357
    <snip>
388
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
389
    if tx.gas > gas_available:
390
        raise GasUsedExceedsLimitError("gas used exceeds limit")
391
    tx_chain_id = chain_id(tx)
392
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
393
        raise WrongChainIdError(
394
            expected=block_env.chain_id,
395
            actual=tx_chain_id,
396
        )
397
398
    sender_address = recover_sender(tx)
399
    sender_account = get_account(tx_state, sender_address)
400
401
    max_gas_fee = tx.gas * tx.gas_price
402
403
    if sender_account.nonce > Uint(tx.nonce):
404
        raise NonceMismatchError("nonce too low")
405
    elif sender_account.nonce < Uint(tx.nonce):
406
        raise NonceMismatchError("nonce too high")
407
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
408
        raise InsufficientBalanceError("insufficient sender balance")
409
    if sender_account.code_hash != EMPTY_CODE_HASH:
410
        raise InvalidSenderError("not EOA")
411
412
    return sender_address

make_receipt

Make the receipt for a transaction that was executed.

Parameters

post_state : The state root immediately after this transaction. 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(post_state: Bytes32, ​​cumulative_gas_used: Uint, ​​logs: Tuple[Log, ...]) -> Receipt:
420
    <snip>
439
    receipt = Receipt(
440
        post_state=post_state,
441
        cumulative_gas_used=cumulative_gas_used,
442
        bloom=logs_bloom(logs),
443
        logs=logs,
444
    )
445
446
    return receipt

apply_body

Executes a block.

Many of the contents of a block are stored in data structures called tries. There is a transactions trie which is similar to a ledger of the transactions stored in the current block. There is also a receipts trie which stores the results of executing a transaction, like the post state and gas used. This function creates and executes the block that is to be added to the chain.

Parameters

block_env : The block scoped environment. transactions : Transactions included in the block. ommers : Headers of ancestor blocks which are not direct parents (formerly uncles.)

Returns

block_output : The block output for the current block.

def apply_body(block_env: ethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.spurious_dragon.vm.BlockOutput:
454
    <snip>
480
    block_output = vm.BlockOutput()
481
482
    for i, tx in enumerate(transactions):
483
        process_transaction(block_env, block_output, tx, Uint(i))
484
485
    pay_rewards(block_env, ommers)
486
487
    return block_output

validate_ommers

Validates the ommers mentioned in the block.

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

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

Parameters

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

def validate_ommers(ommers: Tuple[Header, ...], ​​block_header: Header, ​​chain: BlockChain) -> None:
493
    <snip>
515
    block_hash = keccak256(rlp.encode(block_header))
516
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
517
        raise InvalidBlock
518
519
    if len(ommers) == 0:
520
        # Nothing to validate
521
        return
522
523
    # Check that each ommer satisfies the constraints of a header
524
    for ommer in ommers:
525
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
526
            raise InvalidBlock
527
        validate_header(chain, ommer)
528
    if len(ommers) > 2:
529
        raise InvalidBlock
530
531
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
532
    if len(ommers_hashes) != len(set(ommers_hashes)):
533
        raise InvalidBlock
534
535
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
536
    recent_canonical_block_hashes = {
537
        keccak256(rlp.encode(block.header))
538
        for block in recent_canonical_blocks
539
    }
540
    recent_ommers_hashes: Set[Hash32] = set()
541
    for block in recent_canonical_blocks:
542
        recent_ommers_hashes = recent_ommers_hashes.union(
543
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
544
        )
545
546
    for ommer_index, ommer in enumerate(ommers):
547
        ommer_hash = ommers_hashes[ommer_index]
548
        if ommer_hash == block_hash:
549
            raise InvalidBlock
550
        if ommer_hash in recent_canonical_block_hashes:
551
            raise InvalidBlock
552
        if ommer_hash in recent_ommers_hashes:
553
            raise InvalidBlock
554
555
        # Ommer age with respect to the current block. For example, an age of
556
        # 1 indicates that the ommer is a sibling of previous block.
557
        ommer_age = block_header.number - ommer.number
558
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
559
            raise InvalidBlock
560
        if ommer.parent_hash not in recent_canonical_block_hashes:
561
            raise InvalidBlock
562
        if ommer.parent_hash == block_header.parent_hash:
563
            raise InvalidBlock

pay_rewards

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

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

Parameters

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

def pay_rewards(block_env: ethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
570
    <snip>
592
    rewards_state = TransactionState(parent=block_env.state)
593
    ommer_count = U256(len(ommers))
594
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
595
    create_ether(rewards_state, block_env.coinbase, miner_reward)
596
597
    for ommer in ommers:
598
        # Ommer age with respect to the current block.
599
        ommer_age = U256(block_env.number - ommer.number)
600
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
601
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
602
603
    incorporate_tx_into_block(rewards_state)

process_transaction

Execute a transaction against the provided environment.

This function processes the actions needed to execute a transaction. It decrements the sender's account balance after calculating the gas fee and refunds them the proper amount after execution. Calling contracts, deploying code, and incrementing nonces are all examples of actions that happen within this function or from a call made within this function.

Accounts that are marked for deletion are processed and destroyed after execution.

Parameters

block_env : Environment for the Ethereum Virtual Machine. block_output : The block output for the current block. tx : Transaction to execute. index: Index of the transaction in the block.

def process_transaction(block_env: ethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​block_output: ethereum.forks.spurious_dragon.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
612
    <snip>
636
    tx_state = TransactionState(parent=block_env.state)
637
638
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
639
    intrinsic_gas = validate_transaction(tx)
640
641
    sender = check_transaction(
642
        block_env=block_env,
643
        block_output=block_output,
644
        tx=tx,
645
        tx_state=tx_state,
646
    )
647
648
    sender_account = get_account(tx_state, sender)
649
650
    gas = tx.gas - intrinsic_gas
651
    increment_nonce(tx_state, sender)
652
653
    gas_fee = tx.gas * tx.gas_price
654
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
655
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
656
657
    tx_env = vm.TransactionEnvironment(
658
        origin=sender,
659
        gas_price=tx.gas_price,
660
        gas=gas,
661
        state=tx_state,
662
        index_in_block=index,
663
        tx_hash=get_transaction_hash(tx),
664
    )
665
666
    message = prepare_message(block_env, tx_env, tx)
667
668
    tx_output = process_message_call(message)
669
670
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
671
    tx_gas_refund = min(
672
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
673
    )
674
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
675
    tx_gas_left = tx.gas - tx_gas_used_after_refund
676
    gas_refund_amount = tx_gas_left * tx.gas_price
677
678
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
679
680
    # refund gas
681
    create_ether(tx_state, sender, U256(gas_refund_amount))
682
683
    # transfer miner fees
684
    coinbase_balance_after_mining_fee = get_account(
685
        tx_state, block_env.coinbase
686
    ).balance + U256(transaction_fee)
687
    if coinbase_balance_after_mining_fee != 0:
688
        set_account_balance(
689
            tx_state,
690
            block_env.coinbase,
691
            coinbase_balance_after_mining_fee,
692
        )
693
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
694
        destroy_account(tx_state, block_env.coinbase)
695
696
    for address in tx_output.accounts_to_delete:
697
        destroy_account(tx_state, address)
698
699
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
700
701
    block_output.block_gas_used += tx_gas_used_after_refund
702
703
    incorporate_tx_into_block(tx_state)
704
705
    block_state = block_env.state
706
    block_diff = extract_block_diff(block_state)
707
    intermediate_state_root = block_state.pre_state.compute_state_root(
708
        block_diff
709
    )
710
711
    receipt = make_receipt(
712
        intermediate_state_root,
713
        block_output.block_gas_used,
714
        tx_output.logs,
715
    )
716
717
    receipt_key = rlp.encode(Uint(index))
718
    block_output.receipt_keys += (receipt_key,)
719
720
    trie_set(
721
        block_output.receipts_trie,
722
        receipt_key,
723
        receipt,
724
    )
725
726
    block_output.block_logs += tx_output.logs

check_gas_limit

Validates the gas limit for a block.

The bounds of the gas limit, max_adjustment_delta, is set as the quotient of the parent block's gas limit and the LIMIT_ADJUSTMENT_FACTOR. Therefore, if the gas limit that is passed through as a parameter is greater than or equal to the sum of the parent's gas and the adjustment delta then the limit for gas is too high and fails this function's check. Similarly, if the limit is less than or equal to the difference of the parent's gas and the adjustment delta or the predefined LIMIT_MINIMUM then this function's check fails because the gas limit doesn't allow for a sufficient or reasonable amount of gas to be used on a block.

Parameters

gas_limit : Gas limit to validate.

parent_gas_limit : Gas limit of the parent block.

Returns

check : bool True if gas limit constraints are satisfied, False otherwise.

def check_gas_limit(gas_limit: Uint, ​​parent_gas_limit: Uint) -> bool:
730
    <snip>
758
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
759
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
760
        return False
761
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
762
        return False
763
    if gas_limit < GasCosts.LIMIT_MINIMUM:
764
        return False
765
766
    return True

calculate_block_difficulty

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

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

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

Parameters

block_number : Block number of the block. block_timestamp : Timestamp of the block. parent_timestamp : Timestamp of the parent block. parent_difficulty : difficulty of the parent block.

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) -> Uint:
775
    <snip>
812
    offset = (
813
        int(parent_difficulty)
814
        // 2048
815
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
816
    )
817
    difficulty = int(parent_difficulty) + offset
818
    # Historical Note: The difficulty bomb was not present in Ethereum at the
819
    # start of Frontier, but was added shortly after launch. However since the
820
    # bomb has no effect prior to block 200000 we pretend it existed from
821
    # genesis.
822
    # See https://github.com/ethereum/go-ethereum/pull/1588
823
    num_bomb_periods = (int(block_number) // 100000) - 2
824
    if num_bomb_periods >= 0:
825
        difficulty += 2**num_bomb_periods
826
827
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
828
    # the bomb. This bug does not matter because the difficulty is always much
829
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
830
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))