ethereum.tangerine_whistle.fork

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

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

GAS_LIMIT_ADJUSTMENT_FACTOR

49
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

50
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

51
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

52
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

55
@dataclass
class BlockChain:

blocks

61
    blocks: List[Block]

state

62
    state: State

chain_id

63
    chain_id: U64

apply_fork

Transforms the state from the previous hard fork (old) into the block chain object for this hard fork and returns it.

When forks need to implement an irregular state transition, this function is used to handle the irregularity. See the :ref:DAO Fork <dao-fork> for an example.

Parameters

old : Previous block chain object.

Returns

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

def apply_fork(old: BlockChain) -> BlockChain:
67
    """
68
    Transforms the state from the previous hard fork (`old`) into the block
69
    chain object for this hard fork and returns it.
70
71
    When forks need to implement an irregular state transition, this function
72
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
73
    an example.
74
75
    Parameters
76
    ----------
77
    old :
78
        Previous block chain object.
79
80
    Returns
81
    -------
82
    new : `BlockChain`
83
        Upgraded block chain object for this hard fork.
84
    """
85
    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]:
89
    """
90
    Obtain the list of hashes of the previous 256 blocks in order of
91
    increasing block number.
92
93
    This function will return less hashes for the first 256 blocks.
94
95
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
96
    therefore this function retrieves them.
97
98
    Parameters
99
    ----------
100
    chain :
101
        History and current state.
102
103
    Returns
104
    -------
105
    recent_block_hashes : `List[Hash32]`
106
        Hashes of the recent 256 blocks in order of increasing block number.
107
    """
108
    recent_blocks = chain.blocks[-255:]
109
    # TODO: This function has not been tested rigorously
110
    if len(recent_blocks) == 0:
111
        return []
112
113
    recent_block_hashes = []
114
115
    for block in recent_blocks:
116
        prev_block_hash = block.header.parent_hash
117
        recent_block_hashes.append(prev_block_hash)
118
119
    # We are computing the hash only for the most recent block and not for
120
    # the rest of the blocks as they have successors which have the hash of
121
    # the current block as parent hash.
122
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
123
    recent_block_hashes.append(most_recent_block_hash)
124
125
    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:
129
    """
130
    Attempts to apply a block to an existing block chain.
131
132
    All parts of the block's contents need to be verified before being added
133
    to the chain. Blocks are verified by ensuring that the contents of the
134
    block make logical sense with the contents of the parent block. The
135
    information in the block's header must also match the corresponding
136
    information in the block.
137
138
    To implement Ethereum, in theory clients are only required to store the
139
    most recent 255 blocks of the chain since as far as execution is
140
    concerned, only those blocks are accessed. Practically, however, clients
141
    should store more blocks to handle reorgs.
142
143
    Parameters
144
    ----------
145
    chain :
146
        History and current state.
147
    block :
148
        Block to apply to `chain`.
149
    """
150
    validate_header(chain, block.header)
151
    validate_ommers(block.ommers, block.header, chain)
152
153
    block_env = vm.BlockEnvironment(
154
        chain_id=chain.chain_id,
155
        state=chain.state,
156
        block_gas_limit=block.header.gas_limit,
157
        block_hashes=get_last_256_block_hashes(chain),
158
        coinbase=block.header.coinbase,
159
        number=block.header.number,
160
        time=block.header.timestamp,
161
        difficulty=block.header.difficulty,
162
    )
163
164
    block_output = apply_body(
165
        block_env=block_env,
166
        transactions=block.transactions,
167
        ommers=block.ommers,
168
    )
169
    block_state_root = state_root(block_env.state)
170
    transactions_root = root(block_output.transactions_trie)
171
    receipt_root = root(block_output.receipts_trie)
172
    block_logs_bloom = logs_bloom(block_output.block_logs)
173
174
    if block_output.block_gas_used != block.header.gas_used:
175
        raise InvalidBlock(
176
            f"{block_output.block_gas_used} != {block.header.gas_used}"
177
        )
178
    if transactions_root != block.header.transactions_root:
179
        raise InvalidBlock
180
    if block_state_root != block.header.state_root:
181
        raise InvalidBlock
182
    if receipt_root != block.header.receipt_root:
183
        raise InvalidBlock
184
    if block_logs_bloom != block.header.bloom:
185
        raise InvalidBlock
186
187
    chain.blocks.append(block)
188
    if len(chain.blocks) > 255:
189
        # Real clients have to store more blocks to deal with reorgs, but the
190
        # protocol only requires the last 255
191
        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:
195
    """
196
    Verifies a block header.
197
198
    In order to consider a block's header valid, the logic for the
199
    quantities in the header should match the logic for the block itself.
200
    For example the header timestamp should be greater than the block's parent
201
    timestamp because the block was created *after* the parent block.
202
    Additionally, the block's number should be directly following the parent
203
    block's number since it is the next block in the sequence.
204
205
    Parameters
206
    ----------
207
    chain :
208
        History and current state.
209
    header :
210
        Header to check for correctness.
211
    """
212
    if header.number < Uint(1):
213
        raise InvalidBlock
214
    parent_header_number = header.number - Uint(1)
215
    first_block_number = chain.blocks[0].header.number
216
    last_block_number = chain.blocks[-1].header.number
217
218
    if (
219
        parent_header_number < first_block_number
220
        or parent_header_number > last_block_number
221
    ):
222
        raise InvalidBlock
223
224
    parent_header = chain.blocks[
225
        parent_header_number - first_block_number
226
    ].header
227
228
    if header.gas_used > header.gas_limit:
229
        raise InvalidBlock
230
231
    if header.timestamp <= parent_header.timestamp:
232
        raise InvalidBlock
233
    if header.number != parent_header.number + Uint(1):
234
        raise InvalidBlock
235
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
236
        raise InvalidBlock
237
    if len(header.extra_data) > 32:
238
        raise InvalidBlock
239
240
    block_difficulty = calculate_block_difficulty(
241
        header.number,
242
        header.timestamp,
243
        parent_header.timestamp,
244
        parent_header.difficulty,
245
    )
246
    if header.difficulty != block_difficulty:
247
        raise InvalidBlock
248
249
    block_parent_hash = keccak256(rlp.encode(parent_header))
250
    if header.parent_hash != block_parent_hash:
251
        raise InvalidBlock
252
253
    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:
257
    """
258
    Generate rlp hash of the header which is to be used for Proof-of-Work
259
    verification.
260
261
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
262
    while calculating this hash.
263
264
    A particular PoW is valid for a single hash, that hash is computed by
265
    this function. The `nonce` and `mix_digest` are omitted from this hash
266
    because they are being changed by miners in their search for a sufficient
267
    proof-of-work.
268
269
    Parameters
270
    ----------
271
    header :
272
        The header object for which the hash is to be generated.
273
274
    Returns
275
    -------
276
    hash : `Hash32`
277
        The PoW valid rlp hash of the passed in header.
278
    """
279
    header_data_without_pow_artefacts = (
280
        header.parent_hash,
281
        header.ommers_hash,
282
        header.coinbase,
283
        header.state_root,
284
        header.transactions_root,
285
        header.receipt_root,
286
        header.bloom,
287
        header.difficulty,
288
        header.number,
289
        header.gas_limit,
290
        header.gas_used,
291
        header.timestamp,
292
        header.extra_data,
293
    )
294
295
    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:
299
    """
300
    Validates the Proof of Work constraints.
301
302
    In order to verify that a miner's proof-of-work is valid for a block, a
303
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
304
    hash function. The mix digest is a hash of the header and the nonce that
305
    is passed through and it confirms whether or not proof-of-work was done
306
    on the correct block. The result is the actual hash value of the block.
307
308
    Parameters
309
    ----------
310
    header :
311
        Header of interest.
312
    """
313
    header_hash = generate_header_hash_for_pow(header)
314
    # TODO: Memoize this somewhere and read from that data instead of
315
    # calculating cache for every block validation.
316
    cache = generate_cache(header.number)
317
    mix_digest, result = hashimoto_light(
318
        header_hash, header.nonce, cache, dataset_size(header.number)
319
    )
320
    if mix_digest != header.mix_digest:
321
        raise InvalidBlock
322
323
    limit = Uint(U256.MAX_VALUE) + Uint(1)
324
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
325
        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

InvalidBlock : If the transaction is not includable.

def check_transaction(block_env: ethereum.tangerine_whistle.vm.BlockEnvironment, ​​block_output: ethereum.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction) -> Address:
333
    """
334
    Check if the transaction is includable in the block.
335
336
    Parameters
337
    ----------
338
    block_env :
339
        The block scoped environment.
340
    block_output :
341
        The block output for the current block.
342
    tx :
343
        The transaction.
344
345
    Returns
346
    -------
347
    sender_address :
348
        The sender of the transaction.
349
350
    Raises
351
    ------
352
    InvalidBlock :
353
        If the transaction is not includable.
354
    """
355
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
356
    if tx.gas > gas_available:
357
        raise InvalidBlock
358
    sender_address = recover_sender(tx)
359
    sender_account = get_account(block_env.state, sender_address)
360
361
    max_gas_fee = tx.gas * tx.gas_price
362
363
    if sender_account.nonce != tx.nonce:
364
        raise InvalidBlock
365
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
366
        raise InvalidBlock
367
    if sender_account.code:
368
        raise InvalidSenderError("not EOA")
369
370
    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:
378
    """
379
    Make the receipt for a transaction that was executed.
380
381
    Parameters
382
    ----------
383
    post_state :
384
        The state root immediately after this transaction.
385
    cumulative_gas_used :
386
        The total gas used so far in the block after the transaction was
387
        executed.
388
    logs :
389
        The logs produced by the transaction.
390
391
    Returns
392
    -------
393
    receipt :
394
        The receipt for the transaction.
395
    """
396
    receipt = Receipt(
397
        post_state=post_state,
398
        cumulative_gas_used=cumulative_gas_used,
399
        bloom=logs_bloom(logs),
400
        logs=logs,
401
    )
402
403
    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.tangerine_whistle.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.tangerine_whistle.vm.BlockOutput:
411
    """
412
    Executes a block.
413
414
    Many of the contents of a block are stored in data structures called
415
    tries. There is a transactions trie which is similar to a ledger of the
416
    transactions stored in the current block. There is also a receipts trie
417
    which stores the results of executing a transaction, like the post state
418
    and gas used. This function creates and executes the block that is to be
419
    added to the chain.
420
421
    Parameters
422
    ----------
423
    block_env :
424
        The block scoped environment.
425
    transactions :
426
        Transactions included in the block.
427
    ommers :
428
        Headers of ancestor blocks which are not direct parents (formerly
429
        uncles.)
430
431
    Returns
432
    -------
433
    block_output :
434
        The block output for the current block.
435
    """
436
    block_output = vm.BlockOutput()
437
438
    for i, tx in enumerate(transactions):
439
        process_transaction(block_env, block_output, tx, Uint(i))
440
441
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
442
443
    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:
449
    """
450
    Validates the ommers mentioned in the block.
451
452
    An ommer block is a block that wasn't canonically added to the
453
    blockchain because it wasn't validated as fast as the canonical block
454
    but was mined at the same time.
455
456
    To be considered valid, the ommers must adhere to the rules defined in
457
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
458
    there cannot be duplicate ommers in a block. Many of the other ommer
459
    constraints are listed in the in-line comments of this function.
460
461
    Parameters
462
    ----------
463
    ommers :
464
        List of ommers mentioned in the current block.
465
    block_header:
466
        The header of current block.
467
    chain :
468
        History and current state.
469
    """
470
    block_hash = keccak256(rlp.encode(block_header))
471
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
472
        raise InvalidBlock
473
474
    if len(ommers) == 0:
475
        # Nothing to validate
476
        return
477
478
    # Check that each ommer satisfies the constraints of a header
479
    for ommer in ommers:
480
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
481
            raise InvalidBlock
482
        validate_header(chain, ommer)
483
    if len(ommers) > 2:
484
        raise InvalidBlock
485
486
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
487
    if len(ommers_hashes) != len(set(ommers_hashes)):
488
        raise InvalidBlock
489
490
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
491
    recent_canonical_block_hashes = {
492
        keccak256(rlp.encode(block.header))
493
        for block in recent_canonical_blocks
494
    }
495
    recent_ommers_hashes: Set[Hash32] = set()
496
    for block in recent_canonical_blocks:
497
        recent_ommers_hashes = recent_ommers_hashes.union(
498
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
499
        )
500
501
    for ommer_index, ommer in enumerate(ommers):
502
        ommer_hash = ommers_hashes[ommer_index]
503
        if ommer_hash == block_hash:
504
            raise InvalidBlock
505
        if ommer_hash in recent_canonical_block_hashes:
506
            raise InvalidBlock
507
        if ommer_hash in recent_ommers_hashes:
508
            raise InvalidBlock
509
510
        # Ommer age with respect to the current block. For example, an age of
511
        # 1 indicates that the ommer is a sibling of previous block.
512
        ommer_age = block_header.number - ommer.number
513
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
514
            raise InvalidBlock
515
        if ommer.parent_hash not in recent_canonical_block_hashes:
516
            raise InvalidBlock
517
        if ommer.parent_hash == block_header.parent_hash:
518
            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:
527
    """
528
    Pay rewards to the block miner as well as the ommers miners.
529
530
    The miner of the canonical block is rewarded with the predetermined
531
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
532
    number of ommer blocks that were mined around the same time, and included
533
    in the canonical block's header. An ommer block is a block that wasn't
534
    added to the canonical blockchain because it wasn't validated as fast as
535
    the accepted block but was mined at the same time. Although not all blocks
536
    that are mined are added to the canonical chain, miners are still paid a
537
    reward for their efforts. This reward is called an ommer reward and is
538
    calculated based on the number associated with the ommer block that they
539
    mined.
540
541
    Parameters
542
    ----------
543
    state :
544
        Current account state.
545
    block_number :
546
        Position of the block within the chain.
547
    coinbase :
548
        Address of account which receives block reward and transaction fees.
549
    ommers :
550
        List of ommers mentioned in the current block.
551
    """
552
    ommer_count = U256(len(ommers))
553
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
554
    create_ether(state, coinbase, miner_reward)
555
556
    for ommer in ommers:
557
        # Ommer age with respect to the current block.
558
        ommer_age = U256(block_number - ommer.number)
559
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
560
        create_ether(state, ommer.coinbase, ommer_miner_reward)

process_transaction

Execute a transaction against the provided environment.

This function processes the actions needed to execute a transaction. It decrements the sender's account after calculating the gas fee and refunds them the proper amount after execution. Calling contracts, deploying code, and incrementing nonces are all examples of actions that happen within this function or from a call made within this function.

Accounts that are marked for deletion are processed and destroyed after execution.

Parameters

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.tangerine_whistle.vm.BlockEnvironment, ​​block_output: ethereum.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
569
    """
570
    Execute a transaction against the provided environment.
571
572
    This function processes the actions needed to execute a transaction.
573
    It decrements the sender's account after calculating the gas fee and
574
    refunds them the proper amount after execution. Calling contracts,
575
    deploying code, and incrementing nonces are all examples of actions that
576
    happen within this function or from a call made within this function.
577
578
    Accounts that are marked for deletion are processed and destroyed after
579
    execution.
580
581
    Parameters
582
    ----------
583
    block_env :
584
        Environment for the Ethereum Virtual Machine.
585
    block_output :
586
        The block output for the current block.
587
    tx :
588
        Transaction to execute.
589
    index:
590
        Index of the transaction in the block.
591
    """
592
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
593
    intrinsic_gas = validate_transaction(tx)
594
595
    sender = check_transaction(
596
        block_env=block_env,
597
        block_output=block_output,
598
        tx=tx,
599
    )
600
601
    sender_account = get_account(block_env.state, sender)
602
603
    gas = tx.gas - intrinsic_gas
604
    increment_nonce(block_env.state, sender)
605
606
    gas_fee = tx.gas * tx.gas_price
607
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
608
    set_account_balance(
609
        block_env.state, sender, U256(sender_balance_after_gas_fee)
610
    )
611
612
    tx_env = vm.TransactionEnvironment(
613
        origin=sender,
614
        gas_price=tx.gas_price,
615
        gas=gas,
616
        index_in_block=index,
617
        tx_hash=get_transaction_hash(tx),
618
        traces=[],
619
    )
620
621
    message = prepare_message(block_env, tx_env, tx)
622
623
    tx_output = process_message_call(message)
624
625
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
626
    tx_gas_refund = min(
627
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
628
    )
629
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
630
    tx_gas_left = tx.gas - tx_gas_used_after_refund
631
    gas_refund_amount = tx_gas_left * tx.gas_price
632
633
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
634
635
    # refund gas
636
    sender_balance_after_refund = get_account(
637
        block_env.state, sender
638
    ).balance + U256(gas_refund_amount)
639
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
640
641
    # transfer miner fees
642
    coinbase_balance_after_mining_fee = get_account(
643
        block_env.state, block_env.coinbase
644
    ).balance + U256(transaction_fee)
645
    set_account_balance(
646
        block_env.state, block_env.coinbase, coinbase_balance_after_mining_fee
647
    )
648
649
    for address in tx_output.accounts_to_delete:
650
        destroy_account(block_env.state, address)
651
652
    block_output.block_gas_used += tx_gas_used_after_refund
653
654
    receipt = make_receipt(
655
        state_root(block_env.state),
656
        block_output.block_gas_used,
657
        tx_output.logs,
658
    )
659
660
    receipt_key = rlp.encode(Uint(index))
661
    block_output.receipt_keys += (receipt_key,)
662
663
    trie_set(
664
        block_output.receipts_trie,
665
        receipt_key,
666
        receipt,
667
    )
668
669
    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:
673
    """
674
    Validates the gas limit for a block.
675
676
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
677
    quotient of the parent block's gas limit and the
678
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
679
    passed through as a parameter is greater than or equal to the *sum* of
680
    the parent's gas and the adjustment delta then the limit for gas is too
681
    high and fails this function's check. Similarly, if the limit is less
682
    than or equal to the *difference* of the parent's gas and the adjustment
683
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
684
    check fails because the gas limit doesn't allow for a sufficient or
685
    reasonable amount of gas to be used on a block.
686
687
    Parameters
688
    ----------
689
    gas_limit :
690
        Gas limit to validate.
691
692
    parent_gas_limit :
693
        Gas limit of the parent block.
694
695
    Returns
696
    -------
697
    check : `bool`
698
        True if gas limit constraints are satisfied, False otherwise.
699
    """
700
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
701
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
702
        return False
703
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
704
        return False
705
    if gas_limit < GAS_LIMIT_MINIMUM:
706
        return False
707
708
    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:
717
    """
718
    Computes difficulty of a block using its header and parent header.
719
720
    The difficulty is determined by the time the block was created after its
721
    parent. The ``offset`` is calculated using the parent block's difficulty,
722
    ``parent_difficulty``, and the timestamp between blocks. This offset is
723
    then added to the parent difficulty and is stored as the ``difficulty``
724
    variable. If the time between the block and its parent is too short, the
725
    offset will result in a positive number thus making the sum of
726
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
727
    avoid mass forking. But, if the time is long enough, then the offset
728
    results in a negative value making the block less difficult than
729
    its parent.
730
731
    The base standard for a block's difficulty is the predefined value
732
    set for the genesis block since it has no parent. So, a block
733
    can't be less difficult than the genesis block, therefore each block's
734
    difficulty is set to the maximum value between the calculated
735
    difficulty and the ``GENESIS_DIFFICULTY``.
736
737
    Parameters
738
    ----------
739
    block_number :
740
        Block number of the block.
741
    block_timestamp :
742
        Timestamp of the block.
743
    parent_timestamp :
744
        Timestamp of the parent block.
745
    parent_difficulty :
746
        difficulty of the parent block.
747
748
    Returns
749
    -------
750
    difficulty : `ethereum.base_types.Uint`
751
        Computed difficulty for a block.
752
    """
753
    offset = (
754
        int(parent_difficulty)
755
        // 2048
756
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
757
    )
758
    difficulty = int(parent_difficulty) + offset
759
    # Historical Note: The difficulty bomb was not present in Ethereum at the
760
    # start of Frontier, but was added shortly after launch. However since the
761
    # bomb has no effect prior to block 200000 we pretend it existed from
762
    # genesis.
763
    # See https://github.com/ethereum/go-ethereum/pull/1588
764
    num_bomb_periods = (int(block_number) // 100000) - 2
765
    if num_bomb_periods >= 0:
766
        difficulty += 2**num_bomb_periods
767
768
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
769
    # the bomb. This bug does not matter because the difficulty is always much
770
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
771
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))