ethereum.forks.dao_fork.forkethereum.forks.tangerine_whistle.fork

Ethereum Specification.

.. _dao-fork:

.. 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
@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.is used to handle the irregularity. See the :ref:DAO Fork <dao-fork> for an example.

The DAO-Fork occurred as a result of the 2016 DAO Hacks <https://www.gemini.com/cryptopedia/the-dao-hack-makerdao>_ in which an unknown entity managed to drain more than 3.6 million ether causing the price of ether to drop by nearly 35%. This fork was the solution to the hacks and manually reset the affected parties' accounts to their state prior to the attack. This fork essentially rewrote the history of the Ethereum network.

Parameters

old : Previous block chain object.

Returns

new : BlockChain Upgraded block chain object for this hard fork.

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