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

LegacyTransaction

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

30
@final
31
@slotted_freezable
32
@dataclass
class LegacyTransaction:

nonce

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

42
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

47
    gas_price: Uint

gas

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

52
    gas: Uint

to

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

57
    to: Bytes0 | Address

value

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

63
    value: U256

data

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

68
    data: Bytes

v

The recovery id of the signature.

74
    v: U256

r

The first part of the signature.

79
    r: U256

s

The second part of the signature.

84
    s: U256

Access

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

90
@final
91
@slotted_freezable
92
@dataclass
class Access:

account

The address of the account that is accessed.

99
    account: Address

slots

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

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

110
@final
111
@slotted_freezable
112
@dataclass
class AccessListTransaction:

chain_id

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

124
    chain_id: U64

nonce

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

129
    nonce: U256

gas_price

The price of gas for this transaction.

134
    gas_price: Uint

gas

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

139
    gas: Uint

to

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

144
    to: Bytes0 | Address

value

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

150
    value: U256

data

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

155
    data: Bytes

access_list

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

161
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

167
    y_parity: U256

r

The first part of the signature.

172
    r: U256

s

The second part of the signature.

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

183
@final
184
@slotted_freezable
185
@dataclass
class FeeMarketTransaction:

chain_id

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

196
    chain_id: U64

nonce

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

201
    nonce: U256

max_priority_fee_per_gas

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

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

211
    max_fee_per_gas: Uint

gas

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

217
    gas: Uint

to

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

222
    to: Bytes0 | Address

value

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

228
    value: U256

data

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

233
    data: Bytes

access_list

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

239
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

245
    y_parity: U256

r

The first part of the signature.

250
    r: U256

s

The second part of the signature.

255
    s: U256

Transaction

Union type representing any valid transaction type.

261
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:
268
    <snip>
275
    if isinstance(tx, LegacyTransaction):
276
        return tx
277
    elif isinstance(tx, AccessListTransaction):
278
        return b"\x01" + rlp.encode(tx)
279
    elif isinstance(tx, FeeMarketTransaction):
280
        return b"\x02" + rlp.encode(tx)
281
    else:
282
        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:
286
    <snip>
293
    if isinstance(tx, Bytes):
294
        if tx[0] == 1:
295
            return rlp.decode_to(AccessListTransaction, tx[1:])
296
        elif tx[0] == 2:
297
            return rlp.decode_to(FeeMarketTransaction, tx[1:])
298
        else:
299
            raise TransactionTypeError(tx[0])
300
    else:
301
        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. It also raises a PriorityFeeGreaterThanMaxFeeError if the maximum priority fee per gas of a fee market transaction exceeds its maximum fee per gas.

def validate_transaction(​tx: Transaction​) -> Uint:
305
    <snip>
329
    intrinsic_gas = calculate_intrinsic_cost(tx)
330
    if intrinsic_gas > tx.gas:
331
        raise InsufficientTransactionGasError("Insufficient gas")
332
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
333
        raise NonceOverflowError("Nonce too high")
334
    if isinstance(tx, FeeMarketTransaction):
335
        if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
336
            raise PriorityFeeGreaterThanMaxFeeError(
337
                "priority fee greater than max fee"
338
            )
339
    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)

  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:
343
    <snip>
364
    from .vm.gas import GasCosts
365
366
    num_zeros = Uint(tx.data.count(0))
367
    num_non_zeros = ulen(tx.data) - num_zeros
368
    data_cost = (
369
        num_zeros * GasCosts.TX_DATA_PER_ZERO
370
        + num_non_zeros * GasCosts.TX_DATA_PER_NON_ZERO
371
    )
372
373
    if tx.to == Bytes0(b""):
374
        create_cost = GasCosts.TX_CREATE
375
    else:
376
        create_cost = Uint(0)
377
378
    access_list_cost = Uint(0)
379
    if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)):
380
        for access in tx.access_list:
381
            access_list_cost += GasCosts.TX_ACCESS_LIST_ADDRESS
382
            access_list_cost += (
383
                ulen(access.slots) * GasCosts.TX_ACCESS_LIST_STORAGE_KEY
384
            )
385
386
    return GasCosts.TX_BASE + data_cost + create_cost + access_list_cost

chain_id

Extract the chain identifier from a transaction. See EIP-155.

def chain_id(​tx: Transaction​) -> None | U64:
390
    <snip>
395
    if isinstance(tx, LegacyTransaction):
396
        if tx.v == 27 or tx.v == 28:
397
            return None
398
399
        if tx.v < U256(35):
400
            raise InvalidSignatureError("bad v")
401
402
        return U64((tx.v - U256(35)) >> U256(1))
403
    else:
404
        return tx.chain_id

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(​tx: Transaction​) -> Address:
408
    <snip>
421
    r, s = tx.r, tx.s
422
    if U256(0) >= r or r >= SECP256K1N:
423
        raise InvalidSignatureError("bad r")
424
    if U256(0) >= s or s > SECP256K1N // U256(2):
425
        raise InvalidSignatureError("bad s")
426
427
    if isinstance(tx, LegacyTransaction):
428
        v = tx.v
429
        if v == 27 or v == 28:
430
            public_key = secp256k1_recover(
431
                r, s, v - U256(27), signing_hash_pre155(tx)
432
            )
433
        else:
434
            assert v >= U256(35), "call chain_id before recover_sender"
435
            tx_chain_id = U64((v - U256(35)) >> U256(1))
436
            v = (v - U256(35)) & U256(1)
437
            public_key = secp256k1_recover(
438
                r,
439
                s,
440
                v,
441
                signing_hash_155(tx, tx_chain_id),
442
            )
443
    elif isinstance(tx, AccessListTransaction):
444
        if tx.y_parity not in (U256(0), U256(1)):
445
            raise InvalidSignatureError("bad y_parity")
446
        public_key = secp256k1_recover(
447
            r, s, tx.y_parity, signing_hash_2930(tx)
448
        )
449
    elif isinstance(tx, FeeMarketTransaction):
450
        if tx.y_parity not in (U256(0), U256(1)):
451
            raise InvalidSignatureError("bad y_parity")
452
        public_key = secp256k1_recover(
453
            r, s, tx.y_parity, signing_hash_1559(tx)
454
        )
455
456
    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:
460
    <snip>
469
    return keccak256(
470
        rlp.encode(
471
            (
472
                tx.nonce,
473
                tx.gas_price,
474
                tx.gas,
475
                tx.to,
476
                tx.value,
477
                tx.data,
478
            )
479
        )
480
    )

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:
484
    <snip>
492
    return keccak256(
493
        rlp.encode(
494
            (
495
                tx.nonce,
496
                tx.gas_price,
497
                tx.gas,
498
                tx.to,
499
                tx.value,
500
                tx.data,
501
                chain_id,
502
                Uint(0),
503
                Uint(0),
504
            )
505
        )
506
    )

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:
510
    <snip>
518
    return keccak256(
519
        b"\x01"
520
        + rlp.encode(
521
            (
522
                tx.chain_id,
523
                tx.nonce,
524
                tx.gas_price,
525
                tx.gas,
526
                tx.to,
527
                tx.value,
528
                tx.data,
529
                tx.access_list,
530
            )
531
        )
532
    )

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:
536
    <snip>
544
    return keccak256(
545
        b"\x02"
546
        + rlp.encode(
547
            (
548
                tx.chain_id,
549
                tx.nonce,
550
                tx.max_priority_fee_per_gas,
551
                tx.max_fee_per_gas,
552
                tx.gas,
553
                tx.to,
554
                tx.value,
555
                tx.data,
556
                tx.access_list,
557
            )
558
        )
559
    )

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:
563
    <snip>
571
    assert isinstance(tx, (LegacyTransaction, Bytes))
572
    if isinstance(tx, LegacyTransaction):
573
        return keccak256(rlp.encode(tx))
574
    else:
575
        return keccak256(tx)