ethereum.forks.istanbul.forkethereum.forks.muir_glacier.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

64
BLOCK_REWARD = U256(2 * 10**18)

MINIMUM_DIFFICULTY

65
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

66
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

67
BOMB_DELAY_BLOCKS = 5000000
67
BOMB_DELAY_BLOCKS = 9000000

EMPTY_OMMER_HASH

68
EMPTY_OMMER_HASH = keccak256(rlp.encode([]))

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.

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>
103
    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]:
107
    <snip>
127
    recent_blocks = chain.blocks[-255:]
128
    # TODO: This function has not been tested rigorously
129
    if len(recent_blocks) == 0:
130
        return []
131
132
    recent_block_hashes = []
133
134
    for block in recent_blocks:
135
        prev_block_hash = block.header.parent_hash
136
        recent_block_hashes.append(prev_block_hash)
137
138
    # We are computing the hash only for the most recent block and not for
139
    # the rest of the blocks as they have successors which have the hash of
140
    # the current block as parent hash.
141
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
142
    recent_block_hashes.append(most_recent_block_hash)
143
144
    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:
148
    <snip>
170
    validate_header(chain, block.header)
171
    validate_ommers(block.ommers, block.header, chain)
172
173
    block_state = BlockState(pre_state=chain.state)
174
175
    block_env = vm.BlockEnvironment(
176
        chain_id=chain.chain_id,
177
        state=block_state,
178
        block_gas_limit=block.header.gas_limit,
179
        block_hashes=get_last_256_block_hashes(chain),
180
        coinbase=block.header.coinbase,
181
        number=block.header.number,
182
        time=block.header.timestamp,
183
        difficulty=block.header.difficulty,
184
    )
185
186
    block_output = apply_body(
187
        block_env=block_env,
188
        transactions=block.transactions,
189
        ommers=block.ommers,
190
    )
191
    block_diff = extract_block_diff(block_state)
192
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
193
        block_diff.account_changes,
194
        block_diff.storage_changes,
195
        block_diff.storage_clears,
196
    )
197
    transactions_root = root(block_output.transactions_trie)
198
    receipt_root = root(block_output.receipts_trie)
199
    block_logs_bloom = logs_bloom(block_output.block_logs)
200
201
    if block_output.block_gas_used != block.header.gas_used:
202
        raise InvalidBlock(
203
            f"{block_output.block_gas_used} != {block.header.gas_used}"
204
        )
205
    if transactions_root != block.header.transactions_root:
206
        raise InvalidBlock
207
    if block_state_root != block.header.state_root:
208
        raise InvalidBlock
209
    if receipt_root != block.header.receipt_root:
210
        raise InvalidBlock
211
    if block_logs_bloom != block.header.bloom:
212
        raise InvalidBlock
213
214
    apply_changes_to_state(chain.state, block_diff)
215
    chain.blocks.append(block)
216
    if len(chain.blocks) > 255:
217
        # Real clients have to store more blocks to deal with reorgs, but the
218
        # protocol only requires the last 255
219
        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:
223
    <snip>
241
    if header.number < Uint(1):
242
        raise InvalidBlock
243
    parent_header_number = header.number - Uint(1)
244
    first_block_number = chain.blocks[0].header.number
245
    last_block_number = chain.blocks[-1].header.number
246
247
    if (
248
        parent_header_number < first_block_number
249
        or parent_header_number > last_block_number
250
    ):
251
        raise InvalidBlock
252
253
    parent_header = chain.blocks[
254
        parent_header_number - first_block_number
255
    ].header
256
257
    if header.gas_used > header.gas_limit:
258
        raise InvalidBlock
259
260
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
261
    if header.timestamp <= parent_header.timestamp:
262
        raise InvalidBlock
263
    if header.number != parent_header.number + Uint(1):
264
        raise InvalidBlock
265
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
266
        raise InvalidBlock
267
    if len(header.extra_data) > 32:
268
        raise InvalidBlock
269
270
    block_difficulty = calculate_block_difficulty(
271
        header.number,
272
        header.timestamp,
273
        parent_header.timestamp,
274
        parent_header.difficulty,
275
        parent_has_ommers,
276
    )
277
    if header.difficulty != block_difficulty:
278
        raise InvalidBlock
279
280
    block_parent_hash = keccak256(rlp.encode(parent_header))
281
    if header.parent_hash != block_parent_hash:
282
        raise InvalidBlock
283
284
    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:
288
    <snip>
311
    header_data_without_pow_artefacts = (
312
        header.parent_hash,
313
        header.ommers_hash,
314
        header.coinbase,
315
        header.state_root,
316
        header.transactions_root,
317
        header.receipt_root,
318
        header.bloom,
319
        header.difficulty,
320
        header.number,
321
        header.gas_limit,
322
        header.gas_used,
323
        header.timestamp,
324
        header.extra_data,
325
    )
326
327
    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:
331
    <snip>
346
    header_hash = generate_header_hash_for_pow(header)
347
    # TODO: Memoize this somewhere and read from that data instead of
348
    # calculating cache for every block validation.
349
    cache = generate_cache(header.number)
350
    mix_digest, result = hashimoto_light(
351
        header_hash, header.nonce, cache, dataset_size(header.number)
352
    )
353
    if mix_digest != header.mix_digest:
354
        raise InvalidBlock
355
356
    limit = Uint(U256.MAX_VALUE) + Uint(1)
357
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
358
        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.istanbul.vm.BlockEnvironmentethereum.forks.muir_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.istanbul.vm.BlockOutputethereum.forks.muir_glacier.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
367
    <snip>
398
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
399
    if tx.gas > gas_available:
400
        raise GasUsedExceedsLimitError("gas used exceeds limit")
401
    sender_address = recover_sender(block_env.chain_id, tx)
402
    sender_account = get_account(tx_state, sender_address)
403
404
    max_gas_fee = tx.gas * tx.gas_price
405
406
    if sender_account.nonce > Uint(tx.nonce):
407
        raise NonceMismatchError("nonce too low")
408
    elif sender_account.nonce < Uint(tx.nonce):
409
        raise NonceMismatchError("nonce too high")
410
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
411
        raise InsufficientBalanceError("insufficient sender balance")
412
    if sender_account.code_hash != EMPTY_CODE_HASH:
413
        raise InvalidSenderError("not EOA")
414
415
    return sender_address

make_receipt

Make the receipt for a transaction that was executed.

Parameters

tx : The executed transaction. error : Error in the top level frame of the transaction, if any. 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(error: Optional[EthereumException], ​​cumulative_gas_used: Uint, ​​logs: Tuple[Log, ...]) -> Receipt:
423
    <snip>
444
    receipt = Receipt(
445
        succeeded=error is None,
446
        cumulative_gas_used=cumulative_gas_used,
447
        bloom=logs_bloom(logs),
448
        logs=logs,
449
    )
450
451
    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.istanbul.vm.BlockEnvironmentethereum.forks.muir_glacier.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.istanbul.vm.BlockOutputethereum.forks.muir_glacier.vm.BlockOutput:
459
    <snip>
485
    block_output = vm.BlockOutput()
486
487
    for i, tx in enumerate(transactions):
488
        process_transaction(block_env, block_output, tx, Uint(i))
489
490
    pay_rewards(block_env, ommers)
491
492
    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:
498
    <snip>
520
    block_hash = keccak256(rlp.encode(block_header))
521
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
522
        raise InvalidBlock
523
524
    if len(ommers) == 0:
525
        # Nothing to validate
526
        return
527
528
    # Check that each ommer satisfies the constraints of a header
529
    for ommer in ommers:
530
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
531
            raise InvalidBlock
532
        validate_header(chain, ommer)
533
    if len(ommers) > 2:
534
        raise InvalidBlock
535
536
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
537
    if len(ommers_hashes) != len(set(ommers_hashes)):
538
        raise InvalidBlock
539
540
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
541
    recent_canonical_block_hashes = {
542
        keccak256(rlp.encode(block.header))
543
        for block in recent_canonical_blocks
544
    }
545
    recent_ommers_hashes: Set[Hash32] = set()
546
    for block in recent_canonical_blocks:
547
        recent_ommers_hashes = recent_ommers_hashes.union(
548
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
549
        )
550
551
    for ommer_index, ommer in enumerate(ommers):
552
        ommer_hash = ommers_hashes[ommer_index]
553
        if ommer_hash == block_hash:
554
            raise InvalidBlock
555
        if ommer_hash in recent_canonical_block_hashes:
556
            raise InvalidBlock
557
        if ommer_hash in recent_ommers_hashes:
558
            raise InvalidBlock
559
560
        # Ommer age with respect to the current block. For example, an age of
561
        # 1 indicates that the ommer is a sibling of previous block.
562
        ommer_age = block_header.number - ommer.number
563
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
564
            raise InvalidBlock
565
        if ommer.parent_hash not in recent_canonical_block_hashes:
566
            raise InvalidBlock
567
        if ommer.parent_hash == block_header.parent_hash:
568
            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.istanbul.vm.BlockEnvironmentethereum.forks.muir_glacier.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
575
    <snip>
597
    rewards_state = TransactionState(parent=block_env.state)
598
    ommer_count = U256(len(ommers))
599
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
600
    create_ether(rewards_state, block_env.coinbase, miner_reward)
601
602
    for ommer in ommers:
603
        # Ommer age with respect to the current block.
604
        ommer_age = U256(block_env.number - ommer.number)
605
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
606
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
607
608
    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.istanbul.vm.BlockEnvironmentethereum.forks.muir_glacier.vm.BlockEnvironment, ​​block_output: ethereum.forks.istanbul.vm.BlockOutputethereum.forks.muir_glacier.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
617
    <snip>
641
    tx_state = TransactionState(parent=block_env.state)
642
643
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
644
    intrinsic_gas = validate_transaction(tx)
645
646
    sender = check_transaction(
647
        block_env=block_env,
648
        block_output=block_output,
649
        tx=tx,
650
        tx_state=tx_state,
651
    )
652
653
    sender_account = get_account(tx_state, sender)
654
655
    gas = tx.gas - intrinsic_gas
656
    increment_nonce(tx_state, sender)
657
658
    gas_fee = tx.gas * tx.gas_price
659
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
660
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
661
662
    tx_env = vm.TransactionEnvironment(
663
        origin=sender,
664
        gas_price=tx.gas_price,
665
        gas=gas,
666
        state=tx_state,
667
        index_in_block=index,
668
        tx_hash=get_transaction_hash(tx),
669
    )
670
671
    message = prepare_message(block_env, tx_env, tx)
672
673
    tx_output = process_message_call(message)
674
675
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
676
    tx_gas_refund = min(
677
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
678
    )
679
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
680
    tx_gas_left = tx.gas - tx_gas_used_after_refund
681
    gas_refund_amount = tx_gas_left * tx.gas_price
682
683
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
684
685
    # refund gas
686
    create_ether(tx_state, sender, U256(gas_refund_amount))
687
688
    # transfer miner fees
689
    coinbase_balance_after_mining_fee = get_account(
690
        tx_state, block_env.coinbase
691
    ).balance + U256(transaction_fee)
692
    if coinbase_balance_after_mining_fee != 0:
693
        set_account_balance(
694
            tx_state,
695
            block_env.coinbase,
696
            coinbase_balance_after_mining_fee,
697
        )
698
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
699
        destroy_account(tx_state, block_env.coinbase)
700
701
    for address in tx_output.accounts_to_delete:
702
        destroy_account(tx_state, address)
703
704
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
705
706
    block_output.block_gas_used += tx_gas_used_after_refund
707
708
    receipt = make_receipt(
709
        tx_output.error, block_output.block_gas_used, tx_output.logs
710
    )
711
712
    receipt_key = rlp.encode(Uint(index))
713
    block_output.receipt_keys += (receipt_key,)
714
715
    trie_set(
716
        block_output.receipts_trie,
717
        receipt_key,
718
        receipt,
719
    )
720
721
    block_output.block_logs += tx_output.logs
722
723
    incorporate_tx_into_block(tx_state)

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. parent_has_ommers: does the parent have ommers.

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, ​​parent_has_ommers: bool) -> Uint:
773
    <snip>
812
    offset = (
813
        int(parent_difficulty)
814
        // 2048
815
        * max(
816
            (2 if parent_has_ommers else 1)
817
            - int(block_timestamp - parent_timestamp) // 9,
818
            -99,
819
        )
820
    )
821
    difficulty = int(parent_difficulty) + offset
822
    # Historical Note: The difficulty bomb was not present in Ethereum at the
823
    # start of Frontier, but was added shortly after launch. However since the
824
    # bomb has no effect prior to block 200000 we pretend it existed from
825
    # genesis.
826
    # See https://github.com/ethereum/go-ethereum/pull/1588
827
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
828
    if num_bomb_periods >= 0:
829
        difficulty += 2**num_bomb_periods
830
831
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
832
    # the bomb. This bug does not matter because the difficulty is always much
833
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
834
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))