ethereum.forks.dao_fork.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
@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.

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:
80
    <snip>
106
    apply_dao(old.state)
107
    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]:
111
    <snip>
131
    recent_blocks = chain.blocks[-255:]
132
    if len(recent_blocks) == 0:
133
        return []
134
135
    recent_block_hashes = []
136
137
    for block in recent_blocks:
138
        prev_block_hash = block.header.parent_hash
139
        recent_block_hashes.append(prev_block_hash)
140
141
    # We are computing the hash only for the most recent block and not for
142
    # the rest of the blocks as they have successors which have the hash of
143
    # the current block as parent hash.
144
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
145
    recent_block_hashes.append(most_recent_block_hash)
146
147
    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:
151
    <snip>
173
    validate_header(chain, block.header)
174
    validate_ommers(block.ommers, block.header, chain)
175
176
    block_state = BlockState(pre_state=chain.state)
177
178
    block_env = vm.BlockEnvironment(
179
        chain_id=chain.chain_id,
180
        state=block_state,
181
        block_gas_limit=block.header.gas_limit,
182
        block_hashes=get_last_256_block_hashes(chain),
183
        coinbase=block.header.coinbase,
184
        number=block.header.number,
185
        time=block.header.timestamp,
186
        difficulty=block.header.difficulty,
187
    )
188
189
    block_output = apply_body(
190
        block_env=block_env,
191
        transactions=block.transactions,
192
        ommers=block.ommers,
193
    )
194
    block_diff = extract_block_diff(block_state)
195
    block_state_root = chain.state.compute_state_root(block_diff)
196
    transactions_root = root(block_output.transactions_trie)
197
    receipt_root = root(block_output.receipts_trie)
198
    block_logs_bloom = logs_bloom(block_output.block_logs)
199
200
    if block_output.block_gas_used != block.header.gas_used:
201
        raise InvalidBlock(
202
            f"{block_output.block_gas_used} != {block.header.gas_used}"
203
        )
204
    if transactions_root != block.header.transactions_root:
205
        raise InvalidBlock
206
    if block_state_root != block.header.state_root:
207
        raise InvalidBlock
208
    if receipt_root != block.header.receipt_root:
209
        raise InvalidBlock
210
    if block_logs_bloom != block.header.bloom:
211
        raise InvalidBlock
212
213
    apply_changes_to_state(chain.state, block_diff)
214
    chain.blocks.append(block)
215
    if len(chain.blocks) > 255:
216
        # Real clients have to store more blocks to deal with reorgs, but the
217
        # protocol only requires the last 255
218
        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:
222
    <snip>
240
    if header.number < Uint(1):
241
        raise InvalidBlock
242
    parent_header_number = header.number - Uint(1)
243
    first_block_number = chain.blocks[0].header.number
244
    last_block_number = chain.blocks[-1].header.number
245
246
    if (
247
        parent_header_number < first_block_number
248
        or parent_header_number > last_block_number
249
    ):
250
        raise InvalidBlock
251
252
    parent_header = chain.blocks[
253
        parent_header_number - first_block_number
254
    ].header
255
256
    if header.gas_used > header.gas_limit:
257
        raise InvalidBlock
258
259
    if header.timestamp <= parent_header.timestamp:
260
        raise InvalidBlock
261
    if header.number != parent_header.number + Uint(1):
262
        raise InvalidBlock
263
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
264
        raise InvalidBlock
265
    if len(header.extra_data) > 32:
266
        raise InvalidBlock
267
268
    block_difficulty = calculate_block_difficulty(
269
        header.number,
270
        header.timestamp,
271
        parent_header.timestamp,
272
        parent_header.difficulty,
273
    )
274
    if header.difficulty != block_difficulty:
275
        raise InvalidBlock
276
277
    block_parent_hash = keccak256(rlp.encode(parent_header))
278
    if header.parent_hash != block_parent_hash:
279
        raise InvalidBlock
280
281
    assert isinstance(FORK_CRITERIA, ByBlockNumber)
282
283
    if (
284
        header.number >= FORK_CRITERIA.block_number
285
        and header.number < FORK_CRITERIA.block_number + Uint(10)
286
    ):
287
        if header.extra_data != b"dao-hard-fork":
288
            raise InvalidBlock
289
290
    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:
294
    <snip>
317
    header_data_without_pow_artefacts = (
318
        header.parent_hash,
319
        header.ommers_hash,
320
        header.coinbase,
321
        header.state_root,
322
        header.transactions_root,
323
        header.receipt_root,
324
        header.bloom,
325
        header.difficulty,
326
        header.number,
327
        header.gas_limit,
328
        header.gas_used,
329
        header.timestamp,
330
        header.extra_data,
331
    )
332
333
    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:
337
    <snip>
352
    header_hash = generate_header_hash_for_pow(header)
353
    # TODO: Memoize this somewhere and read from that data instead of
354
    # calculating cache for every block validation.
355
    cache = generate_cache(header.number)
356
    mix_digest, result = hashimoto_light(
357
        header_hash, header.nonce, cache, dataset_size(header.number)
358
    )
359
    if mix_digest != header.mix_digest:
360
        raise InvalidBlock
361
362
    limit = Uint(U256.MAX_VALUE) + Uint(1)
363
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
364
        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.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
373
    <snip>
404
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
405
    if tx.gas > gas_available:
406
        raise GasUsedExceedsLimitError("gas used exceeds limit")
407
    sender_address = recover_sender(tx)
408
    sender_account = get_account(tx_state, sender_address)
409
410
    max_gas_fee = tx.gas * tx.gas_price
411
412
    if sender_account.nonce > Uint(tx.nonce):
413
        raise NonceMismatchError("nonce too low")
414
    elif sender_account.nonce < Uint(tx.nonce):
415
        raise NonceMismatchError("nonce too high")
416
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
417
        raise InsufficientBalanceError("insufficient sender balance")
418
    if sender_account.code_hash != EMPTY_CODE_HASH:
419
        raise InvalidSenderError("not EOA")
420
421
    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:
429
    <snip>
448
    receipt = Receipt(
449
        post_state=post_state,
450
        cumulative_gas_used=cumulative_gas_used,
451
        bloom=logs_bloom(logs),
452
        logs=logs,
453
    )
454
455
    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.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.dao_fork.vm.BlockOutput:
463
    <snip>
489
    block_output = vm.BlockOutput()
490
491
    for i, tx in enumerate(transactions):
492
        process_transaction(block_env, block_output, tx, Uint(i))
493
494
    pay_rewards(block_env, ommers)
495
496
    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:
502
    <snip>
524
    block_hash = keccak256(rlp.encode(block_header))
525
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
526
        raise InvalidBlock
527
528
    if len(ommers) == 0:
529
        # Nothing to validate
530
        return
531
532
    # Check that each ommer satisfies the constraints of a header
533
    for ommer in ommers:
534
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
535
            raise InvalidBlock
536
        validate_header(chain, ommer)
537
    if len(ommers) > 2:
538
        raise InvalidBlock
539
540
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
541
    if len(ommers_hashes) != len(set(ommers_hashes)):
542
        raise InvalidBlock
543
544
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
545
    recent_canonical_block_hashes = {
546
        keccak256(rlp.encode(block.header))
547
        for block in recent_canonical_blocks
548
    }
549
    recent_ommers_hashes: Set[Hash32] = set()
550
    for block in recent_canonical_blocks:
551
        recent_ommers_hashes = recent_ommers_hashes.union(
552
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
553
        )
554
555
    for ommer_index, ommer in enumerate(ommers):
556
        ommer_hash = ommers_hashes[ommer_index]
557
        if ommer_hash == block_hash:
558
            raise InvalidBlock
559
        if ommer_hash in recent_canonical_block_hashes:
560
            raise InvalidBlock
561
        if ommer_hash in recent_ommers_hashes:
562
            raise InvalidBlock
563
564
        # Ommer age with respect to the current block. For example, an age of
565
        # 1 indicates that the ommer is a sibling of previous block.
566
        ommer_age = block_header.number - ommer.number
567
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
568
            raise InvalidBlock
569
        if ommer.parent_hash not in recent_canonical_block_hashes:
570
            raise InvalidBlock
571
        if ommer.parent_hash == block_header.parent_hash:
572
            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.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
579
    <snip>
601
    rewards_state = TransactionState(parent=block_env.state)
602
    ommer_count = U256(len(ommers))
603
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
604
    create_ether(rewards_state, block_env.coinbase, miner_reward)
605
606
    for ommer in ommers:
607
        # Ommer age with respect to the current block.
608
        ommer_age = U256(block_env.number - ommer.number)
609
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
610
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
611
612
    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.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
621
    <snip>
645
    tx_state = TransactionState(parent=block_env.state)
646
647
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
648
    intrinsic_gas = validate_transaction(tx)
649
650
    sender = check_transaction(
651
        block_env=block_env,
652
        block_output=block_output,
653
        tx=tx,
654
        tx_state=tx_state,
655
    )
656
657
    sender_account = get_account(tx_state, sender)
658
659
    gas = tx.gas - intrinsic_gas
660
    increment_nonce(tx_state, sender)
661
662
    gas_fee = tx.gas * tx.gas_price
663
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
664
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
665
666
    tx_env = vm.TransactionEnvironment(
667
        origin=sender,
668
        gas_price=tx.gas_price,
669
        gas=gas,
670
        state=tx_state,
671
        index_in_block=index,
672
        tx_hash=get_transaction_hash(tx),
673
    )
674
675
    message = prepare_message(block_env, tx_env, tx)
676
677
    tx_output = process_message_call(message)
678
679
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
680
    tx_gas_refund = min(
681
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
682
    )
683
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
684
    tx_gas_left = tx.gas - tx_gas_used_after_refund
685
    gas_refund_amount = tx_gas_left * tx.gas_price
686
687
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
688
689
    # refund gas
690
    create_ether(tx_state, sender, U256(gas_refund_amount))
691
692
    # transfer miner fees
693
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
694
695
    for address in tx_output.accounts_to_delete:
696
        destroy_account(tx_state, address)
697
698
    block_output.block_gas_used += tx_gas_used_after_refund
699
700
    incorporate_tx_into_block(tx_state)
701
702
    block_state = block_env.state
703
    block_diff = extract_block_diff(block_state)
704
    intermediate_state_root = block_state.pre_state.compute_state_root(
705
        block_diff
706
    )
707
708
    receipt = make_receipt(
709
        intermediate_state_root,
710
        block_output.block_gas_used,
711
        tx_output.logs,
712
    )
713
714
    receipt_key = rlp.encode(Uint(index))
715
    block_output.receipt_keys += (receipt_key,)
716
717
    trie_set(
718
        block_output.receipts_trie,
719
        receipt_key,
720
        receipt,
721
    )
722
723
    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:
727
    <snip>
755
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
756
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
757
        return False
758
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
759
        return False
760
    if gas_limit < GasCosts.LIMIT_MINIMUM:
761
        return False
762
763
    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:
772
    <snip>
809
    offset = (
810
        int(parent_difficulty)
811
        // 2048
812
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
813
    )
814
    difficulty = int(parent_difficulty) + offset
815
    # Historical Note: The difficulty bomb was not present in Ethereum at the
816
    # start of Frontier, but was added shortly after launch. However since the
817
    # bomb has no effect prior to block 200000 we pretend it existed from
818
    # genesis.
819
    # See https://github.com/ethereum/go-ethereum/pull/1588
820
    num_bomb_periods = (int(block_number) // 100000) - 2
821
    if num_bomb_periods >= 0:
822
        difficulty += 2**num_bomb_periods
823
824
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
825
    # the bomb. This bug does not matter because the difficulty is always much
826
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
827
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))