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

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

GAS_LIMIT_ADJUSTMENT_FACTOR

59
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

60
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

61
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

62
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

65
@dataclass
class BlockChain:

blocks

71
    blocks: List[Block]

state

72
    state: State

chain_id

73
    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:
77
    """
78
    Transforms the state from the previous hard fork (`old`) into the block
79
    chain object for this hard fork and returns it.
80
81
    When forks need to implement an irregular state transition, this function
82
    is used to handle the irregularity.
83
84
    The DAO-Fork occurred as a result of the `2016 DAO Hacks
85
    <https://www.gemini.com/cryptopedia/the-dao-hack-makerdao>`_ in which an
86
    unknown entity managed to drain more than 3.6 million ether causing the
87
    price of ether to drop by nearly 35%. This fork was the solution to the
88
    hacks and manually reset the affected parties' accounts to their state
89
    prior to the attack. This fork essentially rewrote the history of the
90
    Ethereum network.
91
92
    Parameters
93
    ----------
94
    old :
95
        Previous block chain object.
96
97
    Returns
98
    -------
99
    new : `BlockChain`
100
        Upgraded block chain object for this hard fork.
101
102
    """
103
    apply_dao(old.state)
104
    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]:
108
    """
109
    Obtain the list of hashes of the previous 256 blocks in order of
110
    increasing block number.
111
112
    This function will return less hashes for the first 256 blocks.
113
114
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
115
    therefore this function retrieves them.
116
117
    Parameters
118
    ----------
119
    chain :
120
        History and current state.
121
122
    Returns
123
    -------
124
    recent_block_hashes : `List[Hash32]`
125
        Hashes of the recent 256 blocks in order of increasing block number.
126
127
    """
128
    recent_blocks = chain.blocks[-255:]
129
    # TODO: This function has not been tested rigorously
130
    if len(recent_blocks) == 0:
131
        return []
132
133
    recent_block_hashes = []
134
135
    for block in recent_blocks:
136
        prev_block_hash = block.header.parent_hash
137
        recent_block_hashes.append(prev_block_hash)
138
139
    # We are computing the hash only for the most recent block and not for
140
    # the rest of the blocks as they have successors which have the hash of
141
    # the current block as parent hash.
142
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
143
    recent_block_hashes.append(most_recent_block_hash)
144
145
    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:
149
    """
150
    Attempts to apply a block to an existing block chain.
151
152
    All parts of the block's contents need to be verified before being added
153
    to the chain. Blocks are verified by ensuring that the contents of the
154
    block make logical sense with the contents of the parent block. The
155
    information in the block's header must also match the corresponding
156
    information in the block.
157
158
    To implement Ethereum, in theory clients are only required to store the
159
    most recent 255 blocks of the chain since as far as execution is
160
    concerned, only those blocks are accessed. Practically, however, clients
161
    should store more blocks to handle reorgs.
162
163
    Parameters
164
    ----------
165
    chain :
166
        History and current state.
167
    block :
168
        Block to apply to `chain`.
169
170
    """
171
    validate_header(chain, block.header)
172
    validate_ommers(block.ommers, block.header, chain)
173
174
    block_env = vm.BlockEnvironment(
175
        chain_id=chain.chain_id,
176
        state=chain.state,
177
        block_gas_limit=block.header.gas_limit,
178
        block_hashes=get_last_256_block_hashes(chain),
179
        coinbase=block.header.coinbase,
180
        number=block.header.number,
181
        time=block.header.timestamp,
182
        difficulty=block.header.difficulty,
183
    )
184
185
    block_output = apply_body(
186
        block_env=block_env,
187
        transactions=block.transactions,
188
        ommers=block.ommers,
189
    )
190
    block_state_root = state_root(block_env.state)
191
    transactions_root = root(block_output.transactions_trie)
192
    receipt_root = root(block_output.receipts_trie)
193
    block_logs_bloom = logs_bloom(block_output.block_logs)
194
195
    if block_output.block_gas_used != block.header.gas_used:
196
        raise InvalidBlock(
197
            f"{block_output.block_gas_used} != {block.header.gas_used}"
198
        )
199
    if transactions_root != block.header.transactions_root:
200
        raise InvalidBlock
201
    if block_state_root != block.header.state_root:
202
        raise InvalidBlock
203
    if receipt_root != block.header.receipt_root:
204
        raise InvalidBlock
205
    if block_logs_bloom != block.header.bloom:
206
        raise InvalidBlock
207
208
    chain.blocks.append(block)
209
    if len(chain.blocks) > 255:
210
        # Real clients have to store more blocks to deal with reorgs, but the
211
        # protocol only requires the last 255
212
        chain.blocks = chain.blocks[-255:]

validate_header

Verifies a block header.

In order to consider a block's header valid, the logic for the quantities in the header should match the logic for the block itself. For example the header timestamp should be greater than the block's parent timestamp because the block was created after the parent block. Additionally, the block's number should be directly following the parent block's number since it is the next block in the sequence.

Parameters

chain : History and current state. header : Header to check for correctness.

def validate_header(chain: BlockChain, ​​header: Header) -> None:
216
    """
217
    Verifies a block header.
218
219
    In order to consider a block's header valid, the logic for the
220
    quantities in the header should match the logic for the block itself.
221
    For example the header timestamp should be greater than the block's parent
222
    timestamp because the block was created *after* the parent block.
223
    Additionally, the block's number should be directly following the parent
224
    block's number since it is the next block in the sequence.
225
226
    Parameters
227
    ----------
228
    chain :
229
        History and current state.
230
    header :
231
        Header to check for correctness.
232
233
    """
234
    if header.number < Uint(1):
235
        raise InvalidBlock
236
    parent_header_number = header.number - Uint(1)
237
    first_block_number = chain.blocks[0].header.number
238
    last_block_number = chain.blocks[-1].header.number
239
240
    if (
241
        parent_header_number < first_block_number
242
        or parent_header_number > last_block_number
243
    ):
244
        raise InvalidBlock
245
246
    parent_header = chain.blocks[
247
        parent_header_number - first_block_number
248
    ].header
249
250
    if header.gas_used > header.gas_limit:
251
        raise InvalidBlock
252
253
    if header.timestamp <= parent_header.timestamp:
254
        raise InvalidBlock
255
    if header.number != parent_header.number + Uint(1):
256
        raise InvalidBlock
257
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
258
        raise InvalidBlock
259
    if len(header.extra_data) > 32:
260
        raise InvalidBlock
261
262
    block_difficulty = calculate_block_difficulty(
263
        header.number,
264
        header.timestamp,
265
        parent_header.timestamp,
266
        parent_header.difficulty,
267
    )
268
    if header.difficulty != block_difficulty:
269
        raise InvalidBlock
270
271
    block_parent_hash = keccak256(rlp.encode(parent_header))
272
    if header.parent_hash != block_parent_hash:
273
        raise InvalidBlock
274
275
    assert isinstance(FORK_CRITERIA, ByBlockNumber)
276
277
    if (
278
        header.number >= FORK_CRITERIA.block_number
279
        and header.number < FORK_CRITERIA.block_number + Uint(10)
280
    ):
281
        if header.extra_data != b"dao-hard-fork":
282
            raise InvalidBlock
283
284
    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:
288
    """
289
    Generate rlp hash of the header which is to be used for Proof-of-Work
290
    verification.
291
292
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
293
    while calculating this hash.
294
295
    A particular PoW is valid for a single hash, that hash is computed by
296
    this function. The `nonce` and `mix_digest` are omitted from this hash
297
    because they are being changed by miners in their search for a sufficient
298
    proof-of-work.
299
300
    Parameters
301
    ----------
302
    header :
303
        The header object for which the hash is to be generated.
304
305
    Returns
306
    -------
307
    hash : `Hash32`
308
        The PoW valid rlp hash of the passed in header.
309
310
    """
311
    header_data_without_pow_artefacts = (
312
        header.parent_hash,
313
        header.ommers_hash,
314
        header.coinbase,
315
        header.state_root,
316
        header.transactions_root,
317
        header.receipt_root,
318
        header.bloom,
319
        header.difficulty,
320
        header.number,
321
        header.gas_limit,
322
        header.gas_used,
323
        header.timestamp,
324
        header.extra_data,
325
    )
326
327
    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:
331
    """
332
    Validates the Proof of Work constraints.
333
334
    In order to verify that a miner's proof-of-work is valid for a block, a
335
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
336
    hash function. The mix digest is a hash of the header and the nonce that
337
    is passed through and it confirms whether or not proof-of-work was done
338
    on the correct block. The result is the actual hash value of the block.
339
340
    Parameters
341
    ----------
342
    header :
343
        Header of interest.
344
345
    """
346
    header_hash = generate_header_hash_for_pow(header)
347
    # TODO: Memoize this somewhere and read from that data instead of
348
    # calculating cache for every block validation.
349
    cache = generate_cache(header.number)
350
    mix_digest, result = hashimoto_light(
351
        header_hash, header.nonce, cache, dataset_size(header.number)
352
    )
353
    if mix_digest != header.mix_digest:
354
        raise InvalidBlock
355
356
    limit = Uint(U256.MAX_VALUE) + Uint(1)
357
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
358
        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:
366
    """
367
    Check if the transaction is includable in the block.
368
369
    Parameters
370
    ----------
371
    block_env :
372
        The block scoped environment.
373
    block_output :
374
        The block output for the current block.
375
    tx :
376
        The transaction.
377
378
    Returns
379
    -------
380
    sender_address :
381
        The sender of the transaction.
382
383
    Raises
384
    ------
385
    GasUsedExceedsLimitError :
386
        If the gas used by the transaction exceeds the block's gas limit.
387
    NonceMismatchError :
388
        If the nonce of the transaction is not equal to the sender's nonce.
389
    InsufficientBalanceError :
390
        If the sender's balance is not enough to pay for the transaction.
391
    InvalidSenderError :
392
        If the transaction is from an address that does not exist anymore.
393
394
    """
395
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
396
    if tx.gas > gas_available:
397
        raise GasUsedExceedsLimitError("gas used exceeds limit")
398
    sender_address = recover_sender(tx)
399
    sender_account = get_account(block_env.state, sender_address)
400
401
    max_gas_fee = tx.gas * tx.gas_price
402
403
    if sender_account.nonce > Uint(tx.nonce):
404
        raise NonceMismatchError("nonce too low")
405
    elif sender_account.nonce < Uint(tx.nonce):
406
        raise NonceMismatchError("nonce too high")
407
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
408
        raise InsufficientBalanceError("insufficient sender balance")
409
    if sender_account.code:
410
        raise InvalidSenderError("not EOA")
411
412
    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:
420
    """
421
    Make the receipt for a transaction that was executed.
422
423
    Parameters
424
    ----------
425
    post_state :
426
        The state root immediately after this transaction.
427
    cumulative_gas_used :
428
        The total gas used so far in the block after the transaction was
429
        executed.
430
    logs :
431
        The logs produced by the transaction.
432
433
    Returns
434
    -------
435
    receipt :
436
        The receipt for the transaction.
437
438
    """
439
    receipt = Receipt(
440
        post_state=post_state,
441
        cumulative_gas_used=cumulative_gas_used,
442
        bloom=logs_bloom(logs),
443
        logs=logs,
444
    )
445
446
    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:
454
    """
455
    Executes a block.
456
457
    Many of the contents of a block are stored in data structures called
458
    tries. There is a transactions trie which is similar to a ledger of the
459
    transactions stored in the current block. There is also a receipts trie
460
    which stores the results of executing a transaction, like the post state
461
    and gas used. This function creates and executes the block that is to be
462
    added to the chain.
463
464
    Parameters
465
    ----------
466
    block_env :
467
        The block scoped environment.
468
    transactions :
469
        Transactions included in the block.
470
    ommers :
471
        Headers of ancestor blocks which are not direct parents (formerly
472
        uncles.)
473
474
    Returns
475
    -------
476
    block_output :
477
        The block output for the current block.
478
479
    """
480
    block_output = vm.BlockOutput()
481
482
    for i, tx in enumerate(transactions):
483
        process_transaction(block_env, block_output, tx, Uint(i))
484
485
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
486
487
    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:
493
    """
494
    Validates the ommers mentioned in the block.
495
496
    An ommer block is a block that wasn't canonically added to the
497
    blockchain because it wasn't validated as fast as the canonical block
498
    but was mined at the same time.
499
500
    To be considered valid, the ommers must adhere to the rules defined in
501
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
502
    there cannot be duplicate ommers in a block. Many of the other ommer
503
    constraints are listed in the in-line comments of this function.
504
505
    Parameters
506
    ----------
507
    ommers :
508
        List of ommers mentioned in the current block.
509
    block_header:
510
        The header of current block.
511
    chain :
512
        History and current state.
513
514
    """
515
    block_hash = keccak256(rlp.encode(block_header))
516
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
517
        raise InvalidBlock
518
519
    if len(ommers) == 0:
520
        # Nothing to validate
521
        return
522
523
    # Check that each ommer satisfies the constraints of a header
524
    for ommer in ommers:
525
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
526
            raise InvalidBlock
527
        validate_header(chain, ommer)
528
    if len(ommers) > 2:
529
        raise InvalidBlock
530
531
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
532
    if len(ommers_hashes) != len(set(ommers_hashes)):
533
        raise InvalidBlock
534
535
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
536
    recent_canonical_block_hashes = {
537
        keccak256(rlp.encode(block.header))
538
        for block in recent_canonical_blocks
539
    }
540
    recent_ommers_hashes: Set[Hash32] = set()
541
    for block in recent_canonical_blocks:
542
        recent_ommers_hashes = recent_ommers_hashes.union(
543
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
544
        )
545
546
    for ommer_index, ommer in enumerate(ommers):
547
        ommer_hash = ommers_hashes[ommer_index]
548
        if ommer_hash == block_hash:
549
            raise InvalidBlock
550
        if ommer_hash in recent_canonical_block_hashes:
551
            raise InvalidBlock
552
        if ommer_hash in recent_ommers_hashes:
553
            raise InvalidBlock
554
555
        # Ommer age with respect to the current block. For example, an age of
556
        # 1 indicates that the ommer is a sibling of previous block.
557
        ommer_age = block_header.number - ommer.number
558
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
559
            raise InvalidBlock
560
        if ommer.parent_hash not in recent_canonical_block_hashes:
561
            raise InvalidBlock
562
        if ommer.parent_hash == block_header.parent_hash:
563
            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:
572
    """
573
    Pay rewards to the block miner as well as the ommers miners.
574
575
    The miner of the canonical block is rewarded with the predetermined
576
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
577
    number of ommer blocks that were mined around the same time, and included
578
    in the canonical block's header. An ommer block is a block that wasn't
579
    added to the canonical blockchain because it wasn't validated as fast as
580
    the accepted block but was mined at the same time. Although not all blocks
581
    that are mined are added to the canonical chain, miners are still paid a
582
    reward for their efforts. This reward is called an ommer reward and is
583
    calculated based on the number associated with the ommer block that they
584
    mined.
585
586
    Parameters
587
    ----------
588
    state :
589
        Current account state.
590
    block_number :
591
        Position of the block within the chain.
592
    coinbase :
593
        Address of account which receives block reward and transaction fees.
594
    ommers :
595
        List of ommers mentioned in the current block.
596
597
    """
598
    ommer_count = U256(len(ommers))
599
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
600
    create_ether(state, coinbase, miner_reward)
601
602
    for ommer in ommers:
603
        # Ommer age with respect to the current block.
604
        ommer_age = U256(block_number - ommer.number)
605
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
606
        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:
615
    """
616
    Execute a transaction against the provided environment.
617
618
    This function processes the actions needed to execute a transaction.
619
    It decrements the sender's account balance after calculating the gas fee
620
    and refunds them the proper amount after execution. Calling contracts,
621
    deploying code, and incrementing nonces are all examples of actions that
622
    happen within this function or from a call made within this function.
623
624
    Accounts that are marked for deletion are processed and destroyed after
625
    execution.
626
627
    Parameters
628
    ----------
629
    block_env :
630
        Environment for the Ethereum Virtual Machine.
631
    block_output :
632
        The block output for the current block.
633
    tx :
634
        Transaction to execute.
635
    index:
636
        Index of the transaction in the block.
637
638
    """
639
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
640
    intrinsic_gas = validate_transaction(tx)
641
642
    sender = check_transaction(
643
        block_env=block_env,
644
        block_output=block_output,
645
        tx=tx,
646
    )
647
648
    sender_account = get_account(block_env.state, sender)
649
650
    gas = tx.gas - intrinsic_gas
651
    increment_nonce(block_env.state, sender)
652
653
    gas_fee = tx.gas * tx.gas_price
654
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
655
    set_account_balance(
656
        block_env.state, sender, U256(sender_balance_after_gas_fee)
657
    )
658
659
    tx_env = vm.TransactionEnvironment(
660
        origin=sender,
661
        gas_price=tx.gas_price,
662
        gas=gas,
663
        index_in_block=index,
664
        tx_hash=get_transaction_hash(tx),
665
    )
666
667
    message = prepare_message(block_env, tx_env, tx)
668
669
    tx_output = process_message_call(message)
670
671
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
672
    tx_gas_refund = min(
673
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
674
    )
675
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
676
    tx_gas_left = tx.gas - tx_gas_used_after_refund
677
    gas_refund_amount = tx_gas_left * tx.gas_price
678
679
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
680
681
    # refund gas
682
    sender_balance_after_refund = get_account(
683
        block_env.state, sender
684
    ).balance + U256(gas_refund_amount)
685
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
686
687
    # transfer miner fees
688
    coinbase_balance_after_mining_fee = get_account(
689
        block_env.state, block_env.coinbase
690
    ).balance + U256(transaction_fee)
691
    set_account_balance(
692
        block_env.state, block_env.coinbase, coinbase_balance_after_mining_fee
693
    )
694
695
    for address in tx_output.accounts_to_delete:
696
        destroy_account(block_env.state, address)
697
698
    block_output.block_gas_used += tx_gas_used_after_refund
699
700
    receipt = make_receipt(
701
        state_root(block_env.state),
702
        block_output.block_gas_used,
703
        tx_output.logs,
704
    )
705
706
    receipt_key = rlp.encode(Uint(index))
707
    block_output.receipt_keys += (receipt_key,)
708
709
    trie_set(
710
        block_output.receipts_trie,
711
        receipt_key,
712
        receipt,
713
    )
714
715
    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 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:
719
    """
720
    Validates the gas limit for a block.
721
722
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
723
    quotient of the parent block's gas limit and the
724
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
725
    passed through as a parameter is greater than or equal to the *sum* of
726
    the parent's gas and the adjustment delta then the limit for gas is too
727
    high and fails this function's check. Similarly, if the limit is less
728
    than or equal to the *difference* of the parent's gas and the adjustment
729
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
730
    check fails because the gas limit doesn't allow for a sufficient or
731
    reasonable amount of gas to be used on a block.
732
733
    Parameters
734
    ----------
735
    gas_limit :
736
        Gas limit to validate.
737
738
    parent_gas_limit :
739
        Gas limit of the parent block.
740
741
    Returns
742
    -------
743
    check : `bool`
744
        True if gas limit constraints are satisfied, False otherwise.
745
746
    """
747
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
748
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
749
        return False
750
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
751
        return False
752
    if gas_limit < GAS_LIMIT_MINIMUM:
753
        return False
754
755
    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:
764
    """
765
    Computes difficulty of a block using its header and parent header.
766
767
    The difficulty is determined by the time the block was created after its
768
    parent. The ``offset`` is calculated using the parent block's difficulty,
769
    ``parent_difficulty``, and the timestamp between blocks. This offset is
770
    then added to the parent difficulty and is stored as the ``difficulty``
771
    variable. If the time between the block and its parent is too short, the
772
    offset will result in a positive number thus making the sum of
773
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
774
    avoid mass forking. But, if the time is long enough, then the offset
775
    results in a negative value making the block less difficult than
776
    its parent.
777
778
    The base standard for a block's difficulty is the predefined value
779
    set for the genesis block since it has no parent. So, a block
780
    can't be less difficult than the genesis block, therefore each block's
781
    difficulty is set to the maximum value between the calculated
782
    difficulty and the ``MINIMUM_DIFFICULTY``.
783
784
    Parameters
785
    ----------
786
    block_number :
787
        Block number of the block.
788
    block_timestamp :
789
        Timestamp of the block.
790
    parent_timestamp :
791
        Timestamp of the parent block.
792
    parent_difficulty :
793
        difficulty of the parent block.
794
795
    Returns
796
    -------
797
    difficulty : `ethereum.base_types.Uint`
798
        Computed difficulty for a block.
799
800
    """
801
    offset = (
802
        int(parent_difficulty)
803
        // 2048
804
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
805
    )
806
    difficulty = int(parent_difficulty) + offset
807
    # Historical Note: The difficulty bomb was not present in Ethereum at the
808
    # start of Frontier, but was added shortly after launch. However since the
809
    # bomb has no effect prior to block 200000 we pretend it existed from
810
    # genesis.
811
    # See https://github.com/ethereum/go-ethereum/pull/1588
812
    num_bomb_periods = (int(block_number) // 100000) - 2
813
    if num_bomb_periods >= 0:
814
        difficulty += 2**num_bomb_periods
815
816
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
817
    # the bomb. This bug does not matter because the difficulty is always much
818
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
819
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))