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
@dataclass
class BlockChain:

blocks

77
    blocks: List[Block]

state

78
    state: State

chain_id

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