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

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

MINIMUM_DIFFICULTY

67
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

68
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

69
BOMB_DELAY_BLOCKS = 5000000
69
BOMB_DELAY_BLOCKS = 9000000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

73
@final
74
@dataclass
class BlockChain:

blocks

80
    blocks: List[Block]

state

81
    state: State

chain_id

82
    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:
86
    <snip>
105
    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]:
109
    <snip>
129
    recent_blocks = chain.blocks[-255:]
130
    # TODO: This function has not been tested rigorously
131
    if len(recent_blocks) == 0:
132
        return []
133
134
    recent_block_hashes = []
135
136
    for block in recent_blocks:
137
        prev_block_hash = block.header.parent_hash
138
        recent_block_hashes.append(prev_block_hash)
139
140
    # We are computing the hash only for the most recent block and not for
141
    # the rest of the blocks as they have successors which have the hash of
142
    # the current block as parent hash.
143
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
144
    recent_block_hashes.append(most_recent_block_hash)
145
146
    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:
150
    <snip>
172
    validate_header(chain, block.header)
173
    validate_ommers(block.ommers, block.header, chain)
174
175
    block_state = BlockState(pre_state=chain.state)
176
177
    block_env = vm.BlockEnvironment(
178
        chain_id=chain.chain_id,
179
        state=block_state,
180
        block_gas_limit=block.header.gas_limit,
181
        block_hashes=get_last_256_block_hashes(chain),
182
        coinbase=block.header.coinbase,
183
        number=block.header.number,
184
        time=block.header.timestamp,
185
        difficulty=block.header.difficulty,
186
    )
187
188
    block_output = apply_body(
189
        block_env=block_env,
190
        transactions=block.transactions,
191
        ommers=block.ommers,
192
    )
193
    block_diff = extract_block_diff(block_state)
194
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
195
        block_diff.account_changes,
196
        block_diff.storage_changes,
197
        block_diff.storage_clears,
198
    )
199
    transactions_root = root(block_output.transactions_trie)
200
    receipt_root = root(block_output.receipts_trie)
201
    block_logs_bloom = logs_bloom(block_output.block_logs)
202
203
    if block_output.block_gas_used != block.header.gas_used:
204
        raise InvalidBlock(
205
            f"{block_output.block_gas_used} != {block.header.gas_used}"
206
        )
207
    if transactions_root != block.header.transactions_root:
208
        raise InvalidBlock
209
    if block_state_root != block.header.state_root:
210
        raise InvalidBlock
211
    if receipt_root != block.header.receipt_root:
212
        raise InvalidBlock
213
    if block_logs_bloom != block.header.bloom:
214
        raise InvalidBlock
215
216
    apply_changes_to_state(chain.state, block_diff)
217
    chain.blocks.append(block)
218
    if len(chain.blocks) > 255:
219
        # Real clients have to store more blocks to deal with reorgs, but the
220
        # protocol only requires the last 255
221
        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:
225
    <snip>
243
    if header.number < Uint(1):
244
        raise InvalidBlock
245
    parent_header_number = header.number - Uint(1)
246
    first_block_number = chain.blocks[0].header.number
247
    last_block_number = chain.blocks[-1].header.number
248
249
    if (
250
        parent_header_number < first_block_number
251
        or parent_header_number > last_block_number
252
    ):
253
        raise InvalidBlock
254
255
    parent_header = chain.blocks[
256
        parent_header_number - first_block_number
257
    ].header
258
259
    if header.gas_used > header.gas_limit:
260
        raise InvalidBlock
261
262
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
263
    if header.timestamp <= parent_header.timestamp:
264
        raise InvalidBlock
265
    if header.number != parent_header.number + Uint(1):
266
        raise InvalidBlock
267
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
268
        raise InvalidBlock
269
    if len(header.extra_data) > 32:
270
        raise InvalidBlock
271
272
    block_difficulty = calculate_block_difficulty(
273
        header.number,
274
        header.timestamp,
275
        parent_header.timestamp,
276
        parent_header.difficulty,
277
        parent_has_ommers,
278
    )
279
    if header.difficulty != block_difficulty:
280
        raise InvalidBlock
281
282
    block_parent_hash = keccak256(rlp.encode(parent_header))
283
    if header.parent_hash != block_parent_hash:
284
        raise InvalidBlock
285
286
    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:
290
    <snip>
313
    header_data_without_pow_artefacts = (
314
        header.parent_hash,
315
        header.ommers_hash,
316
        header.coinbase,
317
        header.state_root,
318
        header.transactions_root,
319
        header.receipt_root,
320
        header.bloom,
321
        header.difficulty,
322
        header.number,
323
        header.gas_limit,
324
        header.gas_used,
325
        header.timestamp,
326
        header.extra_data,
327
    )
328
329
    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:
333
    <snip>
348
    header_hash = generate_header_hash_for_pow(header)
349
    # TODO: Memoize this somewhere and read from that data instead of
350
    # calculating cache for every block validation.
351
    cache = generate_cache(header.number)
352
    mix_digest, result = hashimoto_light(
353
        header_hash, header.nonce, cache, dataset_size(header.number)
354
    )
355
    if mix_digest != header.mix_digest:
356
        raise InvalidBlock
357
358
    limit = Uint(U256.MAX_VALUE) + Uint(1)
359
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
360
        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:
369
    <snip>
400
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
401
    if tx.gas > gas_available:
402
        raise GasUsedExceedsLimitError("gas used exceeds limit")
403
    tx_chain_id = chain_id(tx)
404
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
405
        raise WrongChainIdError(
406
            expected=block_env.chain_id,
407
            actual=tx_chain_id,
408
        )
409
410
    sender_address = recover_sender(tx)
411
    sender_account = get_account(tx_state, sender_address)
412
413
    max_gas_fee = tx.gas * tx.gas_price
414
415
    if sender_account.nonce > Uint(tx.nonce):
416
        raise NonceMismatchError("nonce too low")
417
    elif sender_account.nonce < Uint(tx.nonce):
418
        raise NonceMismatchError("nonce too high")
419
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
420
        raise InsufficientBalanceError("insufficient sender balance")
421
    if sender_account.code_hash != EMPTY_CODE_HASH:
422
        raise InvalidSenderError("not EOA")
423
424
    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:
432
    <snip>
453
    receipt = Receipt(
454
        succeeded=error is None,
455
        cumulative_gas_used=cumulative_gas_used,
456
        bloom=logs_bloom(logs),
457
        logs=logs,
458
    )
459
460
    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:
468
    <snip>
494
    block_output = vm.BlockOutput()
495
496
    for i, tx in enumerate(transactions):
497
        process_transaction(block_env, block_output, tx, Uint(i))
498
499
    pay_rewards(block_env, ommers)
500
501
    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:
507
    <snip>
529
    block_hash = keccak256(rlp.encode(block_header))
530
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
531
        raise InvalidBlock
532
533
    if len(ommers) == 0:
534
        # Nothing to validate
535
        return
536
537
    # Check that each ommer satisfies the constraints of a header
538
    for ommer in ommers:
539
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
540
            raise InvalidBlock
541
        validate_header(chain, ommer)
542
    if len(ommers) > 2:
543
        raise InvalidBlock
544
545
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
546
    if len(ommers_hashes) != len(set(ommers_hashes)):
547
        raise InvalidBlock
548
549
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
550
    recent_canonical_block_hashes = {
551
        keccak256(rlp.encode(block.header))
552
        for block in recent_canonical_blocks
553
    }
554
    recent_ommers_hashes: Set[Hash32] = set()
555
    for block in recent_canonical_blocks:
556
        recent_ommers_hashes = recent_ommers_hashes.union(
557
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
558
        )
559
560
    for ommer_index, ommer in enumerate(ommers):
561
        ommer_hash = ommers_hashes[ommer_index]
562
        if ommer_hash == block_hash:
563
            raise InvalidBlock
564
        if ommer_hash in recent_canonical_block_hashes:
565
            raise InvalidBlock
566
        if ommer_hash in recent_ommers_hashes:
567
            raise InvalidBlock
568
569
        # Ommer age with respect to the current block. For example, an age of
570
        # 1 indicates that the ommer is a sibling of previous block.
571
        ommer_age = block_header.number - ommer.number
572
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
573
            raise InvalidBlock
574
        if ommer.parent_hash not in recent_canonical_block_hashes:
575
            raise InvalidBlock
576
        if ommer.parent_hash == block_header.parent_hash:
577
            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:
584
    <snip>
606
    rewards_state = TransactionState(parent=block_env.state)
607
    ommer_count = U256(len(ommers))
608
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
609
    create_ether(rewards_state, block_env.coinbase, miner_reward)
610
611
    for ommer in ommers:
612
        # Ommer age with respect to the current block.
613
        ommer_age = U256(block_env.number - ommer.number)
614
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
615
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
616
617
    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:
626
    <snip>
650
    tx_state = TransactionState(parent=block_env.state)
651
652
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
653
    intrinsic_gas = validate_transaction(tx)
654
655
    sender = check_transaction(
656
        block_env=block_env,
657
        block_output=block_output,
658
        tx=tx,
659
        tx_state=tx_state,
660
    )
661
662
    sender_account = get_account(tx_state, sender)
663
664
    gas = tx.gas - intrinsic_gas
665
    increment_nonce(tx_state, sender)
666
667
    gas_fee = tx.gas * tx.gas_price
668
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
669
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
670
671
    tx_env = vm.TransactionEnvironment(
672
        origin=sender,
673
        gas_price=tx.gas_price,
674
        gas=gas,
675
        state=tx_state,
676
        index_in_block=index,
677
        tx_hash=get_transaction_hash(tx),
678
    )
679
680
    message = prepare_message(block_env, tx_env, tx)
681
682
    tx_output = process_message_call(message)
683
684
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
685
    tx_gas_refund = min(
686
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
687
    )
688
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
689
    tx_gas_left = tx.gas - tx_gas_used_after_refund
690
    gas_refund_amount = tx_gas_left * tx.gas_price
691
692
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
693
694
    # refund gas
695
    create_ether(tx_state, sender, U256(gas_refund_amount))
696
697
    # transfer miner fees
698
    coinbase_balance_after_mining_fee = get_account(
699
        tx_state, block_env.coinbase
700
    ).balance + U256(transaction_fee)
701
    if coinbase_balance_after_mining_fee != 0:
702
        set_account_balance(
703
            tx_state,
704
            block_env.coinbase,
705
            coinbase_balance_after_mining_fee,
706
        )
707
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
708
        destroy_account(tx_state, block_env.coinbase)
709
710
    for address in tx_output.accounts_to_delete:
711
        destroy_account(tx_state, address)
712
713
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
714
715
    block_output.block_gas_used += tx_gas_used_after_refund
716
717
    receipt = make_receipt(
718
        tx_output.error, block_output.block_gas_used, tx_output.logs
719
    )
720
721
    receipt_key = rlp.encode(Uint(index))
722
    block_output.receipt_keys += (receipt_key,)
723
724
    trie_set(
725
        block_output.receipts_trie,
726
        receipt_key,
727
        receipt,
728
    )
729
730
    block_output.block_logs += tx_output.logs
731
732
    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:
736
    <snip>
764
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
765
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
766
        return False
767
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
768
        return False
769
    if gas_limit < GasCosts.LIMIT_MINIMUM:
770
        return False
771
772
    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:
782
    <snip>
821
    offset = (
822
        int(parent_difficulty)
823
        // 2048
824
        * max(
825
            (2 if parent_has_ommers else 1)
826
            - int(block_timestamp - parent_timestamp) // 9,
827
            -99,
828
        )
829
    )
830
    difficulty = int(parent_difficulty) + offset
831
    # Historical Note: The difficulty bomb was not present in Ethereum at the
832
    # start of Frontier, but was added shortly after launch. However since the
833
    # bomb has no effect prior to block 200000 we pretend it existed from
834
    # genesis.
835
    # See https://github.com/ethereum/go-ethereum/pull/1588
836
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
837
    if num_bomb_periods >= 0:
838
        difficulty += 2**num_bomb_periods
839
840
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
841
    # the bomb. This bug does not matter because the difficulty is always much
842
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
843
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))