ethereum.forks.dao_fork.forkethereum.forks.tangerine_whistle.fork

Ethereum Specification.

.. _dao-fork:

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

Introduction

Entry point for the Ethereum specification.

BLOCK_REWARD

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

GAS_LIMIT_ADJUSTMENT_FACTOR

55
GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

GAS_LIMIT_MINIMUM

56
GAS_LIMIT_MINIMUM = Uint(5000)

MINIMUM_DIFFICULTY

57
MINIMUM_DIFFICULTY = Uint(131072)

MAX_OMMER_DEPTH

58
MAX_OMMER_DEPTH = Uint(6)

BlockChain

History and current state of the block chain.

61
@dataclass
class BlockChain:

blocks

67
    blocks: List[Block]

state

68
    state: State

chain_id

69
    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.is used to handle the irregularity. See the :ref:DAO Fork <dao-fork> for an example.

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:
73
    """
74
    Transforms the state from the previous hard fork (`old`) into the block
75
    chain object for this hard fork and returns it.
76
77
    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.
78
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
79
    an example.
80
81
    Parameters
82
    ----------
83
    old :
84
        Previous block chain object.
85
86
    Returns
87
    -------
88
    new : `BlockChain`
89
        Upgraded block chain object for this hard fork.
90
91
    """
102
    apply_dao(old.state)
92
    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]:
96
    """
97
    Obtain the list of hashes of the previous 256 blocks in order of
98
    increasing block number.
99
100
    This function will return less hashes for the first 256 blocks.
101
102
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
103
    therefore this function retrieves them.
104
105
    Parameters
106
    ----------
107
    chain :
108
        History and current state.
109
110
    Returns
111
    -------
112
    recent_block_hashes : `List[Hash32]`
113
        Hashes of the recent 256 blocks in order of increasing block number.
114
115
    """
116
    recent_blocks = chain.blocks[-255:]
117
    # TODO: This function has not been tested rigorously
118
    if len(recent_blocks) == 0:
119
        return []
120
121
    recent_block_hashes = []
122
123
    for block in recent_blocks:
124
        prev_block_hash = block.header.parent_hash
125
        recent_block_hashes.append(prev_block_hash)
126
127
    # We are computing the hash only for the most recent block and not for
128
    # the rest of the blocks as they have successors which have the hash of
129
    # the current block as parent hash.
130
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
131
    recent_block_hashes.append(most_recent_block_hash)
132
133
    return recent_block_hashes

state_transition

Attempts to apply a block to an existing block chain.

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

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

Parameters

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

def state_transition(chain: BlockChain, ​​block: Block) -> None:
137
    """
138
    Attempts to apply a block to an existing block chain.
139
140
    All parts of the block's contents need to be verified before being added
141
    to the chain. Blocks are verified by ensuring that the contents of the
142
    block make logical sense with the contents of the parent block. The
143
    information in the block's header must also match the corresponding
144
    information in the block.
145
146
    To implement Ethereum, in theory clients are only required to store the
147
    most recent 255 blocks of the chain since as far as execution is
148
    concerned, only those blocks are accessed. Practically, however, clients
149
    should store more blocks to handle reorgs.
150
151
    Parameters
152
    ----------
153
    chain :
154
        History and current state.
155
    block :
156
        Block to apply to `chain`.
157
158
    """
159
    validate_header(chain, block.header)
160
    validate_ommers(block.ommers, block.header, chain)
161
162
    block_env = vm.BlockEnvironment(
163
        chain_id=chain.chain_id,
164
        state=chain.state,
165
        block_gas_limit=block.header.gas_limit,
166
        block_hashes=get_last_256_block_hashes(chain),
167
        coinbase=block.header.coinbase,
168
        number=block.header.number,
169
        time=block.header.timestamp,
170
        difficulty=block.header.difficulty,
171
    )
172
173
    block_output = apply_body(
174
        block_env=block_env,
175
        transactions=block.transactions,
176
        ommers=block.ommers,
177
    )
178
    block_state_root = state_root(block_env.state)
179
    transactions_root = root(block_output.transactions_trie)
180
    receipt_root = root(block_output.receipts_trie)
181
    block_logs_bloom = logs_bloom(block_output.block_logs)
182
183
    if block_output.block_gas_used != block.header.gas_used:
184
        raise InvalidBlock(
185
            f"{block_output.block_gas_used} != {block.header.gas_used}"
186
        )
187
    if transactions_root != block.header.transactions_root:
188
        raise InvalidBlock
189
    if block_state_root != block.header.state_root:
190
        raise InvalidBlock
191
    if receipt_root != block.header.receipt_root:
192
        raise InvalidBlock
193
    if block_logs_bloom != block.header.bloom:
194
        raise InvalidBlock
195
196
    chain.blocks.append(block)
197
    if len(chain.blocks) > 255:
198
        # Real clients have to store more blocks to deal with reorgs, but the
199
        # protocol only requires the last 255
200
        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:
204
    """
205
    Verifies a block header.
206
207
    In order to consider a block's header valid, the logic for the
208
    quantities in the header should match the logic for the block itself.
209
    For example the header timestamp should be greater than the block's parent
210
    timestamp because the block was created *after* the parent block.
211
    Additionally, the block's number should be directly following the parent
212
    block's number since it is the next block in the sequence.
213
214
    Parameters
215
    ----------
216
    chain :
217
        History and current state.
218
    header :
219
        Header to check for correctness.
220
221
    """
222
    if header.number < Uint(1):
223
        raise InvalidBlock
224
    parent_header_number = header.number - Uint(1)
225
    first_block_number = chain.blocks[0].header.number
226
    last_block_number = chain.blocks[-1].header.number
227
228
    if (
229
        parent_header_number < first_block_number
230
        or parent_header_number > last_block_number
231
    ):
232
        raise InvalidBlock
233
234
    parent_header = chain.blocks[
235
        parent_header_number - first_block_number
236
    ].header
237
238
    if header.gas_used > header.gas_limit:
239
        raise InvalidBlock
240
241
    if header.timestamp <= parent_header.timestamp:
242
        raise InvalidBlock
243
    if header.number != parent_header.number + Uint(1):
244
        raise InvalidBlock
245
    if not check_gas_limit(header.gas_limit, parent_header.gas_limit):
246
        raise InvalidBlock
247
    if len(header.extra_data) > 32:
248
        raise InvalidBlock
249
250
    block_difficulty = calculate_block_difficulty(
251
        header.number,
252
        header.timestamp,
253
        parent_header.timestamp,
254
        parent_header.difficulty,
255
    )
256
    if header.difficulty != block_difficulty:
257
        raise InvalidBlock
258
259
    block_parent_hash = keccak256(rlp.encode(parent_header))
260
    if header.parent_hash != block_parent_hash:
261
        raise InvalidBlock
262
274
    if (
275
        header.number >= .block_number
276
        and header.number < .block_number + Uint(10)
277
    ):
278
        if header.extra_data != b"dao-hard-fork":
279
            raise InvalidBlock
280
263
    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:
267
    """
268
    Generate rlp hash of the header which is to be used for Proof-of-Work
269
    verification.
270
271
    In other words, the PoW artefacts `mix_digest` and `nonce` are ignored
272
    while calculating this hash.
273
274
    A particular PoW is valid for a single hash, that hash is computed by
275
    this function. The `nonce` and `mix_digest` are omitted from this hash
276
    because they are being changed by miners in their search for a sufficient
277
    proof-of-work.
278
279
    Parameters
280
    ----------
281
    header :
282
        The header object for which the hash is to be generated.
283
284
    Returns
285
    -------
286
    hash : `Hash32`
287
        The PoW valid rlp hash of the passed in header.
288
289
    """
290
    header_data_without_pow_artefacts = (
291
        header.parent_hash,
292
        header.ommers_hash,
293
        header.coinbase,
294
        header.state_root,
295
        header.transactions_root,
296
        header.receipt_root,
297
        header.bloom,
298
        header.difficulty,
299
        header.number,
300
        header.gas_limit,
301
        header.gas_used,
302
        header.timestamp,
303
        header.extra_data,
304
    )
305
306
    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:
310
    """
311
    Validates the Proof of Work constraints.
312
313
    In order to verify that a miner's proof-of-work is valid for a block, a
314
    ``mix-digest`` and ``result`` are calculated using the ``hashimoto_light``
315
    hash function. The mix digest is a hash of the header and the nonce that
316
    is passed through and it confirms whether or not proof-of-work was done
317
    on the correct block. The result is the actual hash value of the block.
318
319
    Parameters
320
    ----------
321
    header :
322
        Header of interest.
323
324
    """
325
    header_hash = generate_header_hash_for_pow(header)
326
    # TODO: Memoize this somewhere and read from that data instead of
327
    # calculating cache for every block validation.
328
    cache = generate_cache(header.number)
329
    mix_digest, result = hashimoto_light(
330
        header_hash, header.nonce, cache, dataset_size(header.number)
331
    )
332
    if mix_digest != header.mix_digest:
333
        raise InvalidBlock
334
335
    limit = Uint(U256.MAX_VALUE) + Uint(1)
336
    if Uint.from_be_bytes(result) > (limit // header.difficulty):
337
        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.BlockEnvironmentethereum.forks.tangerine_whistle.vm.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutputethereum.forks.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction) -> Address:
345
    """
346
    Check if the transaction is includable in the block.
347
348
    Parameters
349
    ----------
350
    block_env :
351
        The block scoped environment.
352
    block_output :
353
        The block output for the current block.
354
    tx :
355
        The transaction.
356
357
    Returns
358
    -------
359
    sender_address :
360
        The sender of the transaction.
361
362
    Raises
363
    ------
364
    GasUsedExceedsLimitError :
365
        If the gas used by the transaction exceeds the block's gas limit.
366
    NonceMismatchError :
367
        If the nonce of the transaction is not equal to the sender's nonce.
368
    InsufficientBalanceError :
369
        If the sender's balance is not enough to pay for the transaction.
370
    InvalidSenderError :
371
        If the transaction is from an address that does not exist anymore.
372
373
    """
374
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
375
    if tx.gas > gas_available:
376
        raise GasUsedExceedsLimitError("gas used exceeds limit")
377
    sender_address = recover_sender(tx)
378
    sender_account = get_account(block_env.state, sender_address)
379
380
    max_gas_fee = tx.gas * tx.gas_price
381
382
    if sender_account.nonce > Uint(tx.nonce):
383
        raise NonceMismatchError("nonce too low")
384
    elif sender_account.nonce < Uint(tx.nonce):
385
        raise NonceMismatchError("nonce too high")
386
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
387
        raise InsufficientBalanceError("insufficient sender balance")
388
    if sender_account.code:
389
        raise InvalidSenderError("not EOA")
390
391
    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:
399
    """
400
    Make the receipt for a transaction that was executed.
401
402
    Parameters
403
    ----------
404
    post_state :
405
        The state root immediately after this transaction.
406
    cumulative_gas_used :
407
        The total gas used so far in the block after the transaction was
408
        executed.
409
    logs :
410
        The logs produced by the transaction.
411
412
    Returns
413
    -------
414
    receipt :
415
        The receipt for the transaction.
416
417
    """
418
    receipt = Receipt(
419
        post_state=post_state,
420
        cumulative_gas_used=cumulative_gas_used,
421
        bloom=logs_bloom(logs),
422
        logs=logs,
423
    )
424
425
    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.BlockEnvironmentethereum.forks.tangerine_whistle.vm.BlockEnvironment, ​​transactions: Tuple[Transaction, ...], ​​ommers: Tuple[Header, ...]) -> ethereum.forks.dao_fork.vm.BlockOutputethereum.forks.tangerine_whistle.vm.BlockOutput:
433
    """
434
    Executes a block.
435
436
    Many of the contents of a block are stored in data structures called
437
    tries. There is a transactions trie which is similar to a ledger of the
438
    transactions stored in the current block. There is also a receipts trie
439
    which stores the results of executing a transaction, like the post state
440
    and gas used. This function creates and executes the block that is to be
441
    added to the chain.
442
443
    Parameters
444
    ----------
445
    block_env :
446
        The block scoped environment.
447
    transactions :
448
        Transactions included in the block.
449
    ommers :
450
        Headers of ancestor blocks which are not direct parents (formerly
451
        uncles.)
452
453
    Returns
454
    -------
455
    block_output :
456
        The block output for the current block.
457
458
    """
459
    block_output = vm.BlockOutput()
460
461
    for i, tx in enumerate(transactions):
462
        process_transaction(block_env, block_output, tx, Uint(i))
463
464
    pay_rewards(block_env.state, block_env.number, block_env.coinbase, ommers)
465
466
    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:
472
    """
473
    Validates the ommers mentioned in the block.
474
475
    An ommer block is a block that wasn't canonically added to the
476
    blockchain because it wasn't validated as fast as the canonical block
477
    but was mined at the same time.
478
479
    To be considered valid, the ommers must adhere to the rules defined in
480
    the Ethereum protocol. The maximum amount of ommers is 2 per block and
481
    there cannot be duplicate ommers in a block. Many of the other ommer
482
    constraints are listed in the in-line comments of this function.
483
484
    Parameters
485
    ----------
486
    ommers :
487
        List of ommers mentioned in the current block.
488
    block_header:
489
        The header of current block.
490
    chain :
491
        History and current state.
492
493
    """
494
    block_hash = keccak256(rlp.encode(block_header))
495
    if keccak256(rlp.encode(ommers)) != block_header.ommers_hash:
496
        raise InvalidBlock
497
498
    if len(ommers) == 0:
499
        # Nothing to validate
500
        return
501
502
    # Check that each ommer satisfies the constraints of a header
503
    for ommer in ommers:
504
        if Uint(1) > ommer.number or ommer.number >= block_header.number:
505
            raise InvalidBlock
506
        validate_header(chain, ommer)
507
    if len(ommers) > 2:
508
        raise InvalidBlock
509
510
    ommers_hashes = [keccak256(rlp.encode(ommer)) for ommer in ommers]
511
    if len(ommers_hashes) != len(set(ommers_hashes)):
512
        raise InvalidBlock
513
514
    recent_canonical_blocks = chain.blocks[-(MAX_OMMER_DEPTH + Uint(1)) :]
515
    recent_canonical_block_hashes = {
516
        keccak256(rlp.encode(block.header))
517
        for block in recent_canonical_blocks
518
    }
519
    recent_ommers_hashes: Set[Hash32] = set()
520
    for block in recent_canonical_blocks:
521
        recent_ommers_hashes = recent_ommers_hashes.union(
522
            {keccak256(rlp.encode(ommer)) for ommer in block.ommers}
523
        )
524
525
    for ommer_index, ommer in enumerate(ommers):
526
        ommer_hash = ommers_hashes[ommer_index]
527
        if ommer_hash == block_hash:
528
            raise InvalidBlock
529
        if ommer_hash in recent_canonical_block_hashes:
530
            raise InvalidBlock
531
        if ommer_hash in recent_ommers_hashes:
532
            raise InvalidBlock
533
534
        # Ommer age with respect to the current block. For example, an age of
535
        # 1 indicates that the ommer is a sibling of previous block.
536
        ommer_age = block_header.number - ommer.number
537
        if Uint(1) > ommer_age or ommer_age > MAX_OMMER_DEPTH:
538
            raise InvalidBlock
539
        if ommer.parent_hash not in recent_canonical_block_hashes:
540
            raise InvalidBlock
541
        if ommer.parent_hash == block_header.parent_hash:
542
            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:
551
    """
552
    Pay rewards to the block miner as well as the ommers miners.
553
554
    The miner of the canonical block is rewarded with the predetermined
555
    block reward, ``BLOCK_REWARD``, plus a variable award based off of the
556
    number of ommer blocks that were mined around the same time, and included
557
    in the canonical block's header. An ommer block is a block that wasn't
558
    added to the canonical blockchain because it wasn't validated as fast as
559
    the accepted block but was mined at the same time. Although not all blocks
560
    that are mined are added to the canonical chain, miners are still paid a
561
    reward for their efforts. This reward is called an ommer reward and is
562
    calculated based on the number associated with the ommer block that they
563
    mined.
564
565
    Parameters
566
    ----------
567
    state :
568
        Current account state.
569
    block_number :
570
        Position of the block within the chain.
571
    coinbase :
572
        Address of account which receives block reward and transaction fees.
573
    ommers :
574
        List of ommers mentioned in the current block.
575
576
    """
577
    ommer_count = U256(len(ommers))
578
    miner_reward = BLOCK_REWARD + (ommer_count * (BLOCK_REWARD // U256(32)))
579
    create_ether(state, coinbase, miner_reward)
580
581
    for ommer in ommers:
582
        # Ommer age with respect to the current block.
583
        ommer_age = U256(block_number - ommer.number)
584
        ommer_miner_reward = ((U256(8) - ommer_age) * BLOCK_REWARD) // U256(8)
585
        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.BlockEnvironmentethereum.forks.tangerine_whistle.vm.BlockEnvironment, ​​block_output: ethereum.forks.dao_fork.vm.BlockOutputethereum.forks.tangerine_whistle.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
594
    """
595
    Execute a transaction against the provided environment.
596
597
    This function processes the actions needed to execute a transaction.
598
    It decrements the sender's account balance after calculating the gas fee
599
    and refunds them the proper amount after execution. Calling contracts,
600
    deploying code, and incrementing nonces are all examples of actions that
601
    happen within this function or from a call made within this function.
602
603
    Accounts that are marked for deletion are processed and destroyed after
604
    execution.
605
606
    Parameters
607
    ----------
608
    block_env :
609
        Environment for the Ethereum Virtual Machine.
610
    block_output :
611
        The block output for the current block.
612
    tx :
613
        Transaction to execute.
614
    index:
615
        Index of the transaction in the block.
616
617
    """
618
    trie_set(block_output.transactions_trie, rlp.encode(Uint(index)), tx)
619
    intrinsic_gas = validate_transaction(tx)
620
621
    sender = check_transaction(
622
        block_env=block_env,
623
        block_output=block_output,
624
        tx=tx,
625
    )
626
627
    sender_account = get_account(block_env.state, sender)
628
629
    gas = tx.gas - intrinsic_gas
630
    increment_nonce(block_env.state, sender)
631
632
    gas_fee = tx.gas * tx.gas_price
633
    sender_balance_after_gas_fee = Uint(sender_account.balance) - gas_fee
634
    set_account_balance(
635
        block_env.state, sender, U256(sender_balance_after_gas_fee)
636
    )
637
638
    tx_env = vm.TransactionEnvironment(
639
        origin=sender,
640
        gas_price=tx.gas_price,
641
        gas=gas,
642
        index_in_block=index,
643
        tx_hash=get_transaction_hash(tx),
644
    )
645
646
    message = prepare_message(block_env, tx_env, tx)
647
648
    tx_output = process_message_call(message)
649
650
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
651
    tx_gas_refund = min(
652
        tx_gas_used_before_refund // Uint(2), Uint(tx_output.refund_counter)
653
    )
654
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
655
    tx_gas_left = tx.gas - tx_gas_used_after_refund
656
    gas_refund_amount = tx_gas_left * tx.gas_price
657
658
    transaction_fee = tx_gas_used_after_refund * tx.gas_price
659
660
    # refund gas
661
    sender_balance_after_refund = get_account(
662
        block_env.state, sender
663
    ).balance + U256(gas_refund_amount)
664
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
665
666
    # transfer miner fees
667
    coinbase_balance_after_mining_fee = get_account(
668
        block_env.state, block_env.coinbase
669
    ).balance + U256(transaction_fee)
670
    set_account_balance(
671
        block_env.state, block_env.coinbase, coinbase_balance_after_mining_fee
672
    )
673
674
    for address in tx_output.accounts_to_delete:
675
        destroy_account(block_env.state, address)
676
677
    block_output.block_gas_used += tx_gas_used_after_refund
678
679
    receipt = make_receipt(
680
        state_root(block_env.state),
681
        block_output.block_gas_used,
682
        tx_output.logs,
683
    )
684
685
    receipt_key = rlp.encode(Uint(index))
686
    block_output.receipt_keys += (receipt_key,)
687
688
    trie_set(
689
        block_output.receipts_trie,
690
        receipt_key,
691
        receipt,
692
    )
693
694
    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:
698
    """
699
    Validates the gas limit for a block.
700
701
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
702
    quotient of the parent block's gas limit and the
703
    ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
704
    passed through as a parameter is greater than or equal to the *sum* of
705
    the parent's gas and the adjustment delta then the limit for gas is too
706
    high and fails this function's check. Similarly, if the limit is less
707
    than or equal to the *difference* of the parent's gas and the adjustment
708
    delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's
709
    check fails because the gas limit doesn't allow for a sufficient or
710
    reasonable amount of gas to be used on a block.
711
712
    Parameters
713
    ----------
714
    gas_limit :
715
        Gas limit to validate.
716
717
    parent_gas_limit :
718
        Gas limit of the parent block.
719
720
    Returns
721
    -------
722
    check : `bool`
723
        True if gas limit constraints are satisfied, False otherwise.
724
725
    """
726
    max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR
727
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
728
        return False
729
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
730
        return False
731
    if gas_limit < GAS_LIMIT_MINIMUM:
732
        return False
733
734
    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:
743
    """
744
    Computes difficulty of a block using its header and parent header.
745
746
    The difficulty is determined by the time the block was created after its
747
    parent. The ``offset`` is calculated using the parent block's difficulty,
748
    ``parent_difficulty``, and the timestamp between blocks. This offset is
749
    then added to the parent difficulty and is stored as the ``difficulty``
750
    variable. If the time between the block and its parent is too short, the
751
    offset will result in a positive number thus making the sum of
752
    ``parent_difficulty`` and ``offset`` to be a greater value in order to
753
    avoid mass forking. But, if the time is long enough, then the offset
754
    results in a negative value making the block less difficult than
755
    its parent.
756
757
    The base standard for a block's difficulty is the predefined value
758
    set for the genesis block since it has no parent. So, a block
759
    can't be less difficult than the genesis block, therefore each block's
760
    difficulty is set to the maximum value between the calculated
761
    difficulty and the ``GENESIS_DIFFICULTY``.
762
763
    Parameters
764
    ----------
765
    block_number :
766
        Block number of the block.
767
    block_timestamp :
768
        Timestamp of the block.
769
    parent_timestamp :
770
        Timestamp of the parent block.
771
    parent_difficulty :
772
        difficulty of the parent block.
773
774
    Returns
775
    -------
776
    difficulty : `ethereum.base_types.Uint`
777
        Computed difficulty for a block.
778
779
    """
780
    offset = (
781
        int(parent_difficulty)
782
        // 2048
783
        * max(1 - int(block_timestamp - parent_timestamp) // 10, -99)
784
    )
785
    difficulty = int(parent_difficulty) + offset
786
    # Historical Note: The difficulty bomb was not present in Ethereum at the
787
    # start of Frontier, but was added shortly after launch. However since the
788
    # bomb has no effect prior to block 200000 we pretend it existed from
789
    # genesis.
790
    # See https://github.com/ethereum/go-ethereum/pull/1588
791
    num_bomb_periods = (int(block_number) // 100000) - 2
792
    if num_bomb_periods >= 0:
793
        difficulty += 2**num_bomb_periods
794
795
    # Some clients raise the difficulty to `MINIMUM_DIFFICULTY` prior to adding
796
    # the bomb. This bug does not matter because the difficulty is always much
797
    # greater than `MINIMUM_DIFFICULTY` on Mainnet.
798
    return Uint(max(difficulty, int(MINIMUM_DIFFICULTY)))