ethereum.forks.paris.forkethereum.forks.shanghai.fork

Ethereum Specification.

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

Introduction

Entry point for the Ethereum specification.

BASE_FEE_MAX_CHANGE_DENOMINATOR

64
BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8)

ELASTICITY_MULTIPLIER

65
ELASTICITY_MULTIPLIER = Uint(2)

EMPTY_OMMER_HASH

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

BlockChain

History and current state of the block chain.

69
@dataclass
class BlockChain:

blocks

75
    blocks: List[Block]

state

76
    state: State

chain_id

77
    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:
81
    """
82
    Transforms the state from the previous hard fork (`old`) into the block
83
    chain object for this hard fork and returns it.
84
85
    When forks need to implement an irregular state transition, this function
86
    is used to handle the irregularity. See the :ref:`DAO Fork <dao-fork>` for
87
    an example.
88
89
    Parameters
90
    ----------
91
    old :
92
        Previous block chain object.
93
94
    Returns
95
    -------
96
    new : `BlockChain`
97
        Upgraded block chain object for this hard fork.
98
99
    """
100
    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]:
104
    """
105
    Obtain the list of hashes of the previous 256 blocks in order of
106
    increasing block number.
107
108
    This function will return less hashes for the first 256 blocks.
109
110
    The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain,
111
    therefore this function retrieves them.
112
113
    Parameters
114
    ----------
115
    chain :
116
        History and current state.
117
118
    Returns
119
    -------
120
    recent_block_hashes : `List[Hash32]`
121
        Hashes of the recent 256 blocks in order of increasing block number.
122
123
    """
124
    recent_blocks = chain.blocks[-255:]
125
    # TODO: This function has not been tested rigorously
126
    if len(recent_blocks) == 0:
127
        return []
128
129
    recent_block_hashes = []
130
131
    for block in recent_blocks:
132
        prev_block_hash = block.header.parent_hash
133
        recent_block_hashes.append(prev_block_hash)
134
135
    # We are computing the hash only for the most recent block and not for
136
    # the rest of the blocks as they have successors which have the hash of
137
    # the current block as parent hash.
138
    most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header))
139
    recent_block_hashes.append(most_recent_block_hash)
140
141
    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:
145
    """
146
    Attempts to apply a block to an existing block chain.
147
148
    All parts of the block's contents need to be verified before being added
149
    to the chain. Blocks are verified by ensuring that the contents of the
150
    block make logical sense with the contents of the parent block. The
151
    information in the block's header must also match the corresponding
152
    information in the block.
153
154
    To implement Ethereum, in theory clients are only required to store the
155
    most recent 255 blocks of the chain since as far as execution is
156
    concerned, only those blocks are accessed. Practically, however, clients
157
    should store more blocks to handle reorgs.
158
159
    Parameters
160
    ----------
161
    chain :
162
        History and current state.
163
    block :
164
        Block to apply to `chain`.
165
166
    """
167
    validate_header(chain, block.header)
168
    if block.ommers != ():
169
        raise InvalidBlock
170
171
    block_env = vm.BlockEnvironment(
172
        chain_id=chain.chain_id,
173
        state=chain.state,
174
        block_gas_limit=block.header.gas_limit,
175
        block_hashes=get_last_256_block_hashes(chain),
176
        coinbase=block.header.coinbase,
177
        number=block.header.number,
178
        base_fee_per_gas=block.header.base_fee_per_gas,
179
        time=block.header.timestamp,
180
        prev_randao=block.header.prev_randao,
181
    )
182
183
    block_output = apply_body(
184
        block_env=block_env,
185
        transactions=block.transactions,
186
        withdrawals=block.withdrawals,
187
    )
188
    block_state_root = state_root(block_env.state)
189
    transactions_root = root(block_output.transactions_trie)
190
    receipt_root = root(block_output.receipts_trie)
191
    block_logs_bloom = logs_bloom(block_output.block_logs)
192
    withdrawals_root = root(block_output.withdrawals_trie)
193
194
    if block_output.block_gas_used != block.header.gas_used:
195
        raise InvalidBlock(
196
            f"{block_output.block_gas_used} != {block.header.gas_used}"
197
        )
198
    if transactions_root != block.header.transactions_root:
199
        raise InvalidBlock
200
    if block_state_root != block.header.state_root:
201
        raise InvalidBlock
202
    if receipt_root != block.header.receipt_root:
203
        raise InvalidBlock
204
    if block_logs_bloom != block.header.bloom:
205
        raise InvalidBlock
206
    if withdrawals_root != block.header.withdrawals_root:
207
        raise InvalidBlock
208
209
    chain.blocks.append(block)
210
    if len(chain.blocks) > 255:
211
        # Real clients have to store more blocks to deal with reorgs, but the
212
        # protocol only requires the last 255
213
        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:
222
    """
223
    Calculates the base fee per gas for the block.
224
225
    Parameters
226
    ----------
227
    block_gas_limit :
228
        Gas limit of the block for which the base fee is being calculated.
229
    parent_gas_limit :
230
        Gas limit of the parent block.
231
    parent_gas_used :
232
        Gas used in the parent block.
233
    parent_base_fee_per_gas :
234
        Base fee per gas of the parent block.
235
236
    Returns
237
    -------
238
    base_fee_per_gas : `Uint`
239
        Base fee per gas for the block.
240
241
    """
242
    parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER
243
    if not check_gas_limit(block_gas_limit, parent_gas_limit):
244
        raise InvalidBlock
245
246
    if parent_gas_used == parent_gas_target:
247
        expected_base_fee_per_gas = parent_base_fee_per_gas
248
    elif parent_gas_used > parent_gas_target:
249
        gas_used_delta = parent_gas_used - parent_gas_target
250
251
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
252
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
253
254
        base_fee_per_gas_delta = max(
255
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR,
256
            Uint(1),
257
        )
258
259
        expected_base_fee_per_gas = (
260
            parent_base_fee_per_gas + base_fee_per_gas_delta
261
        )
262
    else:
263
        gas_used_delta = parent_gas_target - parent_gas_used
264
265
        parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta
266
        target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target
267
268
        base_fee_per_gas_delta = (
269
            target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR
270
        )
271
272
        expected_base_fee_per_gas = (
273
            parent_base_fee_per_gas - base_fee_per_gas_delta
274
        )
275
276
    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:
280
    """
281
    Verifies a block header.
282
283
    In order to consider a block's header valid, the logic for the
284
    quantities in the header should match the logic for the block itself.
285
    For example the header timestamp should be greater than the block's parent
286
    timestamp because the block was created *after* the parent block.
287
    Additionally, the block's number should be directly following the parent
288
    block's number since it is the next block in the sequence.
289
290
    Parameters
291
    ----------
292
    chain :
293
        History and current state.
294
    header :
295
        Header to check for correctness.
296
297
    """
298
    if header.number < Uint(1):
299
        raise InvalidBlock
300
301
    parent_header = chain.blocks[-1].header
302
303
    if header.gas_used > header.gas_limit:
304
        raise InvalidBlock
305
306
    expected_base_fee_per_gas = calculate_base_fee_per_gas(
307
        header.gas_limit,
308
        parent_header.gas_limit,
309
        parent_header.gas_used,
310
        parent_header.base_fee_per_gas,
311
    )
312
    if expected_base_fee_per_gas != header.base_fee_per_gas:
313
        raise InvalidBlock
314
    if header.timestamp <= parent_header.timestamp:
315
        raise InvalidBlock
316
    if header.number != parent_header.number + Uint(1):
317
        raise InvalidBlock
318
    if len(header.extra_data) > 32:
319
        raise InvalidBlock
320
    if header.difficulty != 0:
321
        raise InvalidBlock
322
    if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00":
323
        raise InvalidBlock
324
    if header.ommers_hash != EMPTY_OMMER_HASH:
325
        raise InvalidBlock
326
327
    block_parent_hash = keccak256(rlp.encode(parent_header))
328
    if header.parent_hash != block_parent_hash:
329
        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. effective_gas_price : The price to charge for gas when the transaction is executed.

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.

def check_transaction(block_env: ethereum.forks.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction) -> Tuple[Address, Uint]:
337
    """
338
    Check if the transaction is includable in the block.
339
340
    Parameters
341
    ----------
342
    block_env :
343
        The block scoped environment.
344
    block_output :
345
        The block output for the current block.
346
    tx :
347
        The transaction.
348
349
    Returns
350
    -------
351
    sender_address :
352
        The sender of the transaction.
353
    effective_gas_price :
354
        The price to charge for gas when the transaction is executed.
355
356
    Raises
357
    ------
358
    InvalidBlock :
359
        If the transaction is not includable.
360
    GasUsedExceedsLimitError :
361
        If the gas used by the transaction exceeds the block's gas limit.
362
    NonceMismatchError :
363
        If the nonce of the transaction is not equal to the sender's nonce.
364
    InsufficientBalanceError :
365
        If the sender's balance is not enough to pay for the transaction.
366
    InvalidSenderError :
367
        If the transaction is from an address that does not exist anymore.
368
    PriorityFeeGreaterThanMaxFeeError :
369
        If the priority fee is greater than the maximum fee per gas.
370
    InsufficientMaxFeePerGasError :
371
        If the maximum fee per gas is insufficient for the transaction.
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(block_env.chain_id, tx)
378
    sender_account = get_account(block_env.state, sender_address)
379
380
    if isinstance(tx, FeeMarketTransaction):
381
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
382
            raise PriorityFeeGreaterThanMaxFeeError(
383
                "priority fee greater than max fee"
384
            )
385
        if tx.max_fee_per_gas < block_env.base_fee_per_gas:
386
            raise InsufficientMaxFeePerGasError(
387
                tx.max_fee_per_gas, block_env.base_fee_per_gas
388
            )
389
390
        priority_fee_per_gas = min(
391
            tx.max_priority_fee_per_gas,
392
            tx.max_fee_per_gas - block_env.base_fee_per_gas,
393
        )
394
        effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas
395
        max_gas_fee = tx.gas * tx.max_fee_per_gas
396
    else:
397
        if tx.gas_price < block_env.base_fee_per_gas:
398
            raise InvalidBlock
399
        effective_gas_price = tx.gas_price
400
        max_gas_fee = tx.gas * tx.gas_price
401
402
    if sender_account.nonce > Uint(tx.nonce):
403
        raise NonceMismatchError("nonce too low")
404
    elif sender_account.nonce < Uint(tx.nonce):
405
        raise NonceMismatchError("nonce too high")
406
    if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value):
407
        raise InsufficientBalanceError("insufficient sender balance")
408
    if sender_account.code_hash != EMPTY_CODE_HASH:
409
        raise InvalidSenderError("not EOA")
410
411
    return sender_address, effective_gas_price

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:
420
    """
421
    Make the receipt for a transaction that was executed.
422
423
    Parameters
424
    ----------
425
    tx :
426
        The executed transaction.
427
    error :
428
        Error in the top level frame of the transaction, if any.
429
    cumulative_gas_used :
430
        The total gas used so far in the block after the transaction was
431
        executed.
432
    logs :
433
        The logs produced by the transaction.
434
435
    Returns
436
    -------
437
    receipt :
438
        The receipt for the transaction.
439
440
    """
441
    receipt = Receipt(
442
        succeeded=error is None,
443
        cumulative_gas_used=cumulative_gas_used,
444
        bloom=logs_bloom(logs),
445
        logs=logs,
446
    )
447
448
    return encode_receipt(tx, 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. 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.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​transactions: Tuple[LegacyTransaction | Bytes, ...], ​​withdrawals: Tuple[Withdrawal, ...]) -> ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput:
456
    """
457
    Executes a block.
458
459
    Many of the contents of a block are stored in data structures called
460
    tries. There is a transactions trie which is similar to a ledger of the
461
    transactions stored in the current block. There is also a receipts trie
462
    which stores the results of executing a transaction, like the post state
463
    and gas used. This function creates and executes the block that is to be
464
    added to the chain.
465
466
    Parameters
467
    ----------
468
    block_env :
469
        The block scoped environment.
470
    block_output :
471
        The block output for the current block.
472
    transactions :
473
        Transactions included in the block.
474
    withdrawals :
475
        Withdrawals to be processed in the current block.
476
477
    Returns
478
    -------
479
    block_output :
480
        The block output for the current block.
481
482
    """
483
    block_output = vm.BlockOutput()
484
485
    for i, tx in enumerate(map(decode_transaction, transactions)):
486
        process_transaction(block_env, block_output, tx, Uint(i))
487
488
    process_withdrawals(block_env, block_output, withdrawals)
489
490
    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.paris.vm.BlockEnvironmentethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.paris.vm.BlockOutputethereum.forks.shanghai.vm.BlockOutput, ​​tx: Transaction, ​​index: Uint) -> None:
499
    """
500
    Execute a transaction against the provided environment.
501
502
    This function processes the actions needed to execute a transaction.
503
    It decrements the sender's account balance after calculating the gas fee
504
    and refunds them the proper amount after execution. Calling contracts,
505
    deploying code, and incrementing nonces are all examples of actions that
506
    happen within this function or from a call made within this function.
507
508
    Accounts that are marked for deletion are processed and destroyed after
509
    execution.
510
511
    Parameters
512
    ----------
513
    block_env :
514
        Environment for the Ethereum Virtual Machine.
515
    block_output :
516
        The block output for the current block.
517
    tx :
518
        Transaction to execute.
519
    index:
520
        Index of the transaction in the block.
521
522
    """
523
    trie_set(
524
        block_output.transactions_trie,
525
        rlp.encode(index),
526
        encode_transaction(tx),
527
    )
528
529
    intrinsic_gas = validate_transaction(tx)
530
531
    (
532
        sender,
533
        effective_gas_price,
534
    ) = check_transaction(
535
        block_env=block_env,
536
        block_output=block_output,
537
        tx=tx,
538
    )
539
540
    sender_account = get_account(block_env.state, sender)
541
542
    effective_gas_fee = tx.gas * effective_gas_price
543
544
    gas = tx.gas - intrinsic_gas
545
    increment_nonce(block_env.state, sender)
546
547
    sender_balance_after_gas_fee = (
548
        Uint(sender_account.balance) - effective_gas_fee
549
    )
550
    set_account_balance(
551
        block_env.state, sender, U256(sender_balance_after_gas_fee)
552
    )
553
554
    access_list_addresses = set()
555
    access_list_storage_keys = set()
556
    access_list_addresses.add(block_env.coinbase)
557
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
558
        for access in tx.access_list:
559
            access_list_addresses.add(access.account)
560
            for slot in access.slots:
561
                access_list_storage_keys.add((access.account, slot))
562
563
    tx_env = vm.TransactionEnvironment(
564
        origin=sender,
565
        gas_price=effective_gas_price,
566
        gas=gas,
567
        access_list_addresses=access_list_addresses,
568
        access_list_storage_keys=access_list_storage_keys,
569
        index_in_block=index,
570
        tx_hash=get_transaction_hash(encode_transaction(tx)),
571
    )
572
573
    message = prepare_message(block_env, tx_env, tx)
574
575
    tx_output = process_message_call(message)
576
577
    tx_gas_used_before_refund = tx.gas - tx_output.gas_left
578
    tx_gas_refund = min(
579
        tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter)
580
    )
581
    tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund
582
    tx_gas_left = tx.gas - tx_gas_used_after_refund
583
    gas_refund_amount = tx_gas_left * effective_gas_price
584
585
    # For non-1559 transactions effective_gas_price == tx.gas_price
586
    priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas
587
    transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas
588
589
    # refund gas
590
    sender_balance_after_refund = get_account(
591
        block_env.state, sender
592
    ).balance + U256(gas_refund_amount)
593
    set_account_balance(block_env.state, sender, sender_balance_after_refund)
594
595
    # transfer miner fees
596
    coinbase_balance_after_mining_fee = get_account(
597
        block_env.state, block_env.coinbase
598
    ).balance + U256(transaction_fee)
599
    set_account_balance(
600
        block_env.state,
601
        block_env.coinbase,
602
        coinbase_balance_after_mining_fee,
603
    )
604
605
    for address in tx_output.accounts_to_delete:
606
        destroy_account(block_env.state, address)
607
608
    block_output.block_gas_used += tx_gas_used_after_refund
609
610
    receipt = make_receipt(
611
        tx, tx_output.error, block_output.block_gas_used, tx_output.logs
612
    )
613
614
    receipt_key = rlp.encode(Uint(index))
615
    block_output.receipt_keys += (receipt_key,)
616
617
    trie_set(
618
        block_output.receipts_trie,
619
        receipt_key,
620
        receipt,
621
    )
622
623
    block_output.block_logs += tx_output.logs

process_withdrawals

Increase the balance of the withdrawing account.

def process_withdrawals(block_env: ethereum.forks.shanghai.vm.BlockEnvironment, ​​block_output: ethereum.forks.shanghai.vm.BlockOutput, ​​withdrawals: Tuple[Withdrawal, ...]) -> None:
631
    """
632
    Increase the balance of the withdrawing account.
633
    """
634
635
    def increase_recipient_balance(recipient: Account) -> None:
636
        recipient.balance += wd.amount * U256(10**9)
637
638
    for i, wd in enumerate(withdrawals):
639
        trie_set(
640
            block_output.withdrawals_trie,
641
            rlp.encode(Uint(i)),
642
            rlp.encode(wd),
643
        )
644
645
        modify_state(block_env.state, wd.address, increase_recipient_balance)

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:
649
    """
650
    Validates the gas limit for a block.
651
652
    The bounds of the gas limit, ``max_adjustment_delta``, is set as the
653
    quotient of the parent block's gas limit and the
654
    ``LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is
655
    passed through as a parameter is greater than or equal to the *sum* of
656
    the parent's gas and the adjustment delta then the limit for gas is too
657
    high and fails this function's check. Similarly, if the limit is less
658
    than or equal to the *difference* of the parent's gas and the adjustment
659
    delta *or* the predefined ``LIMIT_MINIMUM`` then this function's
660
    check fails because the gas limit doesn't allow for a sufficient or
661
    reasonable amount of gas to be used on a block.
662
663
    Parameters
664
    ----------
665
    gas_limit :
666
        Gas limit to validate.
667
668
    parent_gas_limit :
669
        Gas limit of the parent block.
670
671
    Returns
672
    -------
673
    check : `bool`
674
        True if gas limit constraints are satisfied, False otherwise.
675
676
    """
677
    max_adjustment_delta = parent_gas_limit // GasCosts.LIMIT_ADJUSTMENT_FACTOR
678
    if gas_limit >= parent_gas_limit + max_adjustment_delta:
679
        return False
680
    if gas_limit <= parent_gas_limit - max_adjustment_delta:
681
        return False
682
    if gas_limit < GasCosts.LIMIT_MINIMUM:
683
        return False
684
685
    return True