ethereum.istanbul.fork

Ethereum Specification ^^^^^^^^^^^^^^^^^^^^^^

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

GAS_LIMIT_ADJUSTMENT_FACTOR

55
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

56
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

57
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

58
MAX_OMMER_DEPTH = Uint(6)

BOMB_DELAY_BLOCKS

59
BOMB_DELAY_BLOCKS = 5000000

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

63
@dataclass
class BlockChain:

blocks

69
    blocks: List[Block]

state

70
    state: State

chain_id

71
    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:
75
    """
76
    Transforms the state from the previous hard fork (`old`) into the block
77
    chain object for this hard fork and returns it.
78
79
    When forks need to implement an irregular state transition, this function
80
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
81
    an example.
82
83
    Parameters
84
    ----------
85
    old :
86
        Previous block chain object.
87
88
    Returns
89
    -------
90
    new : `BlockChain`
91
        Upgraded block chain object for this hard fork.
92
    """
93
    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]:
97
    """
98
    Obtain the list of hashes of the previous 256 blocks in order of
99
    increasing block number.
100
101
    This function will return less hashes for the first 256 blocks.
102
103
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
104
    therefore this function retrieves them.
105
106
    Parameters
107
    ----------
108
    chain :
109
        History and current state.
110
111
    Returns
112
    -------
113
    recent_block_hashes : `List[Hash32]`
114
        Hashes of the recent 256 blocks in order of increasing block number.
115
    """
116
    recent_blocks = chain.blocks[-255:]
117
    # TODO: This function has not been tested rigorously
118
    if len(recent_blocks) == 0:
119
        return []
120
121
    recent_block_hashes = []
122
123
    for block in recent_blocks:
124
        prev_block_hash = block.header.parent_hash
125
        recent_block_hashes.append(prev_block_hash)
126
127
    # We are computing the hash only for the most recent block and not for
128
    # the rest of the blocks as they have successors which have the hash of
129
    # the current block as parent hash.
130
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
131
    recent_block_hashes.append(most_recent_block_hash)
132
133
    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:
137
    """
138
    Attempts to apply a block to an existing block chain.
139
140
    All parts of the block's contents need to be verified before being added
141
    to the chain. Blocks are verified by ensuring that the contents of the
142
    block make logical sense with the contents of the parent block. The
143
    information in the block's header must also match the corresponding
144
    information in the block.
145
146
    To implement Ethereum, in theory clients are only required to store the
147
    most recent 255 blocks of the chain since as far as execution is
148
    concerned, only those blocks are accessed. Practically, however, clients
149
    should store more blocks to handle reorgs.
150
151
    Parameters
152
    ----------
153
    chain :
154
        History and current state.
155
    block :
156
        Block to apply to `chain`.
157
    """
158
    parent_header = chain.blocks[-1].header
159
    validate_header(block.header, parent_header)
160
    validate_ommers(block.ommers, block.header, chain)
161
    apply_body_output = apply_body(
162
        chain.state,
163
        get_last_256_block_hashes(chain),
164
        block.header.coinbase,
165
        block.header.number,
166
        block.header.gas_limit,
167
        block.header.timestamp,
168
        block.header.difficulty,
169
        block.transactions,
170
        block.ommers,
171
        chain.chain_id,
172
    )
173
    if apply_body_output.block_gas_used != block.header.gas_used:
174
        raise InvalidBlock(
175
            f"{apply_body_output.block_gas_used} != {block.header.gas_used}"
176
        )
177
    if apply_body_output.transactions_root != block.header.transactions_root:
178
        raise InvalidBlock
179
    if apply_body_output.state_root != block.header.state_root:
180
        raise InvalidBlock
181
    if apply_body_output.receipt_root != block.header.receipt_root:
182
        raise InvalidBlock
183
    if apply_body_output.block_logs_bloom != block.header.bloom:
184
        raise InvalidBlock
185
186
    chain.blocks.append(block)
187
    if len(chain.blocks) > 255:
188
        # Real clients have to store more blocks to deal with reorgs, but the
189
        # protocol only requires the last 255
190
        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

header : Header to check for correctness. parent_header : Parent Header of the header to check for correctness

def validate_header(header: Header, ​​parent_header: Header) -> None:
194
    """
195
    Verifies a block header.
196
197
    In order to consider a block's header valid, the logic for the
198
    quantities in the header should match the logic for the block itself.
199
    For example the header timestamp should be greater than the block's parent
200
    timestamp because the block was created *after* the parent block.
201
    Additionally, the block's number should be directly following the parent
202
    block's number since it is the next block in the sequence.
203
204
    Parameters
205
    ----------
206
    header :
207
        Header to check for correctness.
208
    parent_header :
209
        Parent Header of the header to check for correctness
210
    """
211
    parent_has_ommers = parent_header.ommers_hash != EMPTY_OMMER_HASH
212
    if header.timestamp <= parent_header.timestamp:
213
        raise InvalidBlock
214
    if header.number != parent_header.number + Uint(1):
215
        raise InvalidBlock
216
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
217
        raise InvalidBlock
218
    if len(header.extra_data) > 32:
219
        raise InvalidBlock
220
221
    block_difficulty = calculate_block_difficulty(
222
        header.number,
223
        header.timestamp,
224
        parent_header.timestamp,
225
        parent_header.difficulty,
226
        parent_has_ommers,
227
    )
228
    if header.difficulty != block_difficulty:
229
        raise InvalidBlock
230
231
    block_parent_hash = keccak256(rlp.encode(parent_header))
232
    if header.parent_hash != block_parent_hash:
233
        raise InvalidBlock
234
235
    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:
239
    """
240
    Generate rlp hash of the header which is to be used for Proof-of-Work
241
    verification.
242
243
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
244
    while calculating this hash.
245
246
    A particular PoW is valid for a single hash, that hash is computed by
247
    this function. The `nonce` and `mix_digest` are omitted from this hash
248
    because they are being changed by miners in their search for a sufficient
249
    proof-of-work.
250
251
    Parameters
252
    ----------
253
    header :
254
        The header object for which the hash is to be generated.
255
256
    Returns
257
    -------
258
    hash : `Hash32`
259
        The PoW valid rlp hash of the passed in header.
260
    """
261
    header_data_without_pow_artefacts = (
262
        header.parent_hash,
263
        header.ommers_hash,
264
        header.coinbase,
265
        header.state_root,
266
        header.transactions_root,
267
        header.receipt_root,
268
        header.bloom,
269
        header.difficulty,
270
        header.number,
271
        header.gas_limit,
272
        header.gas_used,
273
        header.timestamp,
274
        header.extra_data,
275
    )
276
277
    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:
281
    """
282
    Validates the Proof of Work constraints.
283
284
    In order to verify that a miner's proof-of-work is valid for a block, a
285
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
286
    hash function. The mix digest is a hash of the header and the nonce that
287
    is passed through and it confirms whether or not proof-of-work was done
288
    on the correct block. The result is the actual hash value of the block.
289
290
    Parameters
291
    ----------
292
    header :
293
        Header of interest.
294
    """
295
    header_hash = generate_header_hash_for_pow(header)
296
    # TODO: Memoize this somewhere and read from that data instead of
297
    # calculating cache for every block validation.
298
    cache = generate_cache(header.number)
299
    mix_digest, result = hashimoto_light(
300
        header_hash, header.nonce, cache, dataset_size(header.number)
301
    )
302
    if mix_digest != header.mix_digest:
303
        raise InvalidBlock
304
305
    limit = Uint(U256.MAX_VALUE) + Uint(1)
306
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
307
        raise InvalidBlock

check_transaction

Check if the transaction is includable in the block.

Parameters

tx : The transaction. gas_available : The gas remaining in the block. chain_id : The ID of the current chain.

Returns

sender_address : The sender of the transaction.

Raises

InvalidBlock : If the transaction is not includable.

def check_transaction(tx: Transaction, ​​gas_available: Uint, ​​chain_id: U64) -> Address:
315
    """
316
    Check if the transaction is includable in the block.
317
318
    Parameters
319
    ----------
320
    tx :
321
        The transaction.
322
    gas_available :
323
        The gas remaining in the block.
324
    chain_id :
325
        The ID of the current chain.
326
327
    Returns
328
    -------
329
    sender_address :
330
        The sender of the transaction.
331
332
    Raises
333
    ------
334
    InvalidBlock :
335
        If the transaction is not includable.
336
    """
337
    if tx.gas > gas_available:
338
        raise InvalidBlock
339
    sender_address = recover_sender(chain_id, tx)
340
341
    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(tx: Transaction, ​​error: Optional[EthereumException], ​​cumulative_gas_used: Uint, ​​logs: Tuple[Log, ...]) -> Receipt:
350
    """
351
    Make the receipt for a transaction that was executed.
352
353
    Parameters
354
    ----------
355
    tx :
356
        The executed transaction.
357
    error :
358
        Error in the top level frame of the transaction, if any.
359
    cumulative_gas_used :
360
        The total gas used so far in the block after the transaction was
361
        executed.
362
    logs :
363
        The logs produced by the transaction.
364
365
    Returns
366
    -------
367
    receipt :
368
        The receipt for the transaction.
369
    """
370
    receipt = Receipt(
371
        succeeded=error is None,
372
        cumulative_gas_used=cumulative_gas_used,
373
        bloom=logs_bloom(logs),
374
        logs=logs,
375
    )
376
377
    return receipt

ApplyBodyOutput

Output from applying the block body to the present state.

Contains the following:

block_gas_used : ethereum.base_types.Uint Gas used for executing all transactions. transactions_root : ethereum.fork_types.Root Trie root of all the transactions in the block. receipt_root : ethereum.fork_types.Root Trie root of all the receipts in the block. block_logs_bloom : Bloom Logs bloom of all the logs included in all the transactions of the block. state_root : ethereum.fork_types.Root State root after all transactions have been executed.

380
@dataclass
class ApplyBodyOutput:

block_gas_used

400
    block_gas_used: Uint

transactions_root

401
    transactions_root: Root

receipt_root

402
    receipt_root: Root

block_logs_bloom

403
    block_logs_bloom: Bloom

state_root

404
    state_root: Root

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

state : Current account state. block_hashes : List of hashes of the previous 256 blocks in the order of increasing block number. coinbase : Address of account which receives block reward and transaction fees. block_number : Position of the block within the chain. block_gas_limit : Initial amount of gas available for execution in this block. block_time : Time the block was produced, measured in seconds since the epoch. block_difficulty : Difficulty of the block. transactions : Transactions included in the block. ommers : Headers of ancestor blocks which are not direct parents (formerly uncles.) chain_id : ID of the executing chain.

Returns

apply_body_output : ApplyBodyOutput Output of applying the block body to the state.

def apply_body(state: State, ​​block_hashes: List[Hash32], ​​coinbase: Address, ​​block_number: Uint, ​​block_gas_limit: Uint, ​​block_time: U256, ​​block_difficulty: Uint, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...], ​​chain_id: U64) -> ApplyBodyOutput:
419
    """
420
    Executes a block.
421
422
    Many of the contents of a block are stored in data structures called
423
    tries. There is a transactions trie which is similar to a ledger of the
424
    transactions stored in the current block. There is also a receipts trie
425
    which stores the results of executing a transaction, like the post state
426
    and gas used. This function creates and executes the block that is to be
427
    added to the chain.
428
429
    Parameters
430
    ----------
431
    state :
432
        Current account state.
433
    block_hashes :
434
        List of hashes of the previous 256 blocks in the order of
435
        increasing block number.
436
    coinbase :
437
        Address of account which receives block reward and transaction fees.
438
    block_number :
439
        Position of the block within the chain.
440
    block_gas_limit :
441
        Initial amount of gas available for execution in this block.
442
    block_time :
443
        Time the block was produced, measured in seconds since the epoch.
444
    block_difficulty :
445
        Difficulty of the block.
446
    transactions :
447
        Transactions included in the block.
448
    ommers :
449
        Headers of ancestor blocks which are not direct parents (formerly
450
        uncles.)
451
    chain_id :
452
        ID of the executing chain.
453
454
    Returns
455
    -------
456
    apply_body_output : `ApplyBodyOutput`
457
        Output of applying the block body to the state.
458
    """
459
    gas_available = block_gas_limit
460
    transactions_trie: Trie[Bytes, Optional[Transaction]] = Trie(
461
        secured=False, default=None
462
    )
463
    receipts_trie: Trie[Bytes, Optional[Receipt]] = Trie(
464
        secured=False, default=None
465
    )
466
    block_logs: Tuple[Log, ...] = ()
467
468
    for i, tx in enumerate(transactions):
469
        trie_set(transactions_trie, rlp.encode(Uint(i)), tx)
470
471
        sender_address = check_transaction(tx, gas_available, chain_id)
472
473
        env = vm.Environment(
474
            caller=sender_address,
475
            origin=sender_address,
476
            block_hashes=block_hashes,
477
            coinbase=coinbase,
478
            number=block_number,
479
            gas_limit=block_gas_limit,
480
            gas_price=tx.gas_price,
481
            time=block_time,
482
            difficulty=block_difficulty,
483
            state=state,
484
            chain_id=chain_id,
485
            traces=[],
486
        )
487
488
        gas_used, logs, error = process_transaction(env, tx)
489
        gas_available -= gas_used
490
491
        receipt = make_receipt(
492
            tx, error, (block_gas_limit - gas_available), logs
493
        )
494
495
        trie_set(
496
            receipts_trie,
497
            rlp.encode(Uint(i)),
498
            receipt,
499
        )
500
501
        block_logs += logs
502
503
    pay_rewards(state, block_number, coinbase, ommers)
504
505
    block_gas_used = block_gas_limit - gas_available
506
507
    block_logs_bloom = logs_bloom(block_logs)
508
509
    return ApplyBodyOutput(
510
        block_gas_used,
511
        root(transactions_trie),
512
        root(receipts_trie),
513
        block_logs_bloom,
514
        state_root(state),
515
    )

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:
521
    """
522
    Validates the ommers mentioned in the block.
523
524
    An ommer block is a block that wasn't canonically added to the
525
    blockchain because it wasn't validated as fast as the canonical block
526
    but was mined at the same time.
527
528
    To be considered valid, the ommers must adhere to the rules defined in
529
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
530
    there cannot be duplicate ommers in a block. Many of the other ommer
531
    constraints are listed in the in-line comments of this function.
532
533
    Parameters
534
    ----------
535
    ommers :
536
        List of ommers mentioned in the current block.
537
    block_header:
538
        The header of current block.
539
    chain :
540
        History and current state.
541
    """
542
    block_hash = keccak256(rlp.encode(block_header))
543
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
544
        raise InvalidBlock
545
546
    if len(ommers) == 0:
547
        # Nothing to validate
548
        return
549
550
    # Check that each ommer satisfies the constraints of a header
551
    for ommer in ommers:
552
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
553
            raise InvalidBlock
554
        ommer_parent_header = chain.blocks[
555
            -(block_header.number - ommer.number) - 1
556
        ].header
557
        validate_header(ommer, ommer_parent_header)
558
    if len(ommers) > 2:
559
        raise InvalidBlock
560
561
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
562
    if len(ommers_hashes) != len(set(ommers_hashes)):
563
        raise InvalidBlock
564
565
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
566
    recent_canonical_block_hashes = {
567
        keccak256(rlp.encode(block.header))
568
        for block in recent_canonical_blocks
569
    }
570
    recent_ommers_hashes: Set[Hash32] = set()
571
    for block in recent_canonical_blocks:
572
        recent_ommers_hashes = recent_ommers_hashes.union(
573
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
574
        )
575
576
    for ommer_index, ommer in enumerate(ommers):
577
        ommer_hash = ommers_hashes[ommer_index]
578
        if ommer_hash == block_hash:
579
            raise InvalidBlock
580
        if ommer_hash in recent_canonical_block_hashes:
581
            raise InvalidBlock
582
        if ommer_hash in recent_ommers_hashes:
583
            raise InvalidBlock
584
585
        # Ommer age with respect to the current block. For example, an age of
586
        # 1 indicates that the ommer is a sibling of previous block.
587
        ommer_age = block_header.number - ommer.number
588
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
589
            raise InvalidBlock
590
        if ommer.parent_hash not in recent_canonical_block_hashes:
591
            raise InvalidBlock
592
        if ommer.parent_hash == block_header.parent_hash:
593
            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

state : Current account state. block_number : Position of the block within the chain. coinbase : Address of account which receives block reward and transaction fees. ommers : List of ommers mentioned in the current block.

def pay_rewards(state: State, ​​block_number: Uint, ​​coinbase: Address, ​​ommers: Tuple[Header, ...]) -> None:
602
    """
603
    Pay rewards to the block miner as well as the ommers miners.
604
605
    The miner of the canonical block is rewarded with the predetermined
606
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
607
    number of ommer blocks that were mined around the same time, and included
608
    in the canonical block's header. An ommer block is a block that wasn't
609
    added to the canonical blockchain because it wasn't validated as fast as
610
    the accepted block but was mined at the same time. Although not all blocks
611
    that are mined are added to the canonical chain, miners are still paid a
612
    reward for their efforts. This reward is called an ommer reward and is
613
    calculated based on the number associated with the ommer block that they
614
    mined.
615
616
    Parameters
617
    ----------
618
    state :
619
        Current account state.
620
    block_number :
621
        Position of the block within the chain.
622
    coinbase :
623
        Address of account which receives block reward and transaction fees.
624
    ommers :
625
        List of ommers mentioned in the current block.
626
    """
627
    ommer_count = U256(len(ommers))
628
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
629
    create_ether(state, coinbase, miner_reward)
630
631
    for ommer in ommers:
632
        # Ommer age with respect to the current block.
633
        ommer_age = U256(block_number - ommer.number)
634
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
635
        create_ether(state, ommer.coinbase, ommer_miner_reward)

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 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

env : Environment for the Ethereum Virtual Machine. tx : Transaction to execute.

Returns

gas_left : ethereum.base_types.U256 Remaining gas after execution. logs : Tuple[ethereum.blocks.Log, ...] Logs generated during execution.

def process_transaction(env: ethereum.istanbul.vm.Environment, ​​tx: Transaction) -> Tuple[Uint, Tuple[Log, ...], Optional[EthereumException]]:
641
    """
642
    Execute a transaction against the provided environment.
643
644
    This function processes the actions needed to execute a transaction.
645
    It decrements the sender's account after calculating the gas fee and
646
    refunds them the proper amount after execution. Calling contracts,
647
    deploying code, and incrementing nonces are all examples of actions that
648
    happen within this function or from a call made within this function.
649
650
    Accounts that are marked for deletion are processed and destroyed after
651
    execution.
652
653
    Parameters
654
    ----------
655
    env :
656
        Environment for the Ethereum Virtual Machine.
657
    tx :
658
        Transaction to execute.
659
660
    Returns
661
    -------
662
    gas_left : `ethereum.base_types.U256`
663
        Remaining gas after execution.
664
    logs : `Tuple[ethereum.blocks.Log, ...]`
665
        Logs generated during execution.
666
    """
667
    if not validate_transaction(tx):
668
        raise InvalidBlock
669
670
    sender = env.origin
671
    sender_account = get_account(env.state, sender)
672
    gas_fee = tx.gas * tx.gas_price
673
    if sender_account.nonce != tx.nonce:
674
        raise InvalidBlock
675
    if Uint(sender_account.balance) < gas_fee + Uint(tx.value):
676
        raise InvalidBlock
677
    if sender_account.code != bytearray():
678
        raise InvalidSenderError("not EOA")
679
680
    gas = tx.gas - calculate_intrinsic_cost(tx)
681
    increment_nonce(env.state, sender)
682
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
683
    set_account_balance(env.state, sender, U256(sender_balance_after_gas_fee))
684
685
    message = prepare_message(
686
        sender,
687
        tx.to,
688
        tx.value,
689
        tx.data,
690
        gas,
691
        env,
692
    )
693
694
    output = process_message_call(message, env)
695
696
    gas_used = tx.gas - output.gas_left
697
    gas_refund = min(gas_used // Uint(2), Uint(output.refund_counter))
698
    gas_refund_amount = (output.gas_left + gas_refund) * tx.gas_price
699
    transaction_fee = (tx.gas - output.gas_left - gas_refund) * tx.gas_price
700
    total_gas_used = gas_used - gas_refund
701
702
    # refund gas
703
    sender_balance_after_refund = get_account(
704
        env.state, sender
705
    ).balance + U256(gas_refund_amount)
706
    set_account_balance(env.state, sender, sender_balance_after_refund)
707
708
    # transfer miner fees
709
    coinbase_balance_after_mining_fee = get_account(
710
        env.state, env.coinbase
711
    ).balance + U256(transaction_fee)
712
    if coinbase_balance_after_mining_fee != 0:
713
        set_account_balance(
714
            env.state, env.coinbase, coinbase_balance_after_mining_fee
715
        )
716
    elif account_exists_and_is_empty(env.state, env.coinbase):
717
        destroy_account(env.state, env.coinbase)
718
719
    for address in output.accounts_to_delete:
720
        destroy_account(env.state, address)
721
722
    for address in output.touched_accounts:
723
        if account_exists_and_is_empty(env.state, address):
724
            destroy_account(env.state, address)
725
726
    return total_gas_used, output.logs, output.error

compute_header_hash

Computes the hash of a block header.

The header hash of a block is the canonical hash that is used to refer to a specific block and completely distinguishes a block from another.

keccak256 is a function that produces a 256 bit hash of any input. It also takes in any number of bytes as an input and produces a single hash for them. A hash is a completely unique output for a single input. So an input corresponds to one unique hash that can be used to identify the input exactly.

Prior to using the keccak256 hash function, the header must be encoded using the Recursive-Length Prefix. See :ref:rlp. RLP encoding the header converts it into a space-efficient format that allows for easy transfer of data between nodes. The purpose of RLP is to encode arbitrarily nested arrays of binary data, and RLP is the primary encoding method used to serialize objects in Ethereum's execution layer. The only purpose of RLP is to encode structure; encoding specific data types (e.g. strings, floats) is left up to higher-order protocols.

Parameters

header : Header of interest.

Returns

hash : ethereum.crypto.hash.Hash32 Hash of the header.

def compute_header_hash(header: Header) -> Hash32:
730
    """
731
    Computes the hash of a block header.
732
733
    The header hash of a block is the canonical hash that is used to refer
734
    to a specific block and completely distinguishes a block from another.
735
736
    ``keccak256`` is a function that produces a 256 bit hash of any input.
737
    It also takes in any number of bytes as an input and produces a single
738
    hash for them. A hash is a completely unique output for a single input.
739
    So an input corresponds to one unique hash that can be used to identify
740
    the input exactly.
741
742
    Prior to using the ``keccak256`` hash function, the header must be
743
    encoded using the Recursive-Length Prefix. See :ref:`rlp`.
744
    RLP encoding the header converts it into a space-efficient format that
745
    allows for easy transfer of data between nodes. The purpose of RLP is to
746
    encode arbitrarily nested arrays of binary data, and RLP is the primary
747
    encoding method used to serialize objects in Ethereum's execution layer.
748
    The only purpose of RLP is to encode structure; encoding specific data
749
    types (e.g. strings, floats) is left up to higher-order protocols.
750
751
    Parameters
752
    ----------
753
    header :
754
        Header of interest.
755
756
    Returns
757
    -------
758
    hash : `ethereum.crypto.hash.Hash32`
759
        Hash of the header.
760
    """
761
    return keccak256(rlp.encode(header))

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 GAS_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 GAS_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:
765
    """
766
    Validates the gas limit for a block.
767
768
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
769
    quotient of the parent block's gas limit and the
770
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
771
    passed through as a parameter is greater than or equal to the *sum* of
772
    the parent's gas and the adjustment delta then the limit for gas is too
773
    high and fails this function's check. Similarly, if the limit is less
774
    than or equal to the *difference* of the parent's gas and the adjustment
775
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
776
    check fails because the gas limit doesn't allow for a sufficient or
777
    reasonable amount of gas to be used on a block.
778
779
    Parameters
780
    ----------
781
    gas_limit :
782
        Gas limit to validate.
783
784
    parent_gas_limit :
785
        Gas limit of the parent block.
786
787
    Returns
788
    -------
789
    check : `bool`
790
        True if gas limit constraints are satisfied, False otherwise.
791
    """
792
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
793
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
794
        return False
795
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
796
        return False
797
    if gas_limit < GAS_LIMIT_MINIMUM:
798
        return False
799
800
    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 GENESIS_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:
810
    """
811
    Computes difficulty of a block using its header and parent header.
812
813
    The difficulty is determined by the time the block was created after its
814
    parent. The ``offset`` is calculated using the parent block's difficulty,
815
    ``parent_difficulty``, and the timestamp between blocks. This offset is
816
    then added to the parent difficulty and is stored as the ``difficulty``
817
    variable. If the time between the block and its parent is too short, the
818
    offset will result in a positive number thus making the sum of
819
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
820
    avoid mass forking. But, if the time is long enough, then the offset
821
    results in a negative value making the block less difficult than
822
    its parent.
823
824
    The base standard for a block's difficulty is the predefined value
825
    set for the genesis block since it has no parent. So, a block
826
    can't be less difficult than the genesis block, therefore each block's
827
    difficulty is set to the maximum value between the calculated
828
    difficulty and the ``GENESIS_DIFFICULTY``.
829
830
    Parameters
831
    ----------
832
    block_number :
833
        Block number of the block.
834
    block_timestamp :
835
        Timestamp of the block.
836
    parent_timestamp :
837
        Timestamp of the parent block.
838
    parent_difficulty :
839
        difficulty of the parent block.
840
    parent_has_ommers:
841
        does the parent have ommers.
842
843
    Returns
844
    -------
845
    difficulty : `ethereum.base_types.Uint`
846
        Computed difficulty for a block.
847
    """
848
    offset = (
849
        int(parent_difficulty)
850
        // 2048
851
        * max(
852
            (2 if parent_has_ommers else 1)
853
            - int(block_timestamp - parent_timestamp) // 9,
854
            -99,
855
        )
856
    )
857
    difficulty = int(parent_difficulty) + offset
858
    # Historical Note: The difficulty bomb was not present in Ethereum at the
859
    # start of Frontier, but was added shortly after launch. However since the
860
    # bomb has no effect prior to block 200000 we pretend it existed from
861
    # genesis.
862
    # See https://github.com/ethereum/go-ethereum/pull/1588
863
    num_bomb_periods = ((int(block_number) - BOMB_DELAY_BLOCKS) // 100000) - 2
864
    if num_bomb_periods >= 0:
865
        difficulty += 2**num_bomb_periods
866
867
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
868
    # the bomb. This bug does not matter because the difficulty is always much
869
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
870
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))