ethereum.forks.tangerine_whistle.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

MINIMUM_DIFFICULTY

59
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

60
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

63
@final
64
@dataclass
class BlockChain:

blocks

70
    blocks: List[Block]

state

71
    state: State

chain_id

72
    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:
76
    <snip>
95
    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]:
99
    <snip>
119
    recent_blocks = chain.blocks[-255:]
120
    if len(recent_blocks) == 0:
121
        return []
122
123
    recent_block_hashes = []
124
125
    for block in recent_blocks:
126
        prev_block_hash = block.header.parent_hash
127
        recent_block_hashes.append(prev_block_hash)
128
129
    # We are computing the hash only for the most recent block and not for
130
    # the rest of the blocks as they have successors which have the hash of
131
    # the current block as parent hash.
132
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
133
    recent_block_hashes.append(most_recent_block_hash)
134
135
    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:
139
    <snip>
161
    validate_header(chain, block.header)
162
    validate_ommers(block.ommers, block.header, chain)
163
164
    block_state = BlockState(pre_state=chain.state)
165
166
    block_env = vm.BlockEnvironment(
167
        chain_id=chain.chain_id,
168
        state=block_state,
169
        block_gas_limit=block.header.gas_limit,
170
        block_hashes=get_last_256_block_hashes(chain),
171
        coinbase=block.header.coinbase,
172
        number=block.header.number,
173
        time=block.header.timestamp,
174
        difficulty=block.header.difficulty,
175
    )
176
177
    block_output = apply_body(
178
        block_env=block_env,
179
        transactions=block.transactions,
180
        ommers=block.ommers,
181
    )
182
    block_diff = extract_block_diff(block_state)
183
    block_state_root = chain.state.compute_state_root(block_diff)
184
    transactions_root = root(block_output.transactions_trie)
185
    receipt_root = root(block_output.receipts_trie)
186
    block_logs_bloom = logs_bloom(block_output.block_logs)
187
188
    if block_output.block_gas_used != block.header.gas_used:
189
        raise InvalidBlock(
190
            f"{block_output.block_gas_used} != {block.header.gas_used}"
191
        )
192
    if transactions_root != block.header.transactions_root:
193
        raise InvalidBlock
194
    if block_state_root != block.header.state_root:
195
        raise InvalidBlock
196
    if receipt_root != block.header.receipt_root:
197
        raise InvalidBlock
198
    if block_logs_bloom != block.header.bloom:
199
        raise InvalidBlock
200
201
    apply_changes_to_state(chain.state, block_diff)
202
    chain.blocks.append(block)
203
    if len(chain.blocks) > 255:
204
        # Real clients have to store more blocks to deal with reorgs, but the
205
        # protocol only requires the last 255
206
        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:
210
    <snip>
228
    if header.number < Uint(1):
229
        raise InvalidBlock
230
    parent_header_number = header.number - Uint(1)
231
    first_block_number = chain.blocks[0].header.number
232
    last_block_number = chain.blocks[-1].header.number
233
234
    if (
235
        parent_header_number < first_block_number
236
        or parent_header_number > last_block_number
237
    ):
238
        raise InvalidBlock
239
240
    parent_header = chain.blocks[
241
        parent_header_number - first_block_number
242
    ].header
243
244
    if header.gas_used > header.gas_limit:
245
        raise InvalidBlock
246
247
    if header.timestamp <= parent_header.timestamp:
248
        raise InvalidBlock
249
    if header.number != parent_header.number + Uint(1):
250
        raise InvalidBlock
251
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
252
        raise InvalidBlock
253
    if len(header.extra_data) > 32:
254
        raise InvalidBlock
255
256
    block_difficulty = calculate_block_difficulty(
257
        header.number,
258
        header.timestamp,
259
        parent_header.timestamp,
260
        parent_header.difficulty,
261
    )
262
    if header.difficulty != block_difficulty:
263
        raise InvalidBlock
264
265
    block_parent_hash = keccak256(rlp.encode(parent_header))
266
    if header.parent_hash != block_parent_hash:
267
        raise InvalidBlock
268
269
    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:
273
    <snip>
296
    header_data_without_pow_artefacts = (
297
        header.parent_hash,
298
        header.ommers_hash,
299
        header.coinbase,
300
        header.state_root,
301
        header.transactions_root,
302
        header.receipt_root,
303
        header.bloom,
304
        header.difficulty,
305
        header.number,
306
        header.gas_limit,
307
        header.gas_used,
308
        header.timestamp,
309
        header.extra_data,
310
    )
311
312
    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:
316
    <snip>
331
    header_hash = generate_header_hash_for_pow(header)
332
    # TODO: Memoize this somewhere and read from that data instead of
333
    # calculating cache for every block validation.
334
    cache = generate_cache(header.number)
335
    mix_digest, result = hashimoto_light(
336
        header_hash, header.nonce, cache, dataset_size(header.number)
337
    )
338
    if mix_digest != header.mix_digest:
339
        raise InvalidBlock
340
341
    limit = Uint(U256.MAX_VALUE) + Uint(1)
342
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
343
        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.BlockEnvironment, ​​block_output: ethereum.forks.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
352
    <snip>
383
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
384
    if tx.gas > gas_available:
385
        raise GasUsedExceedsLimitError("gas used exceeds limit")
386
    sender_address = recover_sender(tx)
387
    sender_account = get_account(tx_state, sender_address)
388
389
    max_gas_fee = tx.gas * tx.gas_price
390
391
    if sender_account.nonce > Uint(tx.nonce):
392
        raise NonceMismatchError("nonce too low")
393
    elif sender_account.nonce < Uint(tx.nonce):
394
        raise NonceMismatchError("nonce too high")
395
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
396
        raise InsufficientBalanceError("insufficient sender balance")
397
    if sender_account.code_hash != EMPTY_CODE_HASH:
398
        raise InvalidSenderError("not EOA")
399
400
    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:
408
    <snip>
427
    receipt = Receipt(
428
        post_state=post_state,
429
        cumulative_gas_used=cumulative_gas_used,
430
        bloom=logs_bloom(logs),
431
        logs=logs,
432
    )
433
434
    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.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.tangerine_whistle.vm.BlockOutput:
442
    <snip>
468
    block_output = vm.BlockOutput()
469
470
    for i, tx in enumerate(transactions):
471
        process_transaction(block_env, block_output, tx, Uint(i))
472
473
    pay_rewards(block_env, ommers)
474
475
    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:
481
    <snip>
503
    block_hash = keccak256(rlp.encode(block_header))
504
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
505
        raise InvalidBlock
506
507
    if len(ommers) == 0:
508
        # Nothing to validate
509
        return
510
511
    # Check that each ommer satisfies the constraints of a header
512
    for ommer in ommers:
513
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
514
            raise InvalidBlock
515
        validate_header(chain, ommer)
516
    if len(ommers) > 2:
517
        raise InvalidBlock
518
519
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
520
    if len(ommers_hashes) != len(set(ommers_hashes)):
521
        raise InvalidBlock
522
523
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
524
    recent_canonical_block_hashes = {
525
        keccak256(rlp.encode(block.header))
526
        for block in recent_canonical_blocks
527
    }
528
    recent_ommers_hashes: Set[Hash32] = set()
529
    for block in recent_canonical_blocks:
530
        recent_ommers_hashes = recent_ommers_hashes.union(
531
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
532
        )
533
534
    for ommer_index, ommer in enumerate(ommers):
535
        ommer_hash = ommers_hashes[ommer_index]
536
        if ommer_hash == block_hash:
537
            raise InvalidBlock
538
        if ommer_hash in recent_canonical_block_hashes:
539
            raise InvalidBlock
540
        if ommer_hash in recent_ommers_hashes:
541
            raise InvalidBlock
542
543
        # Ommer age with respect to the current block. For example, an age of
544
        # 1 indicates that the ommer is a sibling of previous block.
545
        ommer_age = block_header.number - ommer.number
546
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
547
            raise InvalidBlock
548
        if ommer.parent_hash not in recent_canonical_block_hashes:
549
            raise InvalidBlock
550
        if ommer.parent_hash == block_header.parent_hash:
551
            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.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
558
    <snip>
580
    rewards_state = TransactionState(parent=block_env.state)
581
    ommer_count = U256(len(ommers))
582
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
583
    create_ether(rewards_state, block_env.coinbase, miner_reward)
584
585
    for ommer in ommers:
586
        # Ommer age with respect to the current block.
587
        ommer_age = U256(block_env.number - ommer.number)
588
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
589
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
590
591
    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.BlockEnvironment, ​​block_output: ethereum.forks.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
600
    <snip>
624
    tx_state = TransactionState(parent=block_env.state)
625
626
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
627
    intrinsic_gas = validate_transaction(tx)
628
629
    sender = check_transaction(
630
        block_env=block_env,
631
        block_output=block_output,
632
        tx=tx,
633
        tx_state=tx_state,
634
    )
635
636
    sender_account = get_account(tx_state, sender)
637
638
    gas = tx.gas - intrinsic_gas
639
    increment_nonce(tx_state, sender)
640
641
    gas_fee = tx.gas * tx.gas_price
642
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
643
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
644
645
    tx_env = vm.TransactionEnvironment(
646
        origin=sender,
647
        gas_price=tx.gas_price,
648
        gas=gas,
649
        state=tx_state,
650
        index_in_block=index,
651
        tx_hash=get_transaction_hash(tx),
652
    )
653
654
    message = prepare_message(block_env, tx_env, tx)
655
656
    tx_output = process_message_call(message)
657
658
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
659
    tx_gas_refund = min(
660
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
661
    )
662
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
663
    tx_gas_left = tx.gas - tx_gas_used_after_refund
664
    gas_refund_amount = tx_gas_left * tx.gas_price
665
666
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
667
668
    # refund gas
669
    create_ether(tx_state, sender, U256(gas_refund_amount))
670
671
    # transfer miner fees
672
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
673
674
    for address in tx_output.accounts_to_delete:
675
        destroy_account(tx_state, address)
676
677
    block_output.block_gas_used += tx_gas_used_after_refund
678
679
    incorporate_tx_into_block(tx_state)
680
681
    block_state = block_env.state
682
    block_diff = extract_block_diff(block_state)
683
    intermediate_state_root = block_state.pre_state.compute_state_root(
684
        block_diff
685
    )
686
687
    receipt = make_receipt(
688
        intermediate_state_root,
689
        block_output.block_gas_used,
690
        tx_output.logs,
691
    )
692
693
    receipt_key = rlp.encode(Uint(index))
694
    block_output.receipt_keys += (receipt_key,)
695
696
    trie_set(
697
        block_output.receipts_trie,
698
        receipt_key,
699
        receipt,
700
    )
701
702
    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:
706
    <snip>
734
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
735
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
736
        return False
737
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
738
        return False
739
    if gas_limit < GasCosts.LIMIT_MINIMUM:
740
        return False
741
742
    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:
751
    <snip>
788
    offset = (
789
        int(parent_difficulty)
790
        // 2048
791
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
792
    )
793
    difficulty = int(parent_difficulty) + offset
794
    # Historical Note: The difficulty bomb was not present in Ethereum at the
795
    # start of Frontier, but was added shortly after launch. However since the
796
    # bomb has no effect prior to block 200000 we pretend it existed from
797
    # genesis.
798
    # See https://github.com/ethereum/go-ethereum/pull/1588
799
    num_bomb_periods = (int(block_number) // 100000) - 2
800
    if num_bomb_periods >= 0:
801
        difficulty += 2**num_bomb_periods
802
803
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
804
    # the bomb. This bug does not matter because the difficulty is always much
805
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
806
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))