ethereum.forks.homestead.forkethereum.forks.dao_fork.fork

Ethereum Specification.

.. _dao-fork:

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

MINIMUM_DIFFICULTY

67
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

68
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

71
@final
72
@dataclass
class BlockChain:

blocks

78
    blocks: List[Block]

state

79
    state: State

chain_id

80
    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.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:
84
    <snip>
110
    apply_dao(old.state)
111
    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]:
115
    <snip>
135
    recent_blocks = chain.blocks[-255:]
136
    # TODO: This function has not been tested rigorously
137
    if len(recent_blocks) == 0:
138
        return []
139
140
    recent_block_hashes = []
141
142
    for block in recent_blocks:
143
        prev_block_hash = block.header.parent_hash
144
        recent_block_hashes.append(prev_block_hash)
145
146
    # We are computing the hash only for the most recent block and not for
147
    # the rest of the blocks as they have successors which have the hash of
148
    # the current block as parent hash.
149
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
150
    recent_block_hashes.append(most_recent_block_hash)
151
152
    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:
156
    <snip>
178
    validate_header(chain, block.header)
179
    validate_ommers(block.ommers, block.header, chain)
180
181
    block_state = BlockState(pre_state=chain.state)
182
183
    block_env = vm.BlockEnvironment(
184
        chain_id=chain.chain_id,
185
        state=block_state,
186
        block_gas_limit=block.header.gas_limit,
187
        block_hashes=get_last_256_block_hashes(chain),
188
        coinbase=block.header.coinbase,
189
        number=block.header.number,
190
        time=block.header.timestamp,
191
        difficulty=block.header.difficulty,
192
    )
193
194
    block_output = apply_body(
195
        block_env=block_env,
196
        transactions=block.transactions,
197
        ommers=block.ommers,
198
    )
199
    block_diff = extract_block_diff(block_state)
200
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
201
        block_diff.account_changes,
202
        block_diff.storage_changes,
203
        block_diff.storage_clears,
204
    )
205
    transactions_root = root(block_output.transactions_trie)
206
    receipt_root = root(block_output.receipts_trie)
207
    block_logs_bloom = logs_bloom(block_output.block_logs)
208
209
    if block_output.block_gas_used != block.header.gas_used:
210
        raise InvalidBlock(
211
            f"{block_output.block_gas_used} != {block.header.gas_used}"
212
        )
213
    if transactions_root != block.header.transactions_root:
214
        raise InvalidBlock
215
    if block_state_root != block.header.state_root:
216
        raise InvalidBlock
217
    if receipt_root != block.header.receipt_root:
218
        raise InvalidBlock
219
    if block_logs_bloom != block.header.bloom:
220
        raise InvalidBlock
221
222
    apply_changes_to_state(chain.state, block_diff)
223
    chain.blocks.append(block)
224
    if len(chain.blocks) > 255:
225
        # Real clients have to store more blocks to deal with reorgs, but the
226
        # protocol only requires the last 255
227
        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:
231
    <snip>
249
    if header.number < Uint(1):
250
        raise InvalidBlock
251
    parent_header_number = header.number - Uint(1)
252
    first_block_number = chain.blocks[0].header.number
253
    last_block_number = chain.blocks[-1].header.number
254
255
    if (
256
        parent_header_number < first_block_number
257
        or parent_header_number > last_block_number
258
    ):
259
        raise InvalidBlock
260
261
    parent_header = chain.blocks[
262
        parent_header_number - first_block_number
263
    ].header
264
265
    if header.gas_used > header.gas_limit:
266
        raise InvalidBlock
267
268
    if header.timestamp <= parent_header.timestamp:
269
        raise InvalidBlock
270
    if header.number != parent_header.number + Uint(1):
271
        raise InvalidBlock
272
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
273
        raise InvalidBlock
274
    if len(header.extra_data) > 32:
275
        raise InvalidBlock
276
277
    block_difficulty = calculate_block_difficulty(
278
        header.number,
279
        header.timestamp,
280
        parent_header.timestamp,
281
        parent_header.difficulty,
282
    )
283
    if header.difficulty != block_difficulty:
284
        raise InvalidBlock
285
286
    block_parent_hash = keccak256(rlp.encode(parent_header))
287
    if header.parent_hash != block_parent_hash:
288
        raise InvalidBlock
289
290
    assert isinstance(, ByBlockNumber)
291
292
    if (
293
        header.number >= .block_number
294
        and header.number < .block_number + Uint(10)
295
    ):
296
        if header.extra_data != b"dao-hard-fork":
297
            raise InvalidBlock
298
299
    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:
303
    <snip>
326
    header_data_without_pow_artefacts = (
327
        header.parent_hash,
328
        header.ommers_hash,
329
        header.coinbase,
330
        header.state_root,
331
        header.transactions_root,
332
        header.receipt_root,
333
        header.bloom,
334
        header.difficulty,
335
        header.number,
336
        header.gas_limit,
337
        header.gas_used,
338
        header.timestamp,
339
        header.extra_data,
340
    )
341
342
    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:
346
    <snip>
361
    header_hash = generate_header_hash_for_pow(header)
362
    # TODO: Memoize this somewhere and read from that data instead of
363
    # calculating cache for every block validation.
364
    cache = generate_cache(header.number)
365
    mix_digest, result = hashimoto_light(
366
        header_hash, header.nonce, cache, dataset_size(header.number)
367
    )
368
    if mix_digest != header.mix_digest:
369
        raise InvalidBlock
370
371
    limit = Uint(U256.MAX_VALUE) + Uint(1)
372
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
373
        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.homestead.vm.BlockEnvironmentethereum.forks.dao_fork.vm.BlockEnvironment, ​​block_output: ethereum.forks.homestead.vm.BlockOutputethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
382
    <snip>
413
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
414
    if tx.gas > gas_available:
415
        raise GasUsedExceedsLimitError("gas used exceeds limit")
416
    sender_address = recover_sender(tx)
417
    sender_account = get_account(tx_state, sender_address)
418
419
    max_gas_fee = tx.gas * tx.gas_price
420
421
    if sender_account.nonce > Uint(tx.nonce):
422
        raise NonceMismatchError("nonce too low")
423
    elif sender_account.nonce < Uint(tx.nonce):
424
        raise NonceMismatchError("nonce too high")
425
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
426
        raise InsufficientBalanceError("insufficient sender balance")
427
    if sender_account.code_hash != EMPTY_CODE_HASH:
428
        raise InvalidSenderError("not EOA")
429
430
    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:
438
    <snip>
457
    receipt = Receipt(
458
        post_state=post_state,
459
        cumulative_gas_used=cumulative_gas_used,
460
        bloom=logs_bloom(logs),
461
        logs=logs,
462
    )
463
464
    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.homestead.vm.BlockEnvironmentethereum.forks.dao_fork.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.homestead.vm.BlockOutputethereum.forks.dao_fork.vm.BlockOutput:
472
    <snip>
498
    block_output = vm.BlockOutput()
499
500
    for i, tx in enumerate(transactions):
501
        process_transaction(block_env, block_output, tx, Uint(i))
502
503
    pay_rewards(block_env, ommers)
504
505
    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:
511
    <snip>
533
    block_hash = keccak256(rlp.encode(block_header))
534
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
535
        raise InvalidBlock
536
537
    if len(ommers) == 0:
538
        # Nothing to validate
539
        return
540
541
    # Check that each ommer satisfies the constraints of a header
542
    for ommer in ommers:
543
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
544
            raise InvalidBlock
545
        validate_header(chain, ommer)
546
    if len(ommers) > 2:
547
        raise InvalidBlock
548
549
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
550
    if len(ommers_hashes) != len(set(ommers_hashes)):
551
        raise InvalidBlock
552
553
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
554
    recent_canonical_block_hashes = {
555
        keccak256(rlp.encode(block.header))
556
        for block in recent_canonical_blocks
557
    }
558
    recent_ommers_hashes: Set[Hash32] = set()
559
    for block in recent_canonical_blocks:
560
        recent_ommers_hashes = recent_ommers_hashes.union(
561
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
562
        )
563
564
    for ommer_index, ommer in enumerate(ommers):
565
        ommer_hash = ommers_hashes[ommer_index]
566
        if ommer_hash == block_hash:
567
            raise InvalidBlock
568
        if ommer_hash in recent_canonical_block_hashes:
569
            raise InvalidBlock
570
        if ommer_hash in recent_ommers_hashes:
571
            raise InvalidBlock
572
573
        # Ommer age with respect to the current block. For example, an age of
574
        # 1 indicates that the ommer is a sibling of previous block.
575
        ommer_age = block_header.number - ommer.number
576
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
577
            raise InvalidBlock
578
        if ommer.parent_hash not in recent_canonical_block_hashes:
579
            raise InvalidBlock
580
        if ommer.parent_hash == block_header.parent_hash:
581
            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.homestead.vm.BlockEnvironmentethereum.forks.dao_fork.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
588
    <snip>
610
    rewards_state = TransactionState(parent=block_env.state)
611
    ommer_count = U256(len(ommers))
612
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
613
    create_ether(rewards_state, block_env.coinbase, miner_reward)
614
615
    for ommer in ommers:
616
        # Ommer age with respect to the current block.
617
        ommer_age = U256(block_env.number - ommer.number)
618
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
619
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
620
621
    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.homestead.vm.BlockEnvironmentethereum.forks.dao_fork.vm.BlockEnvironment, ​​block_output: ethereum.forks.homestead.vm.BlockOutputethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
630
    <snip>
654
    tx_state = TransactionState(parent=block_env.state)
655
656
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
657
    intrinsic_gas = validate_transaction(tx)
658
659
    sender = check_transaction(
660
        block_env=block_env,
661
        block_output=block_output,
662
        tx=tx,
663
        tx_state=tx_state,
664
    )
665
666
    sender_account = get_account(tx_state, sender)
667
668
    gas = tx.gas - intrinsic_gas
669
    increment_nonce(tx_state, sender)
670
671
    gas_fee = tx.gas * tx.gas_price
672
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
673
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
674
675
    tx_env = vm.TransactionEnvironment(
676
        origin=sender,
677
        gas_price=tx.gas_price,
678
        gas=gas,
679
        state=tx_state,
680
        index_in_block=index,
681
        tx_hash=get_transaction_hash(tx),
682
    )
683
684
    message = prepare_message(block_env, tx_env, tx)
685
686
    tx_output = process_message_call(message)
687
688
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
689
    tx_gas_refund = min(
690
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
691
    )
692
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
693
    tx_gas_left = tx.gas - tx_gas_used_after_refund
694
    gas_refund_amount = tx_gas_left * tx.gas_price
695
696
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
697
698
    # refund gas
699
    create_ether(tx_state, sender, U256(gas_refund_amount))
700
701
    # transfer miner fees
702
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
703
704
    for address in tx_output.accounts_to_delete:
705
        destroy_account(tx_state, address)
706
707
    block_output.block_gas_used += tx_gas_used_after_refund
708
709
    incorporate_tx_into_block(tx_state)
710
711
    block_state = block_env.state
712
    block_diff = extract_block_diff(block_state)
713
    intermediate_state_root, _ = (
714
        block_state.pre_state.compute_state_root_and_trie_changes(
715
            block_diff.account_changes,
716
            block_diff.storage_changes,
717
            block_diff.storage_clears,
718
        )
719
    )
720
721
    receipt = make_receipt(
722
        intermediate_state_root,
723
        block_output.block_gas_used,
724
        tx_output.logs,
725
    )
726
727
    receipt_key = rlp.encode(Uint(index))
728
    block_output.receipt_keys += (receipt_key,)
729
730
    trie_set(
731
        block_output.receipts_trie,
732
        receipt_key,
733
        receipt,
734
    )
735
736
    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:
740
    <snip>
768
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
769
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
770
        return False
771
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
772
        return False
773
    if gas_limit < GasCosts.LIMIT_MINIMUM:
774
        return False
775
776
    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:
785
    <snip>
822
    offset = (
823
        int(parent_difficulty)
824
        // 2048
825
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
826
    )
827
    difficulty = int(parent_difficulty) + offset
828
    # Historical Note: The difficulty bomb was not present in Ethereum at the
829
    # start of Frontier, but was added shortly after launch. However since the
830
    # bomb has no effect prior to block 200000 we pretend it existed from
831
    # genesis.
832
    # See https://github.com/ethereum/go-ethereum/pull/1588
833
    num_bomb_periods = (int(block_number) // 100000) - 2
834
    if num_bomb_periods >= 0:
835
        difficulty += 2**num_bomb_periods
836
837
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
838
    # the bomb. This bug does not matter because the difficulty is always much
839
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
840
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))