ethereum.forks.dao_fork.fork

Ethereum Specification.

.. _dao-fork:

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

MINIMUM_DIFFICULTY

60
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

61
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

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.

The DAO-Fork occurred as a result of the 2016 DAO Hacks <https://www.gemini.com/cryptopedia/the-dao-hack-makerdao>_ in which an unknown entity managed to drain more than 3.6 million ether causing the price of ether to drop by nearly 35%. This fork was the solution to the hacks and manually reset the affected parties' accounts to their state prior to the attack. This fork essentially rewrote the history of the Ethereum network.

Parameters

old : Previous block chain object.

Returns

new : BlockChain Upgraded block chain object for this hard fork.

def apply_fork(old: BlockChain) -> BlockChain:
76
    """
77
    Transforms the state from the previous hard fork (`old`) into the block
78
    chain object for this hard fork and returns it.
79
80
    When forks need to implement an irregular state transition, this function
81
    is used to handle the irregularity.
82
83
    The DAO-Fork occurred as a result of the `2016 DAO Hacks
84
    <https://www.gemini.com/cryptopedia/the-dao-hack-makerdao>`_ in which an
85
    unknown entity managed to drain more than 3.6 million ether causing the
86
    price of ether to drop by nearly 35%. This fork was the solution to the
87
    hacks and manually reset the affected parties' accounts to their state
88
    prior to the attack. This fork essentially rewrote the history of the
89
    Ethereum network.
90
91
    Parameters
92
    ----------
93
    old :
94
        Previous block chain object.
95
96
    Returns
97
    -------
98
    new : `BlockChain`
99
        Upgraded block chain object for this hard fork.
100
101
    """
102
    apply_dao(old.state)
103
    return old

get_last_256_block_hashes

Obtain the list of hashes of the previous 256 blocks in order of increasing block number.

This function will return less hashes for the first 256 blocks.

The BLOCKHASH opcode needs to access the latest hashes on the chain, therefore this function retrieves them.

Parameters

chain : History and current state.

Returns

recent_block_hashes : List[Hash32] Hashes of the recent 256 blocks in order of increasing block number.

def get_last_256_block_hashes(chain: BlockChain) -> List[Hash32]:
107
    """
108
    Obtain the list of hashes of the previous 256 blocks in order of
109
    increasing block number.
110
111
    This function will return less hashes for the first 256 blocks.
112
113
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
114
    therefore this function retrieves them.
115
116
    Parameters
117
    ----------
118
    chain :
119
        History and current state.
120
121
    Returns
122
    -------
123
    recent_block_hashes : `List[Hash32]`
124
        Hashes of the recent 256 blocks in order of increasing block number.
125
126
    """
127
    recent_blocks = chain.blocks[-255:]
128
    # TODO: This function has not been tested rigorously
129
    if len(recent_blocks) == 0:
130
        return []
131
132
    recent_block_hashes = []
133
134
    for block in recent_blocks:
135
        prev_block_hash = block.header.parent_hash
136
        recent_block_hashes.append(prev_block_hash)
137
138
    # We are computing the hash only for the most recent block and not for
139
    # the rest of the blocks as they have successors which have the hash of
140
    # the current block as parent hash.
141
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
142
    recent_block_hashes.append(most_recent_block_hash)
143
144
    return recent_block_hashes

state_transition

Attempts to apply a block to an existing block chain.

All parts of the block's contents need to be verified before being added to the chain. Blocks are verified by ensuring that the contents of the block make logical sense with the contents of the parent block. The information in the block's header must also match the corresponding information in the block.

To implement Ethereum, in theory clients are only required to store the most recent 255 blocks of the chain since as far as execution is concerned, only those blocks are accessed. Practically, however, clients should store more blocks to handle reorgs.

Parameters

chain : History and current state. block : Block to apply to chain.

def state_transition(chain: BlockChain, ​​block: Block) -> None:
148
    """
149
    Attempts to apply a block to an existing block chain.
150
151
    All parts of the block's contents need to be verified before being added
152
    to the chain. Blocks are verified by ensuring that the contents of the
153
    block make logical sense with the contents of the parent block. The
154
    information in the block's header must also match the corresponding
155
    information in the block.
156
157
    To implement Ethereum, in theory clients are only required to store the
158
    most recent 255 blocks of the chain since as far as execution is
159
    concerned, only those blocks are accessed. Practically, however, clients
160
    should store more blocks to handle reorgs.
161
162
    Parameters
163
    ----------
164
    chain :
165
        History and current state.
166
    block :
167
        Block to apply to `chain`.
168
169
    """
170
    validate_header(chain, block.header)
171
    validate_ommers(block.ommers, block.header, chain)
172
173
    block_env = vm.BlockEnvironment(
174
        chain_id=chain.chain_id,
175
        state=chain.state,
176
        block_gas_limit=block.header.gas_limit,
177
        block_hashes=get_last_256_block_hashes(chain),
178
        coinbase=block.header.coinbase,
179
        number=block.header.number,
180
        time=block.header.timestamp,
181
        difficulty=block.header.difficulty,
182
    )
183
184
    block_output = apply_body(
185
        block_env=block_env,
186
        transactions=block.transactions,
187
        ommers=block.ommers,
188
    )
189
    block_state_root = state_root(block_env.state)
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
    chain.blocks.append(block)
208
    if len(chain.blocks) > 255:
209
        # Real clients have to store more blocks to deal with reorgs, but the
210
        # protocol only requires the last 255
211
        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:
215
    """
216
    Verifies a block header.
217
218
    In order to consider a block's header valid, the logic for the
219
    quantities in the header should match the logic for the block itself.
220
    For example the header timestamp should be greater than the block's parent
221
    timestamp because the block was created *after* the parent block.
222
    Additionally, the block's number should be directly following the parent
223
    block's number since it is the next block in the sequence.
224
225
    Parameters
226
    ----------
227
    chain :
228
        History and current state.
229
    header :
230
        Header to check for correctness.
231
232
    """
233
    if header.number < Uint(1):
234
        raise InvalidBlock
235
    parent_header_number = header.number - Uint(1)
236
    first_block_number = chain.blocks[0].header.number
237
    last_block_number = chain.blocks[-1].header.number
238
239
    if (
240
        parent_header_number < first_block_number
241
        or parent_header_number > last_block_number
242
    ):
243
        raise InvalidBlock
244
245
    parent_header = chain.blocks[
246
        parent_header_number - first_block_number
247
    ].header
248
249
    if header.gas_used > header.gas_limit:
250
        raise InvalidBlock
251
252
    if header.timestamp <= parent_header.timestamp:
253
        raise InvalidBlock
254
    if header.number != parent_header.number + Uint(1):
255
        raise InvalidBlock
256
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
257
        raise InvalidBlock
258
    if len(header.extra_data) > 32:
259
        raise InvalidBlock
260
261
    block_difficulty = calculate_block_difficulty(
262
        header.number,
263
        header.timestamp,
264
        parent_header.timestamp,
265
        parent_header.difficulty,
266
    )
267
    if header.difficulty != block_difficulty:
268
        raise InvalidBlock
269
270
    block_parent_hash = keccak256(rlp.encode(parent_header))
271
    if header.parent_hash != block_parent_hash:
272
        raise InvalidBlock
273
274
    assert isinstance(FORK_CRITERIA, ByBlockNumber)
275
276
    if (
277
        header.number >= FORK_CRITERIA.block_number
278
        and header.number < FORK_CRITERIA.block_number + Uint(10)
279
    ):
280
        if header.extra_data != b"dao-hard-fork":
281
            raise InvalidBlock
282
283
    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:
287
    """
288
    Generate rlp hash of the header which is to be used for Proof-of-Work
289
    verification.
290
291
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
292
    while calculating this hash.
293
294
    A particular PoW is valid for a single hash, that hash is computed by
295
    this function. The `nonce` and `mix_digest` are omitted from this hash
296
    because they are being changed by miners in their search for a sufficient
297
    proof-of-work.
298
299
    Parameters
300
    ----------
301
    header :
302
        The header object for which the hash is to be generated.
303
304
    Returns
305
    -------
306
    hash : `Hash32`
307
        The PoW valid rlp hash of the passed in header.
308
309
    """
310
    header_data_without_pow_artefacts = (
311
        header.parent_hash,
312
        header.ommers_hash,
313
        header.coinbase,
314
        header.state_root,
315
        header.transactions_root,
316
        header.receipt_root,
317
        header.bloom,
318
        header.difficulty,
319
        header.number,
320
        header.gas_limit,
321
        header.gas_used,
322
        header.timestamp,
323
        header.extra_data,
324
    )
325
326
    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:
330
    """
331
    Validates the Proof of Work constraints.
332
333
    In order to verify that a miner's proof-of-work is valid for a block, a
334
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
335
    hash function. The mix digest is a hash of the header and the nonce that
336
    is passed through and it confirms whether or not proof-of-work was done
337
    on the correct block. The result is the actual hash value of the block.
338
339
    Parameters
340
    ----------
341
    header :
342
        Header of interest.
343
344
    """
345
    header_hash = generate_header_hash_for_pow(header)
346
    # TODO: Memoize this somewhere and read from that data instead of
347
    # calculating cache for every block validation.
348
    cache = generate_cache(header.number)
349
    mix_digest, result = hashimoto_light(
350
        header_hash, header.nonce, cache, dataset_size(header.number)
351
    )
352
    if mix_digest != header.mix_digest:
353
        raise InvalidBlock
354
355
    limit = Uint(U256.MAX_VALUE) + Uint(1)
356
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
357
        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.

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.dao_fork.vm.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction) -> Address:
365
    """
366
    Check if the transaction is includable in the block.
367
368
    Parameters
369
    ----------
370
    block_env :
371
        The block scoped environment.
372
    block_output :
373
        The block output for the current block.
374
    tx :
375
        The transaction.
376
377
    Returns
378
    -------
379
    sender_address :
380
        The sender of the transaction.
381
382
    Raises
383
    ------
384
    GasUsedExceedsLimitError :
385
        If the gas used by the transaction exceeds the block's gas limit.
386
    NonceMismatchError :
387
        If the nonce of the transaction is not equal to the sender's nonce.
388
    InsufficientBalanceError :
389
        If the sender's balance is not enough to pay for the transaction.
390
    InvalidSenderError :
391
        If the transaction is from an address that does not exist anymore.
392
393
    """
394
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
395
    if tx.gas > gas_available:
396
        raise GasUsedExceedsLimitError("gas used exceeds limit")
397
    sender_address = recover_sender(tx)
398
    sender_account = get_account(block_env.state, sender_address)
399
400
    max_gas_fee = tx.gas * tx.gas_price
401
402
    if sender_account.nonce > Uint(tx.nonce):
403
        raise NonceMismatchError("nonce too low")
404
    elif sender_account.nonce < Uint(tx.nonce):
405
        raise NonceMismatchError("nonce too high")
406
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
407
        raise InsufficientBalanceError("insufficient sender balance")
408
    if sender_account.code_hash != EMPTY_CODE_HASH:
409
        raise InvalidSenderError("not EOA")
410
411
    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:
419
    """
420
    Make the receipt for a transaction that was executed.
421
422
    Parameters
423
    ----------
424
    post_state :
425
        The state root immediately after this transaction.
426
    cumulative_gas_used :
427
        The total gas used so far in the block after the transaction was
428
        executed.
429
    logs :
430
        The logs produced by the transaction.
431
432
    Returns
433
    -------
434
    receipt :
435
        The receipt for the transaction.
436
437
    """
438
    receipt = Receipt(
439
        post_state=post_state,
440
        cumulative_gas_used=cumulative_gas_used,
441
        bloom=logs_bloom(logs),
442
        logs=logs,
443
    )
444
445
    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.dao_fork.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.dao_fork.vm.BlockOutput:
453
    """
454
    Executes a block.
455
456
    Many of the contents of a block are stored in data structures called
457
    tries. There is a transactions trie which is similar to a ledger of the
458
    transactions stored in the current block. There is also a receipts trie
459
    which stores the results of executing a transaction, like the post state
460
    and gas used. This function creates and executes the block that is to be
461
    added to the chain.
462
463
    Parameters
464
    ----------
465
    block_env :
466
        The block scoped environment.
467
    transactions :
468
        Transactions included in the block.
469
    ommers :
470
        Headers of ancestor blocks which are not direct parents (formerly
471
        uncles.)
472
473
    Returns
474
    -------
475
    block_output :
476
        The block output for the current block.
477
478
    """
479
    block_output = vm.BlockOutput()
480
481
    for i, tx in enumerate(transactions):
482
        process_transaction(block_env, block_output, tx, Uint(i))
483
484
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
485
486
    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:
492
    """
493
    Validates the ommers mentioned in the block.
494
495
    An ommer block is a block that wasn't canonically added to the
496
    blockchain because it wasn't validated as fast as the canonical block
497
    but was mined at the same time.
498
499
    To be considered valid, the ommers must adhere to the rules defined in
500
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
501
    there cannot be duplicate ommers in a block. Many of the other ommer
502
    constraints are listed in the in-line comments of this function.
503
504
    Parameters
505
    ----------
506
    ommers :
507
        List of ommers mentioned in the current block.
508
    block_header:
509
        The header of current block.
510
    chain :
511
        History and current state.
512
513
    """
514
    block_hash = keccak256(rlp.encode(block_header))
515
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
516
        raise InvalidBlock
517
518
    if len(ommers) == 0:
519
        # Nothing to validate
520
        return
521
522
    # Check that each ommer satisfies the constraints of a header
523
    for ommer in ommers:
524
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
525
            raise InvalidBlock
526
        validate_header(chain, ommer)
527
    if len(ommers) > 2:
528
        raise InvalidBlock
529
530
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
531
    if len(ommers_hashes) != len(set(ommers_hashes)):
532
        raise InvalidBlock
533
534
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
535
    recent_canonical_block_hashes = {
536
        keccak256(rlp.encode(block.header))
537
        for block in recent_canonical_blocks
538
    }
539
    recent_ommers_hashes: Set[Hash32] = set()
540
    for block in recent_canonical_blocks:
541
        recent_ommers_hashes = recent_ommers_hashes.union(
542
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
543
        )
544
545
    for ommer_index, ommer in enumerate(ommers):
546
        ommer_hash = ommers_hashes[ommer_index]
547
        if ommer_hash == block_hash:
548
            raise InvalidBlock
549
        if ommer_hash in recent_canonical_block_hashes:
550
            raise InvalidBlock
551
        if ommer_hash in recent_ommers_hashes:
552
            raise InvalidBlock
553
554
        # Ommer age with respect to the current block. For example, an age of
555
        # 1 indicates that the ommer is a sibling of previous block.
556
        ommer_age = block_header.number - ommer.number
557
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
558
            raise InvalidBlock
559
        if ommer.parent_hash not in recent_canonical_block_hashes:
560
            raise InvalidBlock
561
        if ommer.parent_hash == block_header.parent_hash:
562
            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:
571
    """
572
    Pay rewards to the block miner as well as the ommers miners.
573
574
    The miner of the canonical block is rewarded with the predetermined
575
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
576
    number of ommer blocks that were mined around the same time, and included
577
    in the canonical block's header. An ommer block is a block that wasn't
578
    added to the canonical blockchain because it wasn't validated as fast as
579
    the accepted block but was mined at the same time. Although not all blocks
580
    that are mined are added to the canonical chain, miners are still paid a
581
    reward for their efforts. This reward is called an ommer reward and is
582
    calculated based on the number associated with the ommer block that they
583
    mined.
584
585
    Parameters
586
    ----------
587
    state :
588
        Current account state.
589
    block_number :
590
        Position of the block within the chain.
591
    coinbase :
592
        Address of account which receives block reward and transaction fees.
593
    ommers :
594
        List of ommers mentioned in the current block.
595
596
    """
597
    ommer_count = U256(len(ommers))
598
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
599
    create_ether(state, coinbase, miner_reward)
600
601
    for ommer in ommers:
602
        # Ommer age with respect to the current block.
603
        ommer_age = U256(block_number - ommer.number)
604
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
605
        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 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.dao_fork.vm.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
614
    """
615
    Execute a transaction against the provided environment.
616
617
    This function processes the actions needed to execute a transaction.
618
    It decrements the sender's account balance after calculating the gas fee
619
    and refunds them the proper amount after execution. Calling contracts,
620
    deploying code, and incrementing nonces are all examples of actions that
621
    happen within this function or from a call made within this function.
622
623
    Accounts that are marked for deletion are processed and destroyed after
624
    execution.
625
626
    Parameters
627
    ----------
628
    block_env :
629
        Environment for the Ethereum Virtual Machine.
630
    block_output :
631
        The block output for the current block.
632
    tx :
633
        Transaction to execute.
634
    index:
635
        Index of the transaction in the block.
636
637
    """
638
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
639
    intrinsic_gas = validate_transaction(tx)
640
641
    sender = check_transaction(
642
        block_env=block_env,
643
        block_output=block_output,
644
        tx=tx,
645
    )
646
647
    sender_account = get_account(block_env.state, sender)
648
649
    gas = tx.gas - intrinsic_gas
650
    increment_nonce(block_env.state, sender)
651
652
    gas_fee = tx.gas * tx.gas_price
653
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
654
    set_account_balance(
655
        block_env.state, sender, U256(sender_balance_after_gas_fee)
656
    )
657
658
    tx_env = vm.TransactionEnvironment(
659
        origin=sender,
660
        gas_price=tx.gas_price,
661
        gas=gas,
662
        index_in_block=index,
663
        tx_hash=get_transaction_hash(tx),
664
    )
665
666
    message = prepare_message(block_env, tx_env, tx)
667
668
    tx_output = process_message_call(message)
669
670
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
671
    tx_gas_refund = min(
672
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
673
    )
674
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
675
    tx_gas_left = tx.gas - tx_gas_used_after_refund
676
    gas_refund_amount = tx_gas_left * tx.gas_price
677
678
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
679
680
    # refund gas
681
    sender_balance_after_refund = get_account(
682
        block_env.state, sender
683
    ).balance + U256(gas_refund_amount)
684
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
685
686
    # transfer miner fees
687
    coinbase_balance_after_mining_fee = get_account(
688
        block_env.state, block_env.coinbase
689
    ).balance + U256(transaction_fee)
690
    set_account_balance(
691
        block_env.state, block_env.coinbase, coinbase_balance_after_mining_fee
692
    )
693
694
    for address in tx_output.accounts_to_delete:
695
        destroy_account(block_env.state, address)
696
697
    block_output.block_gas_used += tx_gas_used_after_refund
698
699
    receipt = make_receipt(
700
        state_root(block_env.state),
701
        block_output.block_gas_used,
702
        tx_output.logs,
703
    )
704
705
    receipt_key = rlp.encode(Uint(index))
706
    block_output.receipt_keys += (receipt_key,)
707
708
    trie_set(
709
        block_output.receipts_trie,
710
        receipt_key,
711
        receipt,
712
    )
713
714
    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:
718
    """
719
    Validates the gas limit for a block.
720
721
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
722
    quotient of the parent block's gas limit and the
723
    ``LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
724
    passed through as a parameter is greater than or equal to the *sum* of
725
    the parent's gas and the adjustment delta then the limit for gas is too
726
    high and fails this function's check. Similarly, if the limit is less
727
    than or equal to the *difference* of the parent's gas and the adjustment
728
    delta *or* the predefined ``LIMIT_MINIMUM`` then this function's
729
    check fails because the gas limit doesn't allow for a sufficient or
730
    reasonable amount of gas to be used on a block.
731
732
    Parameters
733
    ----------
734
    gas_limit :
735
        Gas limit to validate.
736
737
    parent_gas_limit :
738
        Gas limit of the parent block.
739
740
    Returns
741
    -------
742
    check : `bool`
743
        True if gas limit constraints are satisfied, False otherwise.
744
745
    """
746
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
747
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
748
        return False
749
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
750
        return False
751
    if gas_limit < GasCosts.LIMIT_MINIMUM:
752
        return False
753
754
    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.

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:
763
    """
764
    Computes difficulty of a block using its header and parent header.
765
766
    The difficulty is determined by the time the block was created after its
767
    parent. The ``offset`` is calculated using the parent block's difficulty,
768
    ``parent_difficulty``, and the timestamp between blocks. This offset is
769
    then added to the parent difficulty and is stored as the ``difficulty``
770
    variable. If the time between the block and its parent is too short, the
771
    offset will result in a positive number thus making the sum of
772
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
773
    avoid mass forking. But, if the time is long enough, then the offset
774
    results in a negative value making the block less difficult than
775
    its parent.
776
777
    The base standard for a block's difficulty is the predefined value
778
    set for the genesis block since it has no parent. So, a block
779
    can't be less difficult than the genesis block, therefore each block's
780
    difficulty is set to the maximum value between the calculated
781
    difficulty and the ``MINIMUM_DIFFICULTY``.
782
783
    Parameters
784
    ----------
785
    block_number :
786
        Block number of the block.
787
    block_timestamp :
788
        Timestamp of the block.
789
    parent_timestamp :
790
        Timestamp of the parent block.
791
    parent_difficulty :
792
        difficulty of the parent block.
793
794
    Returns
795
    -------
796
    difficulty : `ethereum.base_types.Uint`
797
        Computed difficulty for a block.
798
799
    """
800
    offset = (
801
        int(parent_difficulty)
802
        // 2048
803
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
804
    )
805
    difficulty = int(parent_difficulty) + offset
806
    # Historical Note: The difficulty bomb was not present in Ethereum at the
807
    # start of Frontier, but was added shortly after launch. However since the
808
    # bomb has no effect prior to block 200000 we pretend it existed from
809
    # genesis.
810
    # See https://github.com/ethereum/go-ethereum/pull/1588
811
    num_bomb_periods = (int(block_number) // 100000) - 2
812
    if num_bomb_periods >= 0:
813
        difficulty += 2**num_bomb_periods
814
815
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
816
    # the bomb. This bug does not matter because the difficulty is always much
817
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
818
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))