ethereum.forks.byzantium.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

62
BLOCK_REWARD = U256(3 * 10**18)

MINIMUM_DIFFICULTY

63
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

64
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

65
BOMB_DELAY_BLOCKS = 3000000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

69
@final
70
@dataclass
class BlockChain:

blocks

76
    blocks: List[Block]

state

77
    state: State

chain_id

78
    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:
82
    <snip>
101
    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]:
105
    <snip>
125
    recent_blocks = chain.blocks[-255:]
126
    if len(recent_blocks) == 0:
127
        return []
128
129
    recent_block_hashes = []
130
131
    for block in recent_blocks:
132
        prev_block_hash = block.header.parent_hash
133
        recent_block_hashes.append(prev_block_hash)
134
135
    # We are computing the hash only for the most recent block and not for
136
    # the rest of the blocks as they have successors which have the hash of
137
    # the current block as parent hash.
138
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
139
    recent_block_hashes.append(most_recent_block_hash)
140
141
    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:
145
    <snip>
167
    validate_header(chain, block.header)
168
    validate_ommers(block.ommers, block.header, chain)
169
170
    block_state = BlockState(pre_state=chain.state)
171
172
    block_env = vm.BlockEnvironment(
173
        chain_id=chain.chain_id,
174
        state=block_state,
175
        block_gas_limit=block.header.gas_limit,
176
        block_hashes=get_last_256_block_hashes(chain),
177
        coinbase=block.header.coinbase,
178
        number=block.header.number,
179
        time=block.header.timestamp,
180
        difficulty=block.header.difficulty,
181
    )
182
183
    block_output = apply_body(
184
        block_env=block_env,
185
        transactions=block.transactions,
186
        ommers=block.ommers,
187
    )
188
    block_diff = extract_block_diff(block_state)
189
    block_state_root = chain.state.compute_state_root(block_diff)
190
    transactions_root = root(block_output.transactions_trie)
191
    receipt_root = root(block_output.receipts_trie)
192
    block_logs_bloom = logs_bloom(block_output.block_logs)
193
194
    if block_output.block_gas_used != block.header.gas_used:
195
        raise InvalidBlock(
196
            f"{block_output.block_gas_used} != {block.header.gas_used}"
197
        )
198
    if transactions_root != block.header.transactions_root:
199
        raise InvalidBlock
200
    if block_state_root != block.header.state_root:
201
        raise InvalidBlock
202
    if receipt_root != block.header.receipt_root:
203
        raise InvalidBlock
204
    if block_logs_bloom != block.header.bloom:
205
        raise InvalidBlock
206
207
    apply_changes_to_state(chain.state, block_diff)
208
    chain.blocks.append(block)
209
    if len(chain.blocks) > 255:
210
        # Real clients have to store more blocks to deal with reorgs, but the
211
        # protocol only requires the last 255
212
        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:
216
    <snip>
234
    if header.number < Uint(1):
235
        raise InvalidBlock
236
    parent_header_number = header.number - Uint(1)
237
    first_block_number = chain.blocks[0].header.number
238
    last_block_number = chain.blocks[-1].header.number
239
240
    if (
241
        parent_header_number < first_block_number
242
        or parent_header_number > last_block_number
243
    ):
244
        raise InvalidBlock
245
246
    parent_header = chain.blocks[
247
        parent_header_number - first_block_number
248
    ].header
249
250
    if header.gas_used > header.gas_limit:
251
        raise InvalidBlock
252
253
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
254
    if header.timestamp <= parent_header.timestamp:
255
        raise InvalidBlock
256
    if header.number != parent_header.number + Uint(1):
257
        raise InvalidBlock
258
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
259
        raise InvalidBlock
260
    if len(header.extra_data) > 32:
261
        raise InvalidBlock
262
263
    block_difficulty = calculate_block_difficulty(
264
        header.number,
265
        header.timestamp,
266
        parent_header.timestamp,
267
        parent_header.difficulty,
268
        parent_has_ommers,
269
    )
270
    if header.difficulty != block_difficulty:
271
        raise InvalidBlock
272
273
    block_parent_hash = keccak256(rlp.encode(parent_header))
274
    if header.parent_hash != block_parent_hash:
275
        raise InvalidBlock
276
277
    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:
281
    <snip>
304
    header_data_without_pow_artefacts = (
305
        header.parent_hash,
306
        header.ommers_hash,
307
        header.coinbase,
308
        header.state_root,
309
        header.transactions_root,
310
        header.receipt_root,
311
        header.bloom,
312
        header.difficulty,
313
        header.number,
314
        header.gas_limit,
315
        header.gas_used,
316
        header.timestamp,
317
        header.extra_data,
318
    )
319
320
    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:
324
    <snip>
339
    header_hash = generate_header_hash_for_pow(header)
340
    # TODO: Memoize this somewhere and read from that data instead of
341
    # calculating cache for every block validation.
342
    cache = generate_cache(header.number)
343
    mix_digest, result = hashimoto_light(
344
        header_hash, header.nonce, cache, dataset_size(header.number)
345
    )
346
    if mix_digest != header.mix_digest:
347
        raise InvalidBlock
348
349
    limit = Uint(U256.MAX_VALUE) + Uint(1)
350
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
351
        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.byzantium.vm.BlockEnvironment, ​​block_output: ethereum.forks.byzantium.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
360
    <snip>
391
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
392
    if tx.gas > gas_available:
393
        raise GasUsedExceedsLimitError("gas used exceeds limit")
394
    tx_chain_id = chain_id(tx)
395
    if tx_chain_id is not None and tx_chain_id != block_env.chain_id:
396
        raise WrongChainIdError(
397
            expected=block_env.chain_id,
398
            actual=tx_chain_id,
399
        )
400
401
    sender_address = recover_sender(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

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>
442
    receipt = Receipt(
443
        succeeded=error is None,
444
        cumulative_gas_used=cumulative_gas_used,
445
        bloom=logs_bloom(logs),
446
        logs=logs,
447
    )
448
449
    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.byzantium.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.byzantium.vm.BlockOutput:
457
    <snip>
483
    block_output = vm.BlockOutput()
484
485
    for i, tx in enumerate(transactions):
486
        process_transaction(block_env, block_output, tx, Uint(i))
487
488
    pay_rewards(block_env, ommers)
489
490
    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:
496
    <snip>
518
    block_hash = keccak256(rlp.encode(block_header))
519
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
520
        raise InvalidBlock
521
522
    if len(ommers) == 0:
523
        # Nothing to validate
524
        return
525
526
    # Check that each ommer satisfies the constraints of a header
527
    for ommer in ommers:
528
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
529
            raise InvalidBlock
530
        validate_header(chain, ommer)
531
    if len(ommers) > 2:
532
        raise InvalidBlock
533
534
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
535
    if len(ommers_hashes) != len(set(ommers_hashes)):
536
        raise InvalidBlock
537
538
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
539
    recent_canonical_block_hashes = {
540
        keccak256(rlp.encode(block.header))
541
        for block in recent_canonical_blocks
542
    }
543
    recent_ommers_hashes: Set[Hash32] = set()
544
    for block in recent_canonical_blocks:
545
        recent_ommers_hashes = recent_ommers_hashes.union(
546
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
547
        )
548
549
    for ommer_index, ommer in enumerate(ommers):
550
        ommer_hash = ommers_hashes[ommer_index]
551
        if ommer_hash == block_hash:
552
            raise InvalidBlock
553
        if ommer_hash in recent_canonical_block_hashes:
554
            raise InvalidBlock
555
        if ommer_hash in recent_ommers_hashes:
556
            raise InvalidBlock
557
558
        # Ommer age with respect to the current block. For example, an age of
559
        # 1 indicates that the ommer is a sibling of previous block.
560
        ommer_age = block_header.number - ommer.number
561
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
562
            raise InvalidBlock
563
        if ommer.parent_hash not in recent_canonical_block_hashes:
564
            raise InvalidBlock
565
        if ommer.parent_hash == block_header.parent_hash:
566
            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.byzantium.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
573
    <snip>
595
    rewards_state = TransactionState(parent=block_env.state)
596
    ommer_count = U256(len(ommers))
597
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
598
    create_ether(rewards_state, block_env.coinbase, miner_reward)
599
600
    for ommer in ommers:
601
        # Ommer age with respect to the current block.
602
        ommer_age = U256(block_env.number - ommer.number)
603
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
604
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
605
606
    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.byzantium.vm.BlockEnvironment, ​​block_output: ethereum.forks.byzantium.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
615
    <snip>
639
    tx_state = TransactionState(parent=block_env.state)
640
641
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
642
    intrinsic_gas = validate_transaction(tx)
643
644
    sender = check_transaction(
645
        block_env=block_env,
646
        block_output=block_output,
647
        tx=tx,
648
        tx_state=tx_state,
649
    )
650
651
    sender_account = get_account(tx_state, sender)
652
653
    gas = tx.gas - intrinsic_gas
654
    increment_nonce(tx_state, sender)
655
656
    gas_fee = tx.gas * tx.gas_price
657
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
658
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
659
660
    tx_env = vm.TransactionEnvironment(
661
        origin=sender,
662
        gas_price=tx.gas_price,
663
        gas=gas,
664
        state=tx_state,
665
        index_in_block=index,
666
        tx_hash=get_transaction_hash(tx),
667
    )
668
669
    message = prepare_message(block_env, tx_env, tx)
670
671
    tx_output = process_message_call(message)
672
673
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
674
    tx_gas_refund = min(
675
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
676
    )
677
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
678
    tx_gas_left = tx.gas - tx_gas_used_after_refund
679
    gas_refund_amount = tx_gas_left * tx.gas_price
680
681
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
682
683
    # refund gas
684
    create_ether(tx_state, sender, U256(gas_refund_amount))
685
686
    # transfer miner fees
687
    coinbase_balance_after_mining_fee = get_account(
688
        tx_state, block_env.coinbase
689
    ).balance + U256(transaction_fee)
690
    if coinbase_balance_after_mining_fee != 0:
691
        set_account_balance(
692
            tx_state,
693
            block_env.coinbase,
694
            coinbase_balance_after_mining_fee,
695
        )
696
    elif account_exists_and_is_empty(tx_state, block_env.coinbase):
697
        destroy_account(tx_state, block_env.coinbase)
698
699
    for address in tx_output.accounts_to_delete:
700
        destroy_account(tx_state, address)
701
702
    destroy_touched_empty_accounts(tx_state, tx_output.touched_accounts)
703
704
    block_output.block_gas_used += tx_gas_used_after_refund
705
706
    receipt = make_receipt(
707
        tx_output.error, block_output.block_gas_used, tx_output.logs
708
    )
709
710
    receipt_key = rlp.encode(Uint(index))
711
    block_output.receipt_keys += (receipt_key,)
712
713
    trie_set(
714
        block_output.receipts_trie,
715
        receipt_key,
716
        receipt,
717
    )
718
719
    block_output.block_logs += tx_output.logs
720
721
    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:
725
    <snip>
753
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
754
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
755
        return False
756
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
757
        return False
758
    if gas_limit < GasCosts.LIMIT_MINIMUM:
759
        return False
760
761
    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:
771
    <snip>
810
    offset = (
811
        int(parent_difficulty)
812
        // 2048
813
        * max(
814
            (2 if parent_has_ommers else 1)
815
            - int(block_timestamp - parent_timestamp) // 9,
816
            -99,
817
        )
818
    )
819
    difficulty = int(parent_difficulty) + offset
820
    # Historical Note: The difficulty bomb was not present in Ethereum at the
821
    # start of Frontier, but was added shortly after launch. However since the
822
    # bomb has no effect prior to block 200000 we pretend it existed from
823
    # genesis.
824
    # See https://github.com/ethereum/go-ethereum/pull/1588
825
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
826
    if num_bomb_periods >= 0:
827
        difficulty += 2**num_bomb_periods
828
829
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
830
    # the bomb. This bug does not matter because the difficulty is always much
831
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
832
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))