ethereum.forks.frontier.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

MINIMUM_DIFFICULTY

59
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

60
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

63
@final
64
@dataclass
class BlockChain:

blocks

70
    blocks: List[Block]

state

71
    state: State

chain_id

72
    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:
76
    <snip>
95
    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]:
99
    <snip>
119
    recent_blocks = chain.blocks[-255:]
120
    # TODO: This function has not been tested rigorously
121
    if len(recent_blocks) == 0:
122
        return []
123
124
    recent_block_hashes = []
125
126
    for block in recent_blocks:
127
        prev_block_hash = block.header.parent_hash
128
        recent_block_hashes.append(prev_block_hash)
129
130
    # We are computing the hash only for the most recent block and not for
131
    # the rest of the blocks as they have successors which have the hash of
132
    # the current block as parent hash.
133
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
134
    recent_block_hashes.append(most_recent_block_hash)
135
136
    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:
140
    <snip>
162
    validate_header(chain, block.header)
163
    validate_ommers(block.ommers, block.header, chain)
164
165
    block_state = BlockState(pre_state=chain.state)
166
167
    block_env = vm.BlockEnvironment(
168
        chain_id=chain.chain_id,
169
        state=block_state,
170
        block_gas_limit=block.header.gas_limit,
171
        block_hashes=get_last_256_block_hashes(chain),
172
        coinbase=block.header.coinbase,
173
        number=block.header.number,
174
        time=block.header.timestamp,
175
        difficulty=block.header.difficulty,
176
    )
177
178
    block_output = apply_body(
179
        block_env=block_env,
180
        transactions=block.transactions,
181
        ommers=block.ommers,
182
    )
183
    block_diff = extract_block_diff(block_state)
184
    block_state_root = chain.state.compute_state_root(block_diff)
185
    transactions_root = root(block_output.transactions_trie)
186
    receipt_root = root(block_output.receipts_trie)
187
    block_logs_bloom = logs_bloom(block_output.block_logs)
188
189
    if block_output.block_gas_used != block.header.gas_used:
190
        raise InvalidBlock(
191
            f"{block_output.block_gas_used} != {block.header.gas_used}"
192
        )
193
    if transactions_root != block.header.transactions_root:
194
        raise InvalidBlock
195
    if block_state_root != block.header.state_root:
196
        raise InvalidBlock
197
    if receipt_root != block.header.receipt_root:
198
        raise InvalidBlock
199
    if block_logs_bloom != block.header.bloom:
200
        raise InvalidBlock
201
202
    apply_changes_to_state(chain.state, block_diff)
203
    chain.blocks.append(block)
204
    if len(chain.blocks) > 255:
205
        # Real clients have to store more blocks to deal with reorgs, but the
206
        # protocol only requires the last 255
207
        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:
211
    <snip>
229
    if header.number < Uint(1):
230
        raise InvalidBlock
231
    parent_header_number = header.number - Uint(1)
232
    first_block_number = chain.blocks[0].header.number
233
    last_block_number = chain.blocks[-1].header.number
234
235
    if (
236
        parent_header_number < first_block_number
237
        or parent_header_number > last_block_number
238
    ):
239
        raise InvalidBlock
240
241
    parent_header = chain.blocks[
242
        parent_header_number - first_block_number
243
    ].header
244
245
    if header.gas_used > header.gas_limit:
246
        raise InvalidBlock
247
248
    if header.timestamp <= parent_header.timestamp:
249
        raise InvalidBlock
250
    if header.number != parent_header.number + Uint(1):
251
        raise InvalidBlock
252
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
253
        raise InvalidBlock
254
    if len(header.extra_data) > 32:
255
        raise InvalidBlock
256
257
    block_difficulty = calculate_block_difficulty(
258
        header.number,
259
        header.timestamp,
260
        parent_header.timestamp,
261
        parent_header.difficulty,
262
    )
263
    if header.difficulty != block_difficulty:
264
        raise InvalidBlock
265
266
    block_parent_hash = keccak256(rlp.encode(parent_header))
267
    if header.parent_hash != block_parent_hash:
268
        raise InvalidBlock
269
270
    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:
274
    <snip>
297
    header_data_without_pow_artefacts = (
298
        header.parent_hash,
299
        header.ommers_hash,
300
        header.coinbase,
301
        header.state_root,
302
        header.transactions_root,
303
        header.receipt_root,
304
        header.bloom,
305
        header.difficulty,
306
        header.number,
307
        header.gas_limit,
308
        header.gas_used,
309
        header.timestamp,
310
        header.extra_data,
311
    )
312
313
    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:
317
    <snip>
332
    header_hash = generate_header_hash_for_pow(header)
333
    # TODO: Memoize this somewhere and read from that data instead of
334
    # calculating cache for every block validation.
335
    cache = generate_cache(header.number)
336
    mix_digest, result = hashimoto_light(
337
        header_hash, header.nonce, cache, dataset_size(header.number)
338
    )
339
    if mix_digest != header.mix_digest:
340
        raise InvalidBlock
341
342
    limit = Uint(U256.MAX_VALUE) + Uint(1)
343
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
344
        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.frontier.vm.BlockEnvironment, ​​block_output: ethereum.forks.frontier.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Address:
353
    <snip>
384
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
385
    if tx.gas > gas_available:
386
        raise GasUsedExceedsLimitError("gas used exceeds limit")
387
    sender_address = recover_sender(tx)
388
    sender_account = get_account(tx_state, sender_address)
389
390
    max_gas_fee = tx.gas * tx.gas_price
391
392
    if sender_account.nonce > Uint(tx.nonce):
393
        raise NonceMismatchError("nonce too low")
394
    elif sender_account.nonce < Uint(tx.nonce):
395
        raise NonceMismatchError("nonce too high")
396
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
397
        raise InsufficientBalanceError("insufficient sender balance")
398
    if sender_account.code_hash != EMPTY_CODE_HASH:
399
        raise InvalidSenderError("not EOA")
400
401
    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:
409
    <snip>
428
    receipt = Receipt(
429
        post_state=post_state,
430
        cumulative_gas_used=cumulative_gas_used,
431
        bloom=logs_bloom(logs),
432
        logs=logs,
433
    )
434
435
    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.frontier.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.frontier.vm.BlockOutput:
443
    <snip>
469
    block_output = vm.BlockOutput()
470
471
    for i, tx in enumerate(transactions):
472
        process_transaction(block_env, block_output, tx, Uint(i))
473
474
    pay_rewards(block_env, ommers)
475
476
    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:
482
    <snip>
504
    block_hash = keccak256(rlp.encode(block_header))
505
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
506
        raise InvalidBlock
507
508
    if len(ommers) == 0:
509
        # Nothing to validate
510
        return
511
512
    # Check that each ommer satisfies the constraints of a header
513
    for ommer in ommers:
514
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
515
            raise InvalidBlock
516
        validate_header(chain, ommer)
517
    if len(ommers) > 2:
518
        raise InvalidBlock
519
520
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
521
    if len(ommers_hashes) != len(set(ommers_hashes)):
522
        raise InvalidBlock
523
524
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
525
    recent_canonical_block_hashes = {
526
        keccak256(rlp.encode(block.header))
527
        for block in recent_canonical_blocks
528
    }
529
    recent_ommers_hashes: Set[Hash32] = set()
530
    for block in recent_canonical_blocks:
531
        recent_ommers_hashes = recent_ommers_hashes.union(
532
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
533
        )
534
535
    for ommer_index, ommer in enumerate(ommers):
536
        ommer_hash = ommers_hashes[ommer_index]
537
        if ommer_hash == block_hash:
538
            raise InvalidBlock
539
        if ommer_hash in recent_canonical_block_hashes:
540
            raise InvalidBlock
541
        if ommer_hash in recent_ommers_hashes:
542
            raise InvalidBlock
543
544
        # Ommer age with respect to the current block. For example, an age of
545
        # 1 indicates that the ommer is a sibling of previous block.
546
        ommer_age = block_header.number - ommer.number
547
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
548
            raise InvalidBlock
549
        if ommer.parent_hash not in recent_canonical_block_hashes:
550
            raise InvalidBlock
551
        if ommer.parent_hash == block_header.parent_hash:
552
            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.frontier.vm.BlockEnvironment, ​​ommers: Tuple[Header, ...]) -> None:
559
    <snip>
581
    rewards_state = TransactionState(parent=block_env.state)
582
    ommer_count = U256(len(ommers))
583
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
584
    create_ether(rewards_state, block_env.coinbase, miner_reward)
585
586
    for ommer in ommers:
587
        # Ommer age with respect to the current block.
588
        ommer_age = U256(block_env.number - ommer.number)
589
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
590
        create_ether(rewards_state, ommer.coinbase, ommer_miner_reward)
591
592
    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.frontier.vm.BlockEnvironment, ​​block_output: ethereum.forks.frontier.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
601
    <snip>
625
    tx_state = TransactionState(parent=block_env.state)
626
627
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
628
    intrinsic_gas = validate_transaction(tx)
629
630
    sender = check_transaction(
631
        block_env=block_env,
632
        block_output=block_output,
633
        tx=tx,
634
        tx_state=tx_state,
635
    )
636
637
    sender_account = get_account(tx_state, sender)
638
639
    gas = tx.gas - intrinsic_gas
640
    increment_nonce(tx_state, sender)
641
642
    gas_fee = tx.gas * tx.gas_price
643
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
644
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
645
646
    tx_env = vm.TransactionEnvironment(
647
        origin=sender,
648
        gas_price=tx.gas_price,
649
        gas=gas,
650
        state=tx_state,
651
        index_in_block=index,
652
        tx_hash=get_transaction_hash(tx),
653
    )
654
655
    message = prepare_message(block_env, tx_env, tx)
656
657
    tx_output = process_message_call(message)
658
659
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
660
    tx_gas_refund = min(
661
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
662
    )
663
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
664
    tx_gas_left = tx.gas - tx_gas_used_after_refund
665
    gas_refund_amount = tx_gas_left * tx.gas_price
666
667
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
668
669
    # refund gas
670
    create_ether(tx_state, sender, U256(gas_refund_amount))
671
672
    # transfer miner fees
673
    create_ether(tx_state, block_env.coinbase, U256(transaction_fee))
674
675
    for address in tx_output.accounts_to_delete:
676
        destroy_account(tx_state, address)
677
678
    block_output.block_gas_used += tx_gas_used_after_refund
679
680
    incorporate_tx_into_block(tx_state)
681
682
    block_state = block_env.state
683
    block_diff = extract_block_diff(block_state)
684
    intermediate_state_root = block_state.pre_state.compute_state_root(
685
        block_diff
686
    )
687
688
    receipt = make_receipt(
689
        intermediate_state_root,
690
        block_output.block_gas_used,
691
        tx_output.logs,
692
    )
693
694
    receipt_key = rlp.encode(Uint(index))
695
    block_output.receipt_keys += (receipt_key,)
696
697
    trie_set(
698
        block_output.receipts_trie,
699
        receipt_key,
700
        receipt,
701
    )
702
703
    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:
707
    <snip>
735
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
736
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
737
        return False
738
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
739
        return False
740
    if gas_limit < GasCosts.LIMIT_MINIMUM:
741
        return False
742
743
    return True

calculate_block_difficulty

Computes difficulty of a block using its header and parent header.

The difficulty of a block is determined by the time the block was created after its parent. If a block's timestamp is more than 13 seconds after its parent block then its difficulty is set as the difference between the parent's difficulty and the max_adjustment_delta. Otherwise, if the time between parent and child blocks is too small (under 13 seconds) then, to avoid mass forking, the block's difficulty is set to the sum of the delta and the parent's 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:
752
    <snip>
780
    max_adjustment_delta = parent_difficulty // Uint(2048)
781
    if block_timestamp < parent_timestamp + U256(13):
782
        difficulty = parent_difficulty + max_adjustment_delta
783
    else:  # block_timestamp >= parent_timestamp + 13
784
        difficulty = parent_difficulty - max_adjustment_delta
785
786
    # Historical Note: The difficulty bomb was not present in Ethereum at the
787
    # start of Frontier, but was added shortly after launch. However since the
788
    # bomb has no effect prior to block 200000 we pretend it existed from
789
    # genesis.
790
    # See https://github.com/ethereum/go-ethereum/pull/1588
791
    num_bomb_periods = (int(block_number) // 100000) - 2
792
    if num_bomb_periods >= 0:
793
        difficulty += Uint(2**num_bomb_periods)
794
795
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
796
    # the bomb. This bug does not matter because the difficulty is always much
797
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
798
    return max(difficulty, MINIMUM_DIFFICULTY)