ethereum.forks.shanghai.forkethereum.forks.cancun.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BASE_FEE_MAX_CHANGE_DENOMINATOR

87
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

88
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

89
EMPTY_OMMER_HASH = keccak256(rlp.encode([]))

SYSTEM_ADDRESS

90
SYSTEM_ADDRESS = hex_to_address("0xfffffffffffffffffffffffffffffffffffffffe")

BEACON_ROOTS_ADDRESS

91
BEACON_ROOTS_ADDRESS = hex_to_address(
92
    "0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02"
93
)

SYSTEM_TRANSACTION_GAS

94
SYSTEM_TRANSACTION_GAS = Uint(30000000)

MAX_BLOB_GAS_PER_BLOCK

95
MAX_BLOB_GAS_PER_BLOCK = U64(786432)

VERSIONED_HASH_VERSION_KZG

96
VERSIONED_HASH_VERSION_KZG = b"\x01"

BlockChain

History and current state of the block chain.

99
@dataclass
class BlockChain:

blocks

105
    blocks: List[Block]

state

106
    state: State

chain_id

107
    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:
111
    """
112
    Transforms the state from the previous hard fork (`old`) into the block
113
    chain object for this hard fork and returns it.
114
115
    When forks need to implement an irregular state transition, this function
116
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
117
    an example.
118
119
    Parameters
120
    ----------
121
    old :
122
        Previous block chain object.
123
124
    Returns
125
    -------
126
    new : `BlockChain`
127
        Upgraded block chain object for this hard fork.
128
129
    """
130
    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]:
134
    """
135
    Obtain the list of hashes of the previous 256 blocks in order of
136
    increasing block number.
137
138
    This function will return less hashes for the first 256 blocks.
139
140
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
141
    therefore this function retrieves them.
142
143
    Parameters
144
    ----------
145
    chain :
146
        History and current state.
147
148
    Returns
149
    -------
150
    recent_block_hashes : `List[Hash32]`
151
        Hashes of the recent 256 blocks in order of increasing block number.
152
153
    """
154
    recent_blocks = chain.blocks[-255:]
155
    # TODO: This function has not been tested rigorously
156
    if len(recent_blocks) == 0:
157
        return []
158
159
    recent_block_hashes = []
160
161
    for block in recent_blocks:
162
        prev_block_hash = block.header.parent_hash
163
        recent_block_hashes.append(prev_block_hash)
164
165
    # We are computing the hash only for the most recent block and not for
166
    # the rest of the blocks as they have successors which have the hash of
167
    # the current block as parent hash.
168
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
169
    recent_block_hashes.append(most_recent_block_hash)
170
171
    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:
175
    """
176
    Attempts to apply a block to an existing block chain.
177
178
    All parts of the block's contents need to be verified before being added
179
    to the chain. Blocks are verified by ensuring that the contents of the
180
    block make logical sense with the contents of the parent block. The
181
    information in the block's header must also match the corresponding
182
    information in the block.
183
184
    To implement Ethereum, in theory clients are only required to store the
185
    most recent 255 blocks of the chain since as far as execution is
186
    concerned, only those blocks are accessed. Practically, however, clients
187
    should store more blocks to handle reorgs.
188
189
    Parameters
190
    ----------
191
    chain :
192
        History and current state.
193
    block :
194
        Block to apply to `chain`.
195
196
    """
197
    validate_header(chain, block.header)
198
    if block.ommers != ():
199
        raise InvalidBlock
200
201
    block_state = BlockState(pre_state=chain.state)
202
203
    block_env = vm.BlockEnvironment(
204
        chain_id=chain.chain_id,
205
        state=block_state,
206
        block_gas_limit=block.header.gas_limit,
207
        block_hashes=get_last_256_block_hashes(chain),
208
        coinbase=block.header.coinbase,
209
        number=block.header.number,
210
        base_fee_per_gas=block.header.base_fee_per_gas,
211
        time=block.header.timestamp,
212
        prev_randao=block.header.prev_randao,
213
        excess_blob_gas=block.header.excess_blob_gas,
214
        parent_beacon_block_root=block.header.parent_beacon_block_root,
215
    )
216
217
    block_output = apply_body(
218
        block_env=block_env,
219
        transactions=block.transactions,
220
        withdrawals=block.withdrawals,
221
    )
222
    block_diff = extract_block_diff(block_state)
223
    block_state_root, _ = chain.state.compute_state_root_and_trie_changes(
199
        block_diff.account_changes,
200
        block_diff.storage_changes,
201
        block_diff.storage_clears,
224
        block_diff.account_changes, block_diff.storage_changes
225
    )
226
    transactions_root = root(block_output.transactions_trie)
227
    receipt_root = root(block_output.receipts_trie)
228
    block_logs_bloom = logs_bloom(block_output.block_logs)
229
    withdrawals_root = root(block_output.withdrawals_trie)
230
231
    if block_output.block_gas_used != block.header.gas_used:
232
        raise InvalidBlock(
233
            f"{block_output.block_gas_used} != {block.header.gas_used}"
234
        )
235
    if transactions_root != block.header.transactions_root:
236
        raise InvalidBlock
237
    if block_state_root != block.header.state_root:
238
        raise InvalidBlock
239
    if receipt_root != block.header.receipt_root:
240
        raise InvalidBlock
241
    if block_logs_bloom != block.header.bloom:
242
        raise InvalidBlock
243
    if withdrawals_root != block.header.withdrawals_root:
244
        raise InvalidBlock
245
    if block_output.blob_gas_used != block.header.blob_gas_used:
246
        raise InvalidBlock
247
248
    apply_changes_to_state(chain.state, block_diff)
249
    chain.blocks.append(block)
250
    if len(chain.blocks) > 255:
251
        # Real clients have to store more blocks to deal with reorgs, but the
252
        # protocol only requires the last 255
253
        chain.blocks = chain.blocks[-255:]

calculate_base_fee_per_gas

Calculates the base fee per gas for the block.

Parameters

block_gas_limit : Gas limit of the block for which the base fee is being calculated. parent_gas_limit : Gas limit of the parent block. parent_gas_used : Gas used in the parent block. parent_base_fee_per_gas : Base fee per gas of the parent block.

Returns

base_fee_per_gas : Uint Base fee per gas for the block.

def calculate_base_fee_per_gas(block_gas_limit: Uint, ​​parent_gas_limit: Uint, ​​parent_gas_used: Uint, ​​parent_base_fee_per_gas: Uint) -> Uint:
262
    """
263
    Calculates the base fee per gas for the block.
264
265
    Parameters
266
    ----------
267
    block_gas_limit :
268
        Gas limit of the block for which the base fee is being calculated.
269
    parent_gas_limit :
270
        Gas limit of the parent block.
271
    parent_gas_used :
272
        Gas used in the parent block.
273
    parent_base_fee_per_gas :
274
        Base fee per gas of the parent block.
275
276
    Returns
277
    -------
278
    base_fee_per_gas : `Uint`
279
        Base fee per gas for the block.
280
281
    """
282
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
283
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
284
        raise InvalidBlock
285
286
    if parent_gas_used == parent_gas_target:
287
        expected_base_fee_per_gas = parent_base_fee_per_gas
288
    elif parent_gas_used > parent_gas_target:
289
        gas_used_delta = parent_gas_used - parent_gas_target
290
291
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
292
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
293
294
        base_fee_per_gas_delta = max(
295
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
296
            Uint(1),
297
        )
298
299
        expected_base_fee_per_gas = (
300
            parent_base_fee_per_gas + base_fee_per_gas_delta
301
        )
302
    else:
303
        gas_used_delta = parent_gas_target - parent_gas_used
304
305
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
306
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
307
308
        base_fee_per_gas_delta = (
309
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
310
        )
311
312
        expected_base_fee_per_gas = (
313
            parent_base_fee_per_gas - base_fee_per_gas_delta
314
        )
315
316
    return Uint(expected_base_fee_per_gas)

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:
320
    """
321
    Verifies a block header.
322
323
    In order to consider a block's header valid, the logic for the
324
    quantities in the header should match the logic for the block itself.
325
    For example the header timestamp should be greater than the block's parent
326
    timestamp because the block was created *after* the parent block.
327
    Additionally, the block's number should be directly following the parent
328
    block's number since it is the next block in the sequence.
329
330
    Parameters
331
    ----------
332
    chain :
333
        History and current state.
334
    header :
335
        Header to check for correctness.
336
337
    """
338
    if header.number < Uint(1):
339
        raise InvalidBlock
340
341
    parent_header = chain.blocks[-1].header
342
343
    excess_blob_gas = calculate_excess_blob_gas(parent_header)
344
    if header.excess_blob_gas != excess_blob_gas:
345
        raise InvalidBlock
346
347
    if header.gas_used > header.gas_limit:
348
        raise InvalidBlock
349
350
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
351
        header.gas_limit,
352
        parent_header.gas_limit,
353
        parent_header.gas_used,
354
        parent_header.base_fee_per_gas,
355
    )
356
    if expected_base_fee_per_gas != header.base_fee_per_gas:
357
        raise InvalidBlock
358
    if header.timestamp <= parent_header.timestamp:
359
        raise InvalidBlock
360
    if header.number != parent_header.number + Uint(1):
361
        raise InvalidBlock
362
    if len(header.extra_data) > 32:
363
        raise InvalidBlock
364
    if header.difficulty != 0:
365
        raise InvalidBlock
366
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
367
        raise InvalidBlock
368
    if header.ommers_hash != EMPTY_OMMER_HASH:
369
        raise InvalidBlock
370
371
    block_parent_hash = keccak256(rlp.encode(parent_header))
372
    if header.parent_hash != block_parent_hash:
373
        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. tx_state : The transaction state tracker.

Returns

sender_address : The sender of the transaction. effective_gas_price : The price to charge for gas when the transaction is executed. blob_versioned_hashes : The blob versioned hashes of the transaction. tx_blob_gas_used: The blob gas used by the transaction.

Raises

InvalidBlock : If the transaction is not includable. 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. PriorityFeeGreaterThanMaxFeeError : If the priority fee is greater than the maximum fee per gas. InsufficientMaxFeePerGasError : If the maximum fee per gas is insufficient for the transaction. InsufficientMaxFeePerBlobGasError : If the maximum fee per blob gas is insufficient for the transaction. BlobGasLimitExceededError : If the blob gas used by the transaction exceeds the block's blob gas limit. InvalidBlobVersionedHashError : If the transaction contains a blob versioned hash with an invalid version. NoBlobDataError : If the transaction is a type 3 but has no blobs. TransactionTypeContractCreationError: If the transaction type is not allowed to create contracts.

def check_transaction(block_env: ethereum.forks.shanghai.vm.BlockEnvironmentethereum.forks.cancun.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutputethereum.forks.cancun.vm.BlockOutput, ​​tx: Transaction, ​​tx_state: TransactionState) -> Tuple[Address, Uint, Tuple[VersionedHash, ...]U64]:
382
    """
383
    Check if the transaction is includable in the block.
384
385
    Parameters
386
    ----------
387
    block_env :
388
        The block scoped environment.
389
    block_output :
390
        The block output for the current block.
391
    tx :
392
        The transaction.
393
    tx_state :
394
        The transaction state tracker.
395
396
    Returns
397
    -------
398
    sender_address :
399
        The sender of the transaction.
400
    effective_gas_price :
401
        The price to charge for gas when the transaction is executed.
402
    blob_versioned_hashes :
403
        The blob versioned hashes of the transaction.
404
    tx_blob_gas_used:
405
        The blob gas used by the transaction.
406
407
    Raises
408
    ------
409
    InvalidBlock :
410
        If the transaction is not includable.
411
    GasUsedExceedsLimitError :
412
        If the gas used by the transaction exceeds the block's gas limit.
413
    NonceMismatchError :
414
        If the nonce of the transaction is not equal to the sender's nonce.
415
    InsufficientBalanceError :
416
        If the sender's balance is not enough to pay for the transaction.
417
    InvalidSenderError :
418
        If the transaction is from an address that does not exist anymore.
419
    PriorityFeeGreaterThanMaxFeeError :
420
        If the priority fee is greater than the maximum fee per gas.
421
    InsufficientMaxFeePerGasError :
422
        If the maximum fee per gas is insufficient for the transaction.
423
    InsufficientMaxFeePerBlobGasError :
424
        If the maximum fee per blob gas is insufficient for the transaction.
425
    BlobGasLimitExceededError :
426
        If the blob gas used by the transaction exceeds the block's blob gas
427
        limit.
428
    InvalidBlobVersionedHashError :
429
        If the transaction contains a blob versioned hash with an invalid
430
        version.
431
    NoBlobDataError :
432
        If the transaction is a type 3 but has no blobs.
433
    TransactionTypeContractCreationError:
434
        If the transaction type is not allowed to create contracts.
435
436
    """
437
    gas_available = block_env.block_gas_limit - block_output.block_gas_used
438
    blob_gas_available = MAX_BLOB_GAS_PER_BLOCK - block_output.blob_gas_used
439
440
    if tx.gas > gas_available:
441
        raise GasUsedExceedsLimitError("gas used exceeds limit")
442
443
    tx_blob_gas_used = calculate_total_blob_gas(tx)
444
    if tx_blob_gas_used > blob_gas_available:
445
        raise BlobGasLimitExceededError("blob gas limit exceeded")
446
447
    sender_address = recover_sender(block_env.chain_id, tx)
448
    sender_account = get_account(tx_state, sender_address)
449
398
    if isinstance(tx, FeeMarketTransaction):
450
    if isinstance(tx, (FeeMarketTransaction, BlobTransaction)):
451
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
452
            raise PriorityFeeGreaterThanMaxFeeError(
453
                "priority fee greater than max fee"
454
            )
455
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
456
            raise InsufficientMaxFeePerGasError(
457
                tx.max_fee_per_gas, block_env.base_fee_per_gas
458
            )
459
460
        priority_fee_per_gas = min(
461
            tx.max_priority_fee_per_gas,
462
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
463
        )
464
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
465
        max_gas_fee = tx.gas * tx.max_fee_per_gas
466
    else:
467
        if tx.gas_price < block_env.base_fee_per_gas:
468
            raise InvalidBlock
469
        effective_gas_price = tx.gas_price
470
        max_gas_fee = tx.gas * tx.gas_price
471
472
    if isinstance(tx, BlobTransaction):
473
        if not isinstance(tx.to, Address):
474
            raise TransactionTypeContractCreationError(tx)
475
        if len(tx.blob_versioned_hashes) == 0:
476
            raise NoBlobDataError("no blob data in transaction")
477
        for blob_versioned_hash in tx.blob_versioned_hashes:
478
            if blob_versioned_hash[0:1] != VERSIONED_HASH_VERSION_KZG:
479
                raise InvalidBlobVersionedHashError(
480
                    "invalid blob versioned hash"
481
                )
482
483
        blob_gas_price = calculate_blob_gas_price(block_env.excess_blob_gas)
484
        if Uint(tx.max_fee_per_blob_gas) < blob_gas_price:
485
            raise InsufficientMaxFeePerBlobGasError(
486
                "insufficient max fee per blob gas"
487
            )
488
489
        max_gas_fee += Uint(calculate_total_blob_gas(tx)) * Uint(
490
            tx.max_fee_per_blob_gas
491
        )
492
        blob_versioned_hashes = tx.blob_versioned_hashes
493
    else:
494
        blob_versioned_hashes = ()
495
    if sender_account.nonce > Uint(tx.nonce):
496
        raise NonceMismatchError("nonce too low")
497
    elif sender_account.nonce < Uint(tx.nonce):
498
        raise NonceMismatchError("nonce too high")
499
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
500
        raise InsufficientBalanceError("insufficient sender balance")
501
    if sender_account.code_hash != EMPTY_CODE_HASH:
502
        raise InvalidSenderError("not EOA")
503
429
    return sender_address, effective_gas_price
504
    return (
505
        sender_address,
506
        effective_gas_price,
507
        blob_versioned_hashes,
508
        tx_blob_gas_used,
509
    )

make_receipt

Make the receipt for a transaction that was executed.

Parameters

tx : The executed transaction. error : Error in the top level frame of the transaction, if any. 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(tx: Transaction, ​​error: Optional[EthereumException], ​​cumulative_gas_used: Uint, ​​logs: Tuple[Log, ...]) -> Bytes | Receipt:
518
    """
519
    Make the receipt for a transaction that was executed.
520
521
    Parameters
522
    ----------
523
    tx :
524
        The executed transaction.
525
    error :
526
        Error in the top level frame of the transaction, if any.
527
    cumulative_gas_used :
528
        The total gas used so far in the block after the transaction was
529
        executed.
530
    logs :
531
        The logs produced by the transaction.
532
533
    Returns
534
    -------
535
    receipt :
536
        The receipt for the transaction.
537
538
    """
539
    receipt = Receipt(
540
        succeeded=error is None,
541
        cumulative_gas_used=cumulative_gas_used,
542
        bloom=logs_bloom(logs),
543
        logs=logs,
544
    )
545
546
    return encode_receipt(tx, receipt)

process_unchecked_system_transaction

Process a system transaction without checking if the contract contains code or if the transaction fails.

Parameters

block_env : The block scoped environment. target_address : Address of the contract to call. data : Data to pass to the contract.

Returns

system_tx_output : MessageCallOutput Output of processing the system transaction.

def process_unchecked_system_transaction(block_env: ethereum.forks.cancun.vm.BlockEnvironment, ​​target_address: Address, ​​data: Bytes) -> MessageCallOutput:
554
    """
555
    Process a system transaction without checking if the contract contains
556
    code or if the transaction fails.
557
558
    Parameters
559
    ----------
560
    block_env :
561
        The block scoped environment.
562
    target_address :
563
        Address of the contract to call.
564
    data :
565
        Data to pass to the contract.
566
567
    Returns
568
    -------
569
    system_tx_output : `MessageCallOutput`
570
        Output of processing the system transaction.
571
572
    """
573
    system_tx_state = TransactionState(parent=block_env.state)
574
    system_contract_code = get_code(
575
        system_tx_state,
576
        get_account(system_tx_state, target_address).code_hash,
577
    )
578
579
    tx_env = vm.TransactionEnvironment(
580
        origin=SYSTEM_ADDRESS,
581
        gas_price=block_env.base_fee_per_gas,
582
        gas=SYSTEM_TRANSACTION_GAS,
583
        access_list_addresses=set(),
584
        access_list_storage_keys=set(),
585
        state=system_tx_state,
586
        blob_versioned_hashes=(),
587
        index_in_block=None,
588
        tx_hash=None,
589
    )
590
591
    system_tx_message = Message(
592
        block_env=block_env,
593
        tx_env=tx_env,
594
        caller=SYSTEM_ADDRESS,
595
        target=target_address,
596
        gas=SYSTEM_TRANSACTION_GAS,
597
        value=U256(0),
598
        data=data,
599
        code=system_contract_code,
600
        depth=Uint(0),
601
        current_target=target_address,
602
        code_address=target_address,
603
        should_transfer_value=False,
604
        is_static=False,
605
        accessed_addresses=set(),
606
        accessed_storage_keys=set(),
607
        parent_evm=None,
608
    )
609
610
    system_tx_output = process_message_call(system_tx_message)
611
612
    incorporate_tx_into_block(system_tx_state)
613
614
    return system_tx_output

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. block_output : The block output for the current block. transactions : Transactions included in the block. withdrawals : Withdrawals to be processed in the current block.

Returns

block_output : The block output for the current block.

def apply_body(block_env: ethereum.forks.shanghai.vm.BlockEnvironmentethereum.forks.cancun.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​withdrawals: Tuple[Withdrawal, ...]) -> ethereum.forks.shanghai.vm.BlockOutputethereum.forks.cancun.vm.BlockOutput:
622
    """
623
    Executes a block.
624
625
    Many of the contents of a block are stored in data structures called
626
    tries. There is a transactions trie which is similar to a ledger of the
627
    transactions stored in the current block. There is also a receipts trie
628
    which stores the results of executing a transaction, like the post state
629
    and gas used. This function creates and executes the block that is to be
630
    added to the chain.
631
632
    Parameters
633
    ----------
634
    block_env :
635
        The block scoped environment.
488
    block_output :
489
        The block output for the current block.
636
    transactions :
637
        Transactions included in the block.
638
    withdrawals :
639
        Withdrawals to be processed in the current block.
640
641
    Returns
642
    -------
643
    block_output :
644
        The block output for the current block.
645
646
    """
647
    block_output = vm.BlockOutput()
648
649
    process_unchecked_system_transaction(
650
        block_env=block_env,
651
        target_address=BEACON_ROOTS_ADDRESS,
652
        data=block_env.parent_beacon_block_root,
653
    )
654
655
    for i, tx in enumerate(map(decode_transaction, transactions)):
656
        process_transaction(block_env, block_output, tx, Uint(i))
657
658
    process_withdrawals(block_env, block_output, withdrawals)
659
660
    return block_output

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.shanghai.vm.BlockEnvironmentethereum.forks.cancun.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutputethereum.forks.cancun.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
669
    """
670
    Execute a transaction against the provided environment.
671
672
    This function processes the actions needed to execute a transaction.
673
    It decrements the sender's account balance after calculating the gas fee
674
    and refunds them the proper amount after execution. Calling contracts,
675
    deploying code, and incrementing nonces are all examples of actions that
676
    happen within this function or from a call made within this function.
677
678
    Accounts that are marked for deletion are processed and destroyed after
679
    execution.
680
681
    Parameters
682
    ----------
683
    block_env :
684
        Environment for the Ethereum Virtual Machine.
685
    block_output :
686
        The block output for the current block.
687
    tx :
688
        Transaction to execute.
689
    index:
690
        Index of the transaction in the block.
691
692
    """
693
    tx_state = TransactionState(parent=block_env.state)
694
695
    trie_set(
696
        block_output.transactions_trie,
697
        rlp.encode(index),
698
        encode_transaction(tx),
699
    )
700
701
    intrinsic_gas = validate_transaction(tx)
702
703
    (
704
        sender,
553
        effective_gas_price,
705
        effective_gas_price,
706
        blob_versioned_hashes,
707
        tx_blob_gas_used,
708
    ) = check_transaction(
709
        block_env=block_env,
710
        block_output=block_output,
711
        tx=tx,
712
        tx_state=tx_state,
713
    )
714
715
    sender_account = get_account(tx_state, sender)
716
717
    if isinstance(tx, BlobTransaction):
718
        blob_gas_fee = calculate_data_fee(block_env.excess_blob_gas, tx)
719
    else:
720
        blob_gas_fee = Uint(0)
721
722
    effective_gas_fee = tx.gas * effective_gas_price
723
724
    gas = tx.gas - intrinsic_gas
725
    increment_nonce(tx_state, sender)
726
727
    sender_balance_after_gas_fee = (
569
        Uint(sender_account.balance) - effective_gas_fee
728
        Uint(sender_account.balance) - effective_gas_fee - blob_gas_fee
729
    )
730
    set_account_balance(tx_state, sender, U256(sender_balance_after_gas_fee))
731
732
    access_list_addresses = set()
733
    access_list_storage_keys = set()
734
    access_list_addresses.add(block_env.coinbase)
576
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
735
    if isinstance(
736
        tx, (AccessListTransaction, FeeMarketTransaction, BlobTransaction)
737
    ):
738
        for access in tx.access_list:
739
            access_list_addresses.add(access.account)
740
            for slot in access.slots:
741
                access_list_storage_keys.add((access.account, slot))
742
743
    tx_env = vm.TransactionEnvironment(
744
        origin=sender,
745
        gas_price=effective_gas_price,
746
        gas=gas,
747
        access_list_addresses=access_list_addresses,
748
        access_list_storage_keys=access_list_storage_keys,
749
        state=tx_state,
750
        blob_versioned_hashes=blob_versioned_hashes,
751
        index_in_block=index,
752
        tx_hash=get_transaction_hash(encode_transaction(tx)),
753
    )
754
755
    message = prepare_message(block_env, tx_env, tx)
756
757
    tx_output = process_message_call(message)
758
759
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
760
    tx_gas_refund = min(
761
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
762
    )
763
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
764
    tx_gas_left = tx.gas - tx_gas_used_after_refund
765
    gas_refund_amount = tx_gas_left * effective_gas_price
766
767
    # For non-1559 transactions effective_gas_price == tx.gas_price
768
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
769
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
770
771
    # refund gas
772
    sender_balance_after_refund = get_account(tx_state, sender).balance + U256(
773
        gas_refund_amount
774
    )
775
    set_account_balance(tx_state, sender, sender_balance_after_refund)
776
777
    # transfer miner fees
778
    coinbase_balance_after_mining_fee = get_account(
779
        tx_state, block_env.coinbase
780
    ).balance + U256(transaction_fee)
781
    set_account_balance(
782
        tx_state, block_env.coinbase, coinbase_balance_after_mining_fee
783
    )
784
785
    for address in tx_output.accounts_to_delete:
786
        destroy_account(tx_state, address)
787
788
    block_output.block_gas_used += tx_gas_used_after_refund
789
    block_output.blob_gas_used += tx_blob_gas_used
790
791
    receipt = make_receipt(
792
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
793
    )
794
795
    receipt_key = rlp.encode(Uint(index))
796
    block_output.receipt_keys += (receipt_key,)
797
798
    trie_set(
799
        block_output.receipts_trie,
800
        receipt_key,
801
        receipt,
802
    )
803
804
    block_output.block_logs += tx_output.logs
805
806
    incorporate_tx_into_block(tx_state)

process_withdrawals

Increase the balance of the withdrawing account.

def process_withdrawals(block_env: ethereum.forks.shanghai.vm.BlockEnvironmentethereum.forks.cancun.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutputethereum.forks.cancun.vm.BlockOutput, ​​withdrawals: Tuple[Withdrawal, ...]) -> None:
814
    """
815
    Increase the balance of the withdrawing account.
816
    """
817
    wd_state = TransactionState(parent=block_env.state)
818
819
    for i, wd in enumerate(withdrawals):
820
        trie_set(
821
            block_output.withdrawals_trie,
822
            rlp.encode(Uint(i)),
823
            rlp.encode(wd),
824
        )
825
826
        create_ether(wd_state, wd.address, wd.amount * U256(10**9))
827
828
    incorporate_tx_into_block(wd_state)

check_gas_limit

Validates the gas limit for a block.

The bounds of the gas limit, max_adjustment_delta, is set as the quotient of the parent block's gas limit and the LIMIT_ADJUSTMENT_FACTOR. Therefore, if the gas limit that is passed through as a parameter is greater than or equal to the sum of the parent's gas and the adjustment delta then the limit for gas is too high and fails this function's check. Similarly, if the limit is less than or equal to the difference of the parent's gas and the adjustment delta or the predefined LIMIT_MINIMUM then this function's check fails because the gas limit doesn't allow for a sufficient or reasonable amount of gas to be used on a block.

Parameters

gas_limit : Gas limit to validate.

parent_gas_limit : Gas limit of the parent block.

Returns

check : bool True if gas limit constraints are satisfied, False otherwise.

def check_gas_limit(gas_limit: Uint, ​​parent_gas_limit: Uint) -> bool:
832
    """
833
    Validates the gas limit for a block.
834
835
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
836
    quotient of the parent block's gas limit and the
837
    ``LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
838
    passed through as a parameter is greater than or equal to the *sum* of
839
    the parent's gas and the adjustment delta then the limit for gas is too
840
    high and fails this function's check. Similarly, if the limit is less
841
    than or equal to the *difference* of the parent's gas and the adjustment
842
    delta *or* the predefined ``LIMIT_MINIMUM`` then this function's
843
    check fails because the gas limit doesn't allow for a sufficient or
844
    reasonable amount of gas to be used on a block.
845
846
    Parameters
847
    ----------
848
    gas_limit :
849
        Gas limit to validate.
850
851
    parent_gas_limit :
852
        Gas limit of the parent block.
853
854
    Returns
855
    -------
856
    check : `bool`
857
        True if gas limit constraints are satisfied, False otherwise.
858
859
    """
860
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
861
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
862
        return False
863
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
864
        return False
865
    if gas_limit < GasCosts.LIMIT_MINIMUM:
866
        return False
867
868
    return True