ethereum.forks.muir_glacier.transactionsethereum.forks.berlin.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-2930.

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

nonce

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

38
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

43
    gas_price: Uint

gas

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

48
    gas: Uint

to

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

53
    to: Bytes0 | Address

value

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

59
    value: U256

data

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

64
    data: Bytes

v

The recovery id of the signature.

70
    v: U256

r

The first part of the signature.

75
    r: U256

s

The second part of the signature.

80
    s: U256

Access

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

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

account

The address of the account that is accessed.

95
    account: Address

slots

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

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

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

chain_id

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

120
    chain_id: U64

nonce

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

125
    nonce: U256

gas_price

The price of gas for this transaction.

130
    gas_price: Uint

gas

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

135
    gas: Uint

to

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

140
    to: Bytes0 | Address

value

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

146
    value: U256

data

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

151
    data: Bytes

access_list

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

157
    access_list: Tuple[Access, ...]

y_parity

The recovery id of the signature.

163
    y_parity: U256

r

The first part of the signature.

168
    r: U256

s

The second part of the signature.

173
    s: U256

Transaction

Atomic operation performed on the block chain.

25
@final
26
@slotted_freezable
27
@dataclass
class Transaction:

nonce

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

33
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

38
    gas_price: Uint

gas

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

43
    gas: Uint

to

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

48
    to: Bytes0 | Address

value

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

54
    value: U256

data

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

59
    data: Bytes

v

The recovery id of the signature.

65
    v: U256

r

The first part of the signature.

70
    r: U256

s

The second part of the signature.

75
    s: U256

Transaction

Union type representing any valid transaction type.

179
Transaction = LegacyTransaction | AccessListTransaction

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:
186
    <snip>
193
    if isinstance(tx, LegacyTransaction):
194
        return tx
195
    elif isinstance(tx, AccessListTransaction):
196
        return b"\x01" + rlp.encode(tx)
197
    else:
198
        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:
202
    <snip>
209
    if isinstance(tx, Bytes):
210
        if tx[0] != 1:
211
            raise TransactionTypeError(tx[0])
212
        return rlp.decode_to(AccessListTransaction, tx[1:])
213
    else:
214
        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:
218
    <snip>
240
    intrinsic_gas = calculate_intrinsic_cost(tx)
241
    if intrinsic_gas > tx.gas:
242
        raise InsufficientTransactionGasError("Insufficient gas")
243
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
244
        raise NonceOverflowError("Nonce too high")
245
    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:
249
    <snip>
270
    from .vm.gas import GasCosts
271
272
    num_zeros = Uint(tx.data.count(0))
273
    num_non_zeros = ulen(tx.data) - num_zeros
274
    data_cost = (
275
        num_zeros * GasCosts.TX_DATA_PER_ZERO
276
        + num_non_zeros * GasCosts.TX_DATA_PER_NON_ZERO
277
    )
278
279
    if tx.to == Bytes0(b""):
280
        create_cost = GasCosts.TX_CREATE
281
    else:
282
        create_cost = Uint(0)
283
147
    return GasCosts.TX_BASE + data_cost + create_cost
284
    access_list_cost = Uint(0)
285
    if isinstance(tx, AccessListTransaction):
286
        for access in tx.access_list:
287
            access_list_cost += GasCosts.TX_ACCESS_LIST_ADDRESS
288
            access_list_cost += (
289
                ulen(access.slots) * GasCosts.TX_ACCESS_LIST_STORAGE_KEY
290
            )
291
292
    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:
296
    <snip>
164
    v, r, s = tx.v, tx.r, tx.s
309
    r, s = tx.r, tx.s
310
    if U256(0) >= r or r >= SECP256K1N:
311
        raise InvalidSignatureError("bad r")
312
    if U256(0) >= s or s > SECP256K1N // U256(2):
313
        raise InvalidSignatureError("bad s")
314
170
    if v == 27 or v == 28:
171
        public_key = secp256k1_recover(
172
            r, s, v - U256(27), signing_hash_pre155(tx)
173
        )
174
    else:
175
        chain_id_x2 = U256(chain_id) * U256(2)
176
        if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
177
            raise InvalidSignatureError("bad v")
178
        public_key = secp256k1_recover(
179
            r, s, v - U256(35) - chain_id_x2, signing_hash_155(tx, chain_id)
180
        )
315
    if isinstance(tx, LegacyTransaction):
316
        v = tx.v
317
        if v == 27 or v == 28:
318
            public_key = secp256k1_recover(
319
                r, s, v - U256(27), signing_hash_pre155(tx)
320
            )
321
        else:
322
            chain_id_x2 = U256(chain_id) * U256(2)
323
            if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
324
                raise InvalidSignatureError("bad v")
325
            public_key = secp256k1_recover(
326
                r,
327
                s,
328
                v - U256(35) - chain_id_x2,
329
                signing_hash_155(tx, chain_id),
330
            )
331
    elif isinstance(tx, AccessListTransaction):
332
        if tx.y_parity not in (U256(0), U256(1)):
333
            raise InvalidSignatureError("bad y_parity")
334
        public_key = secp256k1_recover(
335
            r, s, tx.y_parity, signing_hash_2930(tx)
336
        )
337
338
    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 transaction as a parameter and returns the signing hash of the transaction.hash of the transaction used in a legacy signature.

def signing_hash_pre155(​tx: Transaction​) -> Hash32:
342
    <snip>
351
    return keccak256(
352
        rlp.encode(
353
            (
354
                tx.nonce,
355
                tx.gas_price,
356
                tx.gas,
357
                tx.to,
358
                tx.value,
359
                tx.data,
360
            )
361
        )
362
    )

signing_hash_155

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

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

def signing_hash_155(​tx: Transaction, ​​chain_id: U64​) -> Hash32:
366
    <snip>
374
    return keccak256(
375
        rlp.encode(
376
            (
377
                tx.nonce,
378
                tx.gas_price,
379
                tx.gas,
380
                tx.to,
381
                tx.value,
382
                tx.data,
383
                chain_id,
384
                Uint(0),
385
                Uint(0),
386
            )
387
        )
388
    )

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:
392
    <snip>
400
    return keccak256(
401
        b"\x01"
402
        + rlp.encode(
403
            (
404
                tx.chain_id,
405
                tx.nonce,
406
                tx.gas_price,
407
                tx.gas,
408
                tx.to,
409
                tx.value,
410
                tx.data,
411
                tx.access_list,
412
            )
413
        )
414
    )

get_transaction_hash

Compute the hash of a transaction.

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

def get_transaction_hash(​tx: TransactionBytes | LegacyTransaction​) -> Hash32:
418
    <snip>
242
    return keccak256(rlp.encode(tx))
425
    assert isinstance(tx, (LegacyTransaction, Bytes))
426
    if isinstance(tx, LegacyTransaction):
427
        return keccak256(rlp.encode(tx))
428
    else:
429
        return keccak256(tx)