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

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

GAS_LIMIT_ADJUSTMENT_FACTOR

58
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

59
GAS_LIMIT_MINIMUM = Uint(5000)

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

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