ethereum.paris.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.

25
TX_BASE_COST = Uint(21000)

TX_DATA_COST_PER_NON_ZERO

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

31
TX_DATA_COST_PER_NON_ZERO = Uint(16)

TX_DATA_COST_PER_ZERO

Gas cost per zero byte in the transaction data.

36
TX_DATA_COST_PER_ZERO = Uint(4)

TX_CREATE_COST

Additional gas cost for creating a new contract.

41
TX_CREATE_COST = Uint(32000)

TX_ACCESS_LIST_ADDRESS_COST

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

46
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.

51
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.

57
@slotted_freezable
58
@dataclass
class LegacyTransaction:

nonce

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

68
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

73
    gas_price: Uint

gas

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

78
    gas: Uint

to

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

83
    to: Bytes0 | Address

value

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

89
    value: U256

data

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

94
    data: Bytes

v

The recovery id of the signature.

100
    v: U256

r

The first part of the signature.

105
    r: U256

s

The second part of the signature.

110
    s: U256

Access

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

116
@slotted_freezable
117
@dataclass
class Access:

account

The address of the account that is accessed.

124
    account: Address

slots

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

129
    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.

135
@slotted_freezable
136
@dataclass
class AccessListTransaction:

chain_id

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

148
    chain_id: U64

nonce

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

153
    nonce: U256

gas_price

The price of gas for this transaction.

158
    gas_price: Uint

gas

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

163
    gas: Uint

to

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

168
    to: Bytes0 | Address

value

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

174
    value: U256

data

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

179
    data: Bytes

access_list

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

185
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

191
    y_parity: U256

r

The first part of the signature.

196
    r: U256

s

The second part of the signature.

201
    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.

207
@slotted_freezable
208
@dataclass
class FeeMarketTransaction:

chain_id

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

219
    chain_id: U64

nonce

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

224
    nonce: U256

max_priority_fee_per_gas

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

229
    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.

234
    max_fee_per_gas: Uint

gas

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

240
    gas: Uint

to

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

245
    to: Bytes0 | Address

value

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

251
    value: U256

data

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

256
    data: Bytes

access_list

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

262
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

268
    y_parity: U256

r

The first part of the signature.

273
    r: U256

s

The second part of the signature.

278
    s: U256

Transaction

Union type representing any valid transaction type.

284
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:
291
    """
292
    Encode a transaction into its RLP or typed transaction format.
293
    Needed because non-legacy transactions aren't RLP.
294
295
    Legacy transactions are returned as-is, while other transaction types
296
    are prefixed with their type identifier and RLP encoded.
297
    """
298
    if isinstance(tx, LegacyTransaction):
299
        return tx
300
    elif isinstance(tx, AccessListTransaction):
301
        return b"\x01" + rlp.encode(tx)
302
    elif isinstance(tx, FeeMarketTransaction):
303
        return b"\x02" + rlp.encode(tx)
304
    else:
305
        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:
309
    """
310
    Decode a transaction from its RLP or typed transaction format.
311
    Needed because non-legacy transactions aren't RLP.
312
313
    Legacy transactions are returned as-is, while other transaction types
314
    are decoded based on their type identifier prefix.
315
    """
316
    if isinstance(tx, Bytes):
317
        if tx[0] == 1:
318
            return rlp.decode_to(AccessListTransaction, tx[1:])
319
        elif tx[0] == 2:
320
            return rlp.decode_to(FeeMarketTransaction, tx[1:])
321
        else:
322
            raise TransactionTypeError(tx[0])
323
    else:
324
        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:
328
    """
329
    Verifies a transaction.
330
331
    The gas in a transaction gets used to pay for the intrinsic cost of
332
    operations, therefore if there is insufficient gas then it would not
333
    be possible to execute a transaction and it will be declared invalid.
334
335
    Additionally, the nonce of a transaction must not equal or exceed the
336
    limit defined in [EIP-2681].
337
    In practice, defining the limit as ``2**64-1`` has no impact because
338
    sending ``2**64-1`` transactions is improbable. It's not strictly
339
    impossible though, ``2**64-1`` transactions is the entire capacity of the
340
    Ethereum blockchain at 2022 gas limits for a little over 22 years.
341
342
    This function takes a transaction as a parameter and returns the intrinsic
343
    gas cost of the transaction after validation. It throws an
344
    `InsufficientTransactionGasError` exception if the transaction does not
345
    provide enough gas to cover the intrinsic cost, and a `NonceOverflowError`
346
    exception if the nonce is greater than `2**64 - 2`.
347
348
    [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681
349
    """
350
    intrinsic_gas = calculate_intrinsic_cost(tx)
351
    if intrinsic_gas > tx.gas:
352
        raise InsufficientTransactionGasError("Insufficient gas")
353
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
354
        raise NonceOverflowError("Nonce too high")
355
    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:
359
    """
360
    Calculates the gas that is charged before execution is started.
361
362
    The intrinsic cost of the transaction is charged before execution has
363
    begun. Functions/operations in the EVM cost money to execute so this
364
    intrinsic cost is for the operations that need to be paid for as part of
365
    the transaction. Data transfer, for example, is part of this intrinsic
366
    cost. It costs ether to send data over the wire and that ether is
367
    accounted for in the intrinsic cost calculated in this function. This
368
    intrinsic cost must be calculated and paid for before execution in order
369
    for all operations to be implemented.
370
371
    The intrinsic cost includes:
372
    1. Base cost (`TX_BASE_COST`)
373
    2. Cost for data (zero and non-zero bytes)
374
    3. Cost for contract creation (if applicable)
375
    4. Cost for access list entries (if applicable)
376
377
    This function takes a transaction as a parameter and returns the intrinsic
378
    gas cost of the transaction.
379
    """
380
    data_cost = Uint(0)
381
382
    for byte in tx.data:
383
        if byte == 0:
384
            data_cost += TX_DATA_COST_PER_ZERO
385
        else:
386
            data_cost += TX_DATA_COST_PER_NON_ZERO
387
388
    if tx.to == Bytes0(b""):
389
        create_cost = TX_CREATE_COST
390
    else:
391
        create_cost = Uint(0)
392
393
    access_list_cost = Uint(0)
394
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
395
        for access in tx.access_list:
396
            access_list_cost += TX_ACCESS_LIST_ADDRESS_COST
397
            access_list_cost += (
398
                ulen(access.slots) * TX_ACCESS_LIST_STORAGE_KEY_COST
399
            )
400
401
    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:
405
    """
406
    Extracts the sender address from a transaction.
407
408
    The v, r, and s values are the three parts that make up the signature
409
    of a transaction. In order to recover the sender of a transaction the two
410
    components needed are the signature (``v``, ``r``, and ``s``) and the
411
    signing hash of the transaction. The sender's public key can be obtained
412
    with these two values and therefore the sender address can be retrieved.
413
414
    This function takes chain_id and a transaction as parameters and returns
415
    the address of the sender of the transaction. It raises an
416
    `InvalidSignatureError` if the signature values (r, s, v) are invalid.
417
    """
418
    r, s = tx.r, tx.s
419
    if U256(0) >= r or r >= SECP256K1N:
420
        raise InvalidSignatureError("bad r")
421
    if U256(0) >= s or s > SECP256K1N // U256(2):
422
        raise InvalidSignatureError("bad s")
423
424
    if isinstance(tx, LegacyTransaction):
425
        v = tx.v
426
        if v == 27 or v == 28:
427
            public_key = secp256k1_recover(
428
                r, s, v - U256(27), signing_hash_pre155(tx)
429
            )
430
        else:
431
            chain_id_x2 = U256(chain_id) * U256(2)
432
            if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
433
                raise InvalidSignatureError("bad v")
434
            public_key = secp256k1_recover(
435
                r,
436
                s,
437
                v - U256(35) - chain_id_x2,
438
                signing_hash_155(tx, chain_id),
439
            )
440
    elif isinstance(tx, AccessListTransaction):
441
        if tx.y_parity not in (U256(0), U256(1)):
442
            raise InvalidSignatureError("bad y_parity")
443
        public_key = secp256k1_recover(
444
            r, s, tx.y_parity, signing_hash_2930(tx)
445
        )
446
    elif isinstance(tx, FeeMarketTransaction):
447
        if tx.y_parity not in (U256(0), U256(1)):
448
            raise InvalidSignatureError("bad y_parity")
449
        public_key = secp256k1_recover(
450
            r, s, tx.y_parity, signing_hash_1559(tx)
451
        )
452
453
    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:
457
    """
458
    Compute the hash of a transaction used in a legacy (pre [EIP-155])
459
    signature.
460
461
    This function takes a legacy transaction as a parameter and returns the
462
    signing hash of the transaction.
463
464
    [EIP-155]: https://eips.ethereum.org/EIPS/eip-155
465
    """
466
    return keccak256(
467
        rlp.encode(
468
            (
469
                tx.nonce,
470
                tx.gas_price,
471
                tx.gas,
472
                tx.to,
473
                tx.value,
474
                tx.data,
475
            )
476
        )
477
    )

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

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

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

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