ethereum.forks.london.transactions

Transactions are atomic units of work created externally to Ethereum and submitted to be executed. If Ethereum is viewed as a state machine, transactions are the events that move between states.

TX_BASE_COST

Base cost of a transaction in gas units. This is the minimum amount of gas required to execute a transaction.

26
TX_BASE_COST = Uint(21000)

TX_DATA_COST_PER_NON_ZERO

Gas cost per non-zero byte in the transaction data.

32
TX_DATA_COST_PER_NON_ZERO = Uint(16)

TX_DATA_COST_PER_ZERO

Gas cost per zero byte in the transaction data.

37
TX_DATA_COST_PER_ZERO = Uint(4)

TX_CREATE_COST

Additional gas cost for creating a new contract.

42
TX_CREATE_COST = Uint(32000)

TX_ACCESS_LIST_ADDRESS_COST

Gas cost for including an address in the access list of a transaction.

47
TX_ACCESS_LIST_ADDRESS_COST = Uint(2400)

TX_ACCESS_LIST_STORAGE_KEY_COST

Gas cost for including a storage key in the access list of a transaction.

52
TX_ACCESS_LIST_STORAGE_KEY_COST = Uint(1900)

LegacyTransaction

Atomic operation performed on the block chain. This represents the original transaction format used before EIP-1559, and EIP-2930.

58
@slotted_freezable
59
@dataclass
class LegacyTransaction:

nonce

A scalar value equal to the number of transactions sent by the sender.

69
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

74
    gas_price: Uint

gas

The maximum amount of gas that can be used by this transaction.

79
    gas: Uint

to

The address of the recipient. If empty, the transaction is a contract creation.

84
    to: Bytes0 | Address

value

The amount of ether (in wei) to send with this transaction.

90
    value: U256

data

The data payload of the transaction, which can be used to call functions on contracts or to create new contracts.

95
    data: Bytes

v

The recovery id of the signature.

101
    v: U256

r

The first part of the signature.

106
    r: U256

s

The second part of the signature.

111
    s: U256

Access

A mapping from account address to storage slots that are pre-warmed as part of a transaction.

117
@slotted_freezable
118
@dataclass
class Access:

account

The address of the account that is accessed.

125
    account: Address

slots

A tuple of storage slots that are accessed in the account.

130
    slots: Tuple[Bytes32, ...]

AccessListTransaction

The transaction type added in EIP-2930 to support access lists.

This transaction type extends the legacy transaction with an access list and chain ID. The access list specifies which addresses and storage slots the transaction will access.

136
@slotted_freezable
137
@dataclass
class AccessListTransaction:

chain_id

The ID of the chain on which this transaction is executed.

149
    chain_id: U64

nonce

A scalar value equal to the number of transactions sent by the sender.

154
    nonce: U256

gas_price

The price of gas for this transaction.

159
    gas_price: Uint

gas

The maximum amount of gas that can be used by this transaction.

164
    gas: Uint

to

The address of the recipient. If empty, the transaction is a contract creation.

169
    to: Bytes0 | Address

value

The amount of ether (in wei) to send with this transaction.

175
    value: U256

data

The data payload of the transaction, which can be used to call functions on contracts or to create new contracts.

180
    data: Bytes

access_list

A tuple of Access objects that specify which addresses and storage slots are accessed in the transaction.

186
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

192
    y_parity: U256

r

The first part of the signature.

197
    r: U256

s

The second part of the signature.

202
    s: U256

FeeMarketTransaction

The transaction type added in EIP-1559.

This transaction type introduces a new fee market mechanism with two gas price parameters: max_priority_fee_per_gas and max_fee_per_gas.

208
@slotted_freezable
209
@dataclass
class FeeMarketTransaction:

chain_id

The ID of the chain on which this transaction is executed.

220
    chain_id: U64

nonce

A scalar value equal to the number of transactions sent by the sender.

225
    nonce: U256

max_priority_fee_per_gas

The maximum priority fee per gas that the sender is willing to pay.

230
    max_priority_fee_per_gas: Uint

max_fee_per_gas

The maximum fee per gas that the sender is willing to pay, including the base fee and priority fee.

235
    max_fee_per_gas: Uint

gas

The maximum amount of gas that can be used by this transaction.

241
    gas: Uint

to

The address of the recipient. If empty, the transaction is a contract creation.

246
    to: Bytes0 | Address

value

The amount of ether (in wei) to send with this transaction.

252
    value: U256

data

The data payload of the transaction, which can be used to call functions on contracts or to create new contracts.

257
    data: Bytes

access_list

A tuple of Access objects that specify which addresses and storage slots are accessed in the transaction.

263
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

269
    y_parity: U256

r

The first part of the signature.

274
    r: U256

s

The second part of the signature.

279
    s: U256

Transaction

Union type representing any valid transaction type.

285
Transaction = LegacyTransaction | AccessListTransaction | FeeMarketTransaction

encode_transaction

Encode a transaction into its RLP or typed transaction format. Needed because non-legacy transactions aren't RLP.

Legacy transactions are returned as-is, while other transaction types are prefixed with their type identifier and RLP encoded.

def encode_transaction(tx: Transaction) -> LegacyTransaction | Bytes:
292
    """
293
    Encode a transaction into its RLP or typed transaction format.
294
    Needed because non-legacy transactions aren't RLP.
295
296
    Legacy transactions are returned as-is, while other transaction types
297
    are prefixed with their type identifier and RLP encoded.
298
    """
299
    if isinstance(tx, LegacyTransaction):
300
        return tx
301
    elif isinstance(tx, AccessListTransaction):
302
        return b"\x01" + rlp.encode(tx)
303
    elif isinstance(tx, FeeMarketTransaction):
304
        return b"\x02" + rlp.encode(tx)
305
    else:
306
        raise Exception(f"Unable to encode transaction of type {type(tx)}")

decode_transaction

Decode a transaction from its RLP or typed transaction format. Needed because non-legacy transactions aren't RLP.

Legacy transactions are returned as-is, while other transaction types are decoded based on their type identifier prefix.

def decode_transaction(tx: LegacyTransaction | Bytes) -> Transaction:
310
    """
311
    Decode a transaction from its RLP or typed transaction format.
312
    Needed because non-legacy transactions aren't RLP.
313
314
    Legacy transactions are returned as-is, while other transaction types
315
    are decoded based on their type identifier prefix.
316
    """
317
    if isinstance(tx, Bytes):
318
        if tx[0] == 1:
319
            return rlp.decode_to(AccessListTransaction, tx[1:])
320
        elif tx[0] == 2:
321
            return rlp.decode_to(FeeMarketTransaction, tx[1:])
322
        else:
323
            raise TransactionTypeError(tx[0])
324
    else:
325
        return tx

validate_transaction

Verifies a transaction.

The gas in a transaction gets used to pay for the intrinsic cost of operations, therefore if there is insufficient gas then it would not be possible to execute a transaction and it will be declared invalid.

Additionally, the nonce of a transaction must not equal or exceed the limit defined in EIP-2681. In practice, defining the limit as 2**64-1 has no impact because sending 2**64-1 transactions is improbable. It's not strictly impossible though, 2**64-1 transactions is the entire capacity of the Ethereum blockchain at 2022 gas limits for a little over 22 years.

This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an InsufficientTransactionGasError exception if the transaction does not provide enough gas to cover the intrinsic cost, and a NonceOverflowError exception if the nonce is greater than 2**64 - 2.

def validate_transaction(tx: Transaction) -> Uint:
329
    """
330
    Verifies a transaction.
331
332
    The gas in a transaction gets used to pay for the intrinsic cost of
333
    operations, therefore if there is insufficient gas then it would not
334
    be possible to execute a transaction and it will be declared invalid.
335
336
    Additionally, the nonce of a transaction must not equal or exceed the
337
    limit defined in [EIP-2681].
338
    In practice, defining the limit as ``2**64-1`` has no impact because
339
    sending ``2**64-1`` transactions is improbable. It's not strictly
340
    impossible though, ``2**64-1`` transactions is the entire capacity of the
341
    Ethereum blockchain at 2022 gas limits for a little over 22 years.
342
343
    This function takes a transaction as a parameter and returns the intrinsic
344
    gas cost of the transaction after validation. It throws an
345
    `InsufficientTransactionGasError` exception if the transaction does not
346
    provide enough gas to cover the intrinsic cost, and a `NonceOverflowError`
347
    exception if the nonce is greater than `2**64 - 2`.
348
349
    [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681
350
    """
351
    intrinsic_gas = calculate_intrinsic_cost(tx)
352
    if intrinsic_gas > tx.gas:
353
        raise InsufficientTransactionGasError("Insufficient gas")
354
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
355
        raise NonceOverflowError("Nonce too high")
356
    return intrinsic_gas

calculate_intrinsic_cost

Calculates the gas that is charged before execution is started.

The intrinsic cost of the transaction is charged before execution has begun. Functions/operations in the EVM cost money to execute so this intrinsic cost is for the operations that need to be paid for as part of the transaction. Data transfer, for example, is part of this intrinsic cost. It costs ether to send data over the wire and that ether is accounted for in the intrinsic cost calculated in this function. This intrinsic cost must be calculated and paid for before execution in order for all operations to be implemented.

The intrinsic cost includes:

  1. Base cost (TX_BASE_COST)

  2. Cost for data (zero and non-zero bytes)

  3. Cost for contract creation (if applicable)

  4. Cost for access list entries (if applicable)

This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction.

def calculate_intrinsic_cost(tx: Transaction) -> Uint:
360
    """
361
    Calculates the gas that is charged before execution is started.
362
363
    The intrinsic cost of the transaction is charged before execution has
364
    begun. Functions/operations in the EVM cost money to execute so this
365
    intrinsic cost is for the operations that need to be paid for as part of
366
    the transaction. Data transfer, for example, is part of this intrinsic
367
    cost. It costs ether to send data over the wire and that ether is
368
    accounted for in the intrinsic cost calculated in this function. This
369
    intrinsic cost must be calculated and paid for before execution in order
370
    for all operations to be implemented.
371
372
    The intrinsic cost includes:
373
    1. Base cost (`TX_BASE_COST`)
374
    2. Cost for data (zero and non-zero bytes)
375
    3. Cost for contract creation (if applicable)
376
    4. Cost for access list entries (if applicable)
377
378
    This function takes a transaction as a parameter and returns the intrinsic
379
    gas cost of the transaction.
380
    """
381
    data_cost = Uint(0)
382
383
    for byte in tx.data:
384
        if byte == 0:
385
            data_cost += TX_DATA_COST_PER_ZERO
386
        else:
387
            data_cost += TX_DATA_COST_PER_NON_ZERO
388
389
    if tx.to == Bytes0(b""):
390
        create_cost = TX_CREATE_COST
391
    else:
392
        create_cost = Uint(0)
393
394
    access_list_cost = Uint(0)
395
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
396
        for access in tx.access_list:
397
            access_list_cost += TX_ACCESS_LIST_ADDRESS_COST
398
            access_list_cost += (
399
                ulen(access.slots) * TX_ACCESS_LIST_STORAGE_KEY_COST
400
            )
401
402
    return TX_BASE_COST + data_cost + create_cost + access_list_cost

recover_sender

Extracts the sender address from a transaction.

The v, r, and s values are the three parts that make up the signature of a transaction. In order to recover the sender of a transaction the two components needed are the signature (v, r, and s) and the signing hash of the transaction. The sender's public key can be obtained with these two values and therefore the sender address can be retrieved.

This function takes chain_id and a transaction as parameters and returns the address of the sender of the transaction. It raises an InvalidSignatureError if the signature values (r, s, v) are invalid.

def recover_sender(chain_id: U64, ​​tx: Transaction) -> Address:
406
    """
407
    Extracts the sender address from a transaction.
408
409
    The v, r, and s values are the three parts that make up the signature
410
    of a transaction. In order to recover the sender of a transaction the two
411
    components needed are the signature (``v``, ``r``, and ``s``) and the
412
    signing hash of the transaction. The sender's public key can be obtained
413
    with these two values and therefore the sender address can be retrieved.
414
415
    This function takes chain_id and a transaction as parameters and returns
416
    the address of the sender of the transaction. It raises an
417
    `InvalidSignatureError` if the signature values (r, s, v) are invalid.
418
    """
419
    r, s = tx.r, tx.s
420
    if U256(0) >= r or r >= SECP256K1N:
421
        raise InvalidSignatureError("bad r")
422
    if U256(0) >= s or s > SECP256K1N // U256(2):
423
        raise InvalidSignatureError("bad s")
424
425
    if isinstance(tx, LegacyTransaction):
426
        v = tx.v
427
        if v == 27 or v == 28:
428
            public_key = secp256k1_recover(
429
                r, s, v - U256(27), signing_hash_pre155(tx)
430
            )
431
        else:
432
            chain_id_x2 = U256(chain_id) * U256(2)
433
            if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
434
                raise InvalidSignatureError("bad v")
435
            public_key = secp256k1_recover(
436
                r,
437
                s,
438
                v - U256(35) - chain_id_x2,
439
                signing_hash_155(tx, chain_id),
440
            )
441
    elif isinstance(tx, AccessListTransaction):
442
        if tx.y_parity not in (U256(0), U256(1)):
443
            raise InvalidSignatureError("bad y_parity")
444
        public_key = secp256k1_recover(
445
            r, s, tx.y_parity, signing_hash_2930(tx)
446
        )
447
    elif isinstance(tx, FeeMarketTransaction):
448
        if tx.y_parity not in (U256(0), U256(1)):
449
            raise InvalidSignatureError("bad y_parity")
450
        public_key = secp256k1_recover(
451
            r, s, tx.y_parity, signing_hash_1559(tx)
452
        )
453
454
    return Address(keccak256(public_key)[12:32])

signing_hash_pre155

Compute the hash of a transaction used in a legacy (pre EIP-155) signature.

This function takes a legacy transaction as a parameter and returns the signing hash of the transaction.

def signing_hash_pre155(tx: LegacyTransaction) -> Hash32:
458
    """
459
    Compute the hash of a transaction used in a legacy (pre [EIP-155])
460
    signature.
461
462
    This function takes a legacy transaction as a parameter and returns the
463
    signing hash of the transaction.
464
465
    [EIP-155]: https://eips.ethereum.org/EIPS/eip-155
466
    """
467
    return keccak256(
468
        rlp.encode(
469
            (
470
                tx.nonce,
471
                tx.gas_price,
472
                tx.gas,
473
                tx.to,
474
                tx.value,
475
                tx.data,
476
            )
477
        )
478
    )

signing_hash_155

Compute the hash of a transaction used in a EIP-155 signature.

This function takes a legacy transaction and a chain ID as parameters and returns the hash of the transaction used in an EIP-155 signature.

def signing_hash_155(tx: LegacyTransaction, ​​chain_id: U64) -> Hash32:
482
    """
483
    Compute the hash of a transaction used in a [EIP-155] signature.
484
485
    This function takes a legacy transaction and a chain ID as parameters
486
    and returns the hash of the transaction used in an [EIP-155] signature.
487
488
    [EIP-155]: https://eips.ethereum.org/EIPS/eip-155
489
    """
490
    return keccak256(
491
        rlp.encode(
492
            (
493
                tx.nonce,
494
                tx.gas_price,
495
                tx.gas,
496
                tx.to,
497
                tx.value,
498
                tx.data,
499
                chain_id,
500
                Uint(0),
501
                Uint(0),
502
            )
503
        )
504
    )

signing_hash_2930

Compute the hash of a transaction used in a EIP-2930 signature.

This function takes an access list transaction as a parameter and returns the hash of the transaction used in an EIP-2930 signature.

def signing_hash_2930(tx: AccessListTransaction) -> Hash32:
508
    """
509
    Compute the hash of a transaction used in a [EIP-2930] signature.
510
511
    This function takes an access list transaction as a parameter
512
    and returns the hash of the transaction used in an [EIP-2930] signature.
513
514
    [EIP-2930]: https://eips.ethereum.org/EIPS/eip-2930
515
    """
516
    return keccak256(
517
        b"\x01"
518
        + rlp.encode(
519
            (
520
                tx.chain_id,
521
                tx.nonce,
522
                tx.gas_price,
523
                tx.gas,
524
                tx.to,
525
                tx.value,
526
                tx.data,
527
                tx.access_list,
528
            )
529
        )
530
    )

signing_hash_1559

Compute the hash of a transaction used in an EIP-1559 signature.

This function takes a fee market transaction as a parameter and returns the hash of the transaction used in an EIP-1559 signature.

def signing_hash_1559(tx: FeeMarketTransaction) -> Hash32:
534
    """
535
    Compute the hash of a transaction used in an [EIP-1559] signature.
536
537
    This function takes a fee market transaction as a parameter
538
    and returns the hash of the transaction used in an [EIP-1559] signature.
539
540
    [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559
541
    """
542
    return keccak256(
543
        b"\x02"
544
        + rlp.encode(
545
            (
546
                tx.chain_id,
547
                tx.nonce,
548
                tx.max_priority_fee_per_gas,
549
                tx.max_fee_per_gas,
550
                tx.gas,
551
                tx.to,
552
                tx.value,
553
                tx.data,
554
                tx.access_list,
555
            )
556
        )
557
    )

get_transaction_hash

Compute the hash of a transaction.

This function takes a transaction as a parameter and returns the keccak256 hash of the transaction. It can handle both legacy transactions and typed transactions (AccessListTransaction, FeeMarketTransaction, etc.).

def get_transaction_hash(tx: Bytes | LegacyTransaction) -> Hash32:
561
    """
562
    Compute the hash of a transaction.
563
564
    This function takes a transaction as a parameter and returns the
565
    keccak256 hash of the transaction. It can handle both legacy transactions
566
    and typed transactions (`AccessListTransaction`, `FeeMarketTransaction`,
567
    etc.).
568
    """
569
    assert isinstance(tx, (LegacyTransaction, Bytes))
570
    if isinstance(tx, LegacyTransaction):
571
        return keccak256(rlp.encode(tx))
572
    else:
573
        return keccak256(tx)