ethereum.forks.tangerine_whistle.forkethereum.forks.spurious_dragon.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

MINIMUM_DIFFICULTY

65
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

66
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

69
@final
70
@dataclass
class BlockChain:

blocks

76
    blocks: List[Block]

state

77
    state: State

chain_id

78
    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:
82
    <snip>
101
    return old

get_last_256_block_hashes

Obtain the list of hashes of the previous 256 blocks in order of increasing block number.

This function will return less hashes for the first 256 blocks.

The BLOCKHASH opcode needs to access the latest hashes on the chain, therefore this function retrieves them.

Parameters

chain : History and current state.

Returns

recent_block_hashes : List[Hash32] Hashes of the recent 256 blocks in order of increasing block number.

def get_last_256_block_hashes(chain: BlockChain) -> List[Hash32]:
105
    <snip>
125
    recent_blocks = chain.blocks[-255:]
126
    # TODO: This function has not been tested rigorously
127
    if len(recent_blocks) == 0:
128
        return []
129
130
    recent_block_hashes = []
131
132
    for block in recent_blocks:
133
        prev_block_hash = block.header.parent_hash
134
        recent_block_hashes.append(prev_block_hash)
135
136
    # We are computing the hash only for the most recent block and not for
137
    # the rest of the blocks as they have successors which have the hash of
138
    # the current block as parent hash.
139
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
140
    recent_block_hashes.append(most_recent_block_hash)
141
142
    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:
146
    <snip>
168
    validate_header(chain, block.header)
169
    validate_ommers(block.ommers, block.header, chain)
170
171
    block_state = BlockState(pre_state=chain.state)
172
173
    block_env = vm.BlockEnvironment(
174
        chain_id=chain.chain_id,
175
        state=block_state,
176
        block_gas_limit=block.header.gas_limit,
177
        block_hashes=get_last_256_block_hashes(chain),
178
        coinbase=block.header.coinbase,
179
        number=block.header.number,
180
        time=block.header.timestamp,
181
        difficulty=block.header.difficulty,
182
    )
183
184
    block_output = apply_body(
185
        block_env=block_env,
186
        transactions=block.transactions,
187
        ommers=block.ommers,
188
    )
189
    block_diff = extract_block_diff(block_state)
190
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
191
        block_diff.account_changes,
192
        block_diff.storage_changes,
193
        block_diff.storage_clears,
194
    )
195
    transactions_root = root(block_output.transactions_trie)
196
    receipt_root = root(block_output.receipts_trie)
197
    block_logs_bloom = logs_bloom(block_output.block_logs)
198
199
    if block_output.block_gas_used != block.header.gas_used:
200
        raise InvalidBlock(
201
            f"{block_output.block_gas_used} != {block.header.gas_used}"
202
        )
203
    if transactions_root != block.header.transactions_root:
204
        raise InvalidBlock
205
    if block_state_root != block.header.state_root:
206
        raise InvalidBlock
207
    if receipt_root != block.header.receipt_root:
208
        raise InvalidBlock
209
    if block_logs_bloom != block.header.bloom:
210
        raise InvalidBlock
211
212
    apply_changes_to_state(chain.state, block_diff)
213
    chain.blocks.append(block)
214
    if len(chain.blocks) > 255:
215
        # Real clients have to store more blocks to deal with reorgs, but the
216
        # protocol only requires the last 255
217
        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:
221
    <snip>
239
    if header.number < Uint(1):
240
        raise InvalidBlock
241
    parent_header_number = header.number - Uint(1)
242
    first_block_number = chain.blocks[0].header.number
243
    last_block_number = chain.blocks[-1].header.number
244
245
    if (
246
        parent_header_number < first_block_number
247
        or parent_header_number > last_block_number
248
    ):
249
        raise InvalidBlock
250
251
    parent_header = chain.blocks[
252
        parent_header_number - first_block_number
253
    ].header
254
255
    if header.gas_used > header.gas_limit:
256
        raise InvalidBlock
257
258
    if header.timestamp <= parent_header.timestamp:
259
        raise InvalidBlock
260
    if header.number != parent_header.number + Uint(1):
261
        raise InvalidBlock
262
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
263
        raise InvalidBlock
264
    if len(header.extra_data) > 32:
265
        raise InvalidBlock
266
267
    block_difficulty = calculate_block_difficulty(
268
        header.number,
269
        header.timestamp,
270
        parent_header.timestamp,
271
        parent_header.difficulty,
272
    )
273
    if header.difficulty != block_difficulty:
274
        raise InvalidBlock
275
276
    block_parent_hash = keccak256(rlp.encode(parent_header))
277
    if header.parent_hash != block_parent_hash:
278
        raise InvalidBlock
279
280
    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:
284
    <snip>
307
    header_data_without_pow_artefacts = (
308
        header.parent_hash,
309
        header.ommers_hash,
310
        header.coinbase,
311
        header.state_root,
312
        header.transactions_root,
313
        header.receipt_root,
314
        header.bloom,
315
        header.difficulty,
316
        header.number,
317
        header.gas_limit,
318
        header.gas_used,
319
        header.timestamp,
320
        header.extra_data,
321
    )
322
323
    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:
327
    <snip>
342
    header_hash = generate_header_hash_for_pow(header)
343
    # TODO: Memoize this somewhere and read from that data instead of
344
    # calculating cache for every block validation.
345
    cache = generate_cache(header.number)
346
    mix_digest, result = hashimoto_light(
347
        header_hash, header.nonce, cache, dataset_size(header.number)
348
    )
349
    if mix_digest != header.mix_digest:
350
        raise InvalidBlock
351
352
    limit = Uint(U256.MAX_VALUE) + Uint(1)
353
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
354
        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.tangerine_whistle.vm.BlockEnvironmentethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​block_output: ethereum.forks.tangerine_whistle.vm.BlockOutputethereum.forks.spurious_dragon.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
363
    <snip>
394
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
395
    if tx.gas > gas_available:
396
        raise GasUsedExceedsLimitError("gas used exceeds limit")
395
    sender_address = recover_sender(tx)
397
    sender_address = recover_sender(block_env.chain_id, tx)
398
    sender_account = get_account(tx_state, sender_address)
399
400
    max_gas_fee = tx.gas * tx.gas_price
401
402
    if sender_account.nonce > Uint(tx.nonce):
403
        raise NonceMismatchError("nonce too low")
404
    elif sender_account.nonce < Uint(tx.nonce):
405
        raise NonceMismatchError("nonce too high")
406
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
407
        raise InsufficientBalanceError("insufficient sender balance")
408
    if sender_account.code_hash != EMPTY_CODE_HASH:
409
        raise InvalidSenderError("not EOA")
410
411
    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:
419
    <snip>
438
    receipt = Receipt(
439
        post_state=post_state,
440
        cumulative_gas_used=cumulative_gas_used,
441
        bloom=logs_bloom(logs),
442
        logs=logs,
443
    )
444
445
    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.tangerine_whistle.vm.BlockEnvironmentethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.tangerine_whistle.vm.BlockOutputethereum.forks.spurious_dragon.vm.BlockOutput:
453
    <snip>
479
    block_output = vm.BlockOutput()
480
481
    for i, tx in enumerate(transactions):
482
        process_transaction(block_env, block_output, tx, Uint(i))
483
484
    pay_rewards(block_env, ommers)
485
486
    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:
492
    <snip>
514
    block_hash = keccak256(rlp.encode(block_header))
515
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
516
        raise InvalidBlock
517
518
    if len(ommers) == 0:
519
        # Nothing to validate
520
        return
521
522
    # Check that each ommer satisfies the constraints of a header
523
    for ommer in ommers:
524
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
525
            raise InvalidBlock
526
        validate_header(chain, ommer)
527
    if len(ommers) > 2:
528
        raise InvalidBlock
529
530
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
531
    if len(ommers_hashes) != len(set(ommers_hashes)):
532
        raise InvalidBlock
533
534
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
535
    recent_canonical_block_hashes = {
536
        keccak256(rlp.encode(block.header))
537
        for block in recent_canonical_blocks
538
    }
539
    recent_ommers_hashes: Set[Hash32] = set()
540
    for block in recent_canonical_blocks:
541
        recent_ommers_hashes = recent_ommers_hashes.union(
542
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
543
        )
544
545
    for ommer_index, ommer in enumerate(ommers):
546
        ommer_hash = ommers_hashes[ommer_index]
547
        if ommer_hash == block_hash:
548
            raise InvalidBlock
549
        if ommer_hash in recent_canonical_block_hashes:
550
            raise InvalidBlock
551
        if ommer_hash in recent_ommers_hashes:
552
            raise InvalidBlock
553
554
        # Ommer age with respect to the current block. For example, an age of
555
        # 1 indicates that the ommer is a sibling of previous block.
556
        ommer_age = block_header.number - ommer.number
557
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
558
            raise InvalidBlock
559
        if ommer.parent_hash not in recent_canonical_block_hashes:
560
            raise InvalidBlock
561
        if ommer.parent_hash == block_header.parent_hash:
562
            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.tangerine_whistle.vm.BlockEnvironmentethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
569
    <snip>
591
    rewards_state = TransactionState(parent=block_env.state)
592
    ommer_count = U256(len(ommers))
593
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
594
    create_ether(rewards_state, block_env.coinbase, miner_reward)
595
596
    for ommer in ommers:
597
        # Ommer age with respect to the current block.
598
        ommer_age = U256(block_env.number - ommer.number)
599
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
600
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
601
602
    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.tangerine_whistle.vm.BlockEnvironmentethereum.forks.spurious_dragon.vm.BlockEnvironment, ​​block_output: ethereum.forks.tangerine_whistle.vm.BlockOutputethereum.forks.spurious_dragon.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
611
    <snip>
635
    tx_state = TransactionState(parent=block_env.state)
636
637
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
638
    intrinsic_gas = validate_transaction(tx)
639
640
    sender = check_transaction(
641
        block_env=block_env,
642
        block_output=block_output,
643
        tx=tx,
644
        tx_state=tx_state,
645
    )
646
647
    sender_account = get_account(tx_state, sender)
648
649
    gas = tx.gas - intrinsic_gas
650
    increment_nonce(tx_state, sender)
651
652
    gas_fee = tx.gas * tx.gas_price
653
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
654
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
655
656
    tx_env = vm.TransactionEnvironment(
657
        origin=sender,
658
        gas_price=tx.gas_price,
659
        gas=gas,
660
        state=tx_state,
661
        index_in_block=index,
662
        tx_hash=get_transaction_hash(tx),
663
    )
664
665
    message = prepare_message(block_env, tx_env, tx)
666
667
    tx_output = process_message_call(message)
668
669
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
670
    tx_gas_refund = min(
671
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
672
    )
673
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
674
    tx_gas_left = tx.gas - tx_gas_used_after_refund
675
    gas_refund_amount = tx_gas_left * tx.gas_price
676
677
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
678
679
    # refund gas
680
    create_ether(tx_state, sender, U256(gas_refund_amount))
681
682
    # transfer miner fees
681
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
683
    coinbase_balance_after_mining_fee = get_account(
684
        tx_state, block_env.coinbase
685
    ).balance + U256(transaction_fee)
686
    if coinbase_balance_after_mining_fee != 0:
687
        set_account_balance(
688
            tx_state,
689
            block_env.coinbase,
690
            coinbase_balance_after_mining_fee,
691
        )
692
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
693
        destroy_account(tx_state, block_env.coinbase)
694
695
    for address in tx_output.accounts_to_delete:
696
        destroy_account(tx_state, address)
697
698
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
699
700
    block_output.block_gas_used += tx_gas_used_after_refund
701
702
    incorporate_tx_into_block(tx_state)
703
704
    block_state = block_env.state
705
    block_diff = extract_block_diff(block_state)
706
    intermediate_state_root, _ = (
707
        block_state.pre_state.compute_state_root_and_trie_changes(
708
            block_diff.account_changes,
709
            block_diff.storage_changes,
710
            block_diff.storage_clears,
711
        )
712
    )
713
714
    receipt = make_receipt(
715
        intermediate_state_root,
716
        block_output.block_gas_used,
717
        tx_output.logs,
718
    )
719
720
    receipt_key = rlp.encode(Uint(index))
721
    block_output.receipt_keys += (receipt_key,)
722
723
    trie_set(
724
        block_output.receipts_trie,
725
        receipt_key,
726
        receipt,
727
    )
728
729
    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:
733
    <snip>
761
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
762
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
763
        return False
764
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
765
        return False
766
    if gas_limit < GasCosts.LIMIT_MINIMUM:
767
        return False
768
769
    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:
778
    <snip>
815
    offset = (
816
        int(parent_difficulty)
817
        // 2048
818
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
819
    )
820
    difficulty = int(parent_difficulty) + offset
821
    # Historical Note: The difficulty bomb was not present in Ethereum at the
822
    # start of Frontier, but was added shortly after launch. However since the
823
    # bomb has no effect prior to block 200000 we pretend it existed from
824
    # genesis.
825
    # See https://github.com/ethereum/go-ethereum/pull/1588
826
    num_bomb_periods = (int(block_number) // 100000) - 2
827
    if num_bomb_periods >= 0:
828
        difficulty += 2**num_bomb_periods
829
830
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
831
    # the bomb. This bug does not matter because the difficulty is always much
832
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
833
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))