ethereum.forks.paris.transactionsethereum.forks.shanghai.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.

27
@final
28
@slotted_freezable
29
@dataclass
class LegacyTransaction:

nonce

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

39
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

44
    gas_price: Uint

gas

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

49
    gas: Uint

to

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

54
    to: Bytes0 | Address

value

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

60
    value: U256

data

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

65
    data: Bytes

v

The recovery id of the signature.

71
    v: U256

r

The first part of the signature.

76
    r: U256

s

The second part of the signature.

81
    s: U256

Access

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

87
@final
88
@slotted_freezable
89
@dataclass
class Access:

account

The address of the account that is accessed.

96
    account: Address

slots

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

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

107
@final
108
@slotted_freezable
109
@dataclass
class AccessListTransaction:

chain_id

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

121
    chain_id: U64

nonce

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

126
    nonce: U256

gas_price

The price of gas for this transaction.

131
    gas_price: Uint

gas

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

136
    gas: Uint

to

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

141
    to: Bytes0 | Address

value

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

147
    value: U256

data

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

152
    data: Bytes

access_list

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

158
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

164
    y_parity: U256

r

The first part of the signature.

169
    r: U256

s

The second part of the signature.

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

180
@final
181
@slotted_freezable
182
@dataclass
class FeeMarketTransaction:

chain_id

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

193
    chain_id: U64

nonce

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

198
    nonce: U256

max_priority_fee_per_gas

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

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

208
    max_fee_per_gas: Uint

gas

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

214
    gas: Uint

to

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

219
    to: Bytes0 | Address

value

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

225
    value: U256

data

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

230
    data: Bytes

access_list

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

236
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

242
    y_parity: U256

r

The first part of the signature.

247
    r: U256

s

The second part of the signature.

252
    s: U256

Transaction

Union type representing any valid transaction type.

258
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:
265
    <snip>
272
    if isinstance(tx, LegacyTransaction):
273
        return tx
274
    elif isinstance(tx, AccessListTransaction):
275
        return b"\x01" + rlp.encode(tx)
276
    elif isinstance(tx, FeeMarketTransaction):
277
        return b"\x02" + rlp.encode(tx)
278
    else:
279
        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:
283
    <snip>
290
    if isinstance(tx, Bytes):
291
        if tx[0] == 1:
292
            return rlp.decode_to(AccessListTransaction, tx[1:])
293
        elif tx[0] == 2:
294
            return rlp.decode_to(FeeMarketTransaction, tx[1:])
295
        else:
296
            raise TransactionTypeError(tx[0])
297
    else:
298
        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 intrinsicAlso, the code size of a contract creation transaction must be within 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.limits of the protocol.

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 an InitCodeTooLargeError if the code size of a contract creation transaction exceeds the maximum allowed size.

def validate_transaction(​tx: Transaction​) -> Uint:
302
    <snip>
329
    from .vm.interpreter import MAX_INIT_CODE_SIZE
330
331
    intrinsic_gas = calculate_intrinsic_cost(tx)
332
    if intrinsic_gas > tx.gas:
333
        raise InsufficientTransactionGasError("Insufficient gas")
334
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
335
        raise NonceOverflowError("Nonce too high")
336
    if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE:
337
        raise InitCodeTooLargeError("Code size too large")
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>
354
    from .vm.gas import GasCosts
364
    from .vm.gas import GasCosts, init_code_cost
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""):
364
        create_cost = GasCosts.TX_CREATE
374
        create_cost = GasCosts.TX_CREATE + init_code_cost(ulen(tx.data))
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

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:
390
    <snip>
403
    r, s = tx.r, tx.s
404
    if U256(0) >= r or r >= SECP256K1N:
405
        raise InvalidSignatureError("bad r")
406
    if U256(0) >= s or s > SECP256K1N // U256(2):
407
        raise InvalidSignatureError("bad s")
408
409
    if isinstance(tx, LegacyTransaction):
410
        v = tx.v
411
        if v == 27 or v == 28:
412
            public_key = secp256k1_recover(
413
                r, s, v - U256(27), signing_hash_pre155(tx)
414
            )
415
        else:
416
            chain_id_x2 = U256(chain_id) * U256(2)
417
            if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
418
                raise InvalidSignatureError("bad v")
419
            public_key = secp256k1_recover(
420
                r,
421
                s,
422
                v - U256(35) - chain_id_x2,
423
                signing_hash_155(tx, chain_id),
424
            )
425
    elif isinstance(tx, AccessListTransaction):
426
        if tx.y_parity not in (U256(0), U256(1)):
427
            raise InvalidSignatureError("bad y_parity")
428
        public_key = secp256k1_recover(
429
            r, s, tx.y_parity, signing_hash_2930(tx)
430
        )
431
    elif isinstance(tx, FeeMarketTransaction):
432
        if tx.y_parity not in (U256(0), U256(1)):
433
            raise InvalidSignatureError("bad y_parity")
434
        public_key = secp256k1_recover(
435
            r, s, tx.y_parity, signing_hash_1559(tx)
436
        )
437
438
    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:
442
    <snip>
451
    return keccak256(
452
        rlp.encode(
453
            (
454
                tx.nonce,
455
                tx.gas_price,
456
                tx.gas,
457
                tx.to,
458
                tx.value,
459
                tx.data,
460
            )
461
        )
462
    )

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:
466
    <snip>
474
    return keccak256(
475
        rlp.encode(
476
            (
477
                tx.nonce,
478
                tx.gas_price,
479
                tx.gas,
480
                tx.to,
481
                tx.value,
482
                tx.data,
483
                chain_id,
484
                Uint(0),
485
                Uint(0),
486
            )
487
        )
488
    )

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:
492
    <snip>
500
    return keccak256(
501
        b"\x01"
502
        + rlp.encode(
503
            (
504
                tx.chain_id,
505
                tx.nonce,
506
                tx.gas_price,
507
                tx.gas,
508
                tx.to,
509
                tx.value,
510
                tx.data,
511
                tx.access_list,
512
            )
513
        )
514
    )

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:
518
    <snip>
526
    return keccak256(
527
        b"\x02"
528
        + rlp.encode(
529
            (
530
                tx.chain_id,
531
                tx.nonce,
532
                tx.max_priority_fee_per_gas,
533
                tx.max_fee_per_gas,
534
                tx.gas,
535
                tx.to,
536
                tx.value,
537
                tx.data,
538
                tx.access_list,
539
            )
540
        )
541
    )

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:
545
    <snip>
553
    assert isinstance(tx, (LegacyTransaction, Bytes))
554
    if isinstance(tx, LegacyTransaction):
555
        return keccak256(rlp.encode(tx))
556
    else:
557
        return keccak256(tx)