transactions.py (in src/ethereum/forks/osaka)

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

IntrinsicGasCost ¶

Intrinsic gas costs for a transaction, split by gas type.

33	@final

34	@dataclass

class IntrinsicGasCost:

regular ¶

Regular execution gas (calldata, base cost, access list, etc.).

38	regular: Uint

calldata_floor ¶

Minimum gas cost based on calldata size per EIP-7623.

41	calldata_floor: Uint

TX_MAX_GAS_LIMIT ¶

49	TX_MAX_GAS_LIMIT = Uint(16_777_216)

LegacyTransaction ¶

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

52	@final

53	@slotted_freezable

54	@dataclass

class LegacyTransaction:

nonce ¶

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

67	nonce: U256

gas_price ¶

The price of gas for this transaction, in wei.

72	gas_price: Uint

gas ¶

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

77	gas: Uint

to ¶

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

82	to: Bytes0 \| Address

value ¶

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

88	value: U256

data ¶

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

93	data: Bytes

v ¶

The recovery id of the signature.

99	v: U256

r ¶

The first part of the signature.

104	r: U256

s ¶

The second part of the signature.

109	s: U256

Access ¶

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

115	@final

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	@final

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	@final

209	@slotted_freezable

210	@dataclass

class FeeMarketTransaction:

chain_id ¶

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

221	chain_id: U64

nonce ¶

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

226	nonce: U256

max_priority_fee_per_gas ¶

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

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

236	max_fee_per_gas: Uint

gas ¶

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

242	gas: Uint

to ¶

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

247	to: Bytes0 \| Address

value ¶

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

253	value: U256

data ¶

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

258	data: Bytes

access_list ¶

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

264	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

270	y_parity: U256

r ¶

The first part of the signature.

275	r: U256

s ¶

The second part of the signature.

280	s: U256

BlobTransaction ¶

The transaction type added in EIP-4844.

This transaction type extends the fee market transaction to support blob-carrying transactions.

286	@final

287	@slotted_freezable

288	@dataclass

class BlobTransaction:

chain_id ¶

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

299	chain_id: U64

nonce ¶

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

304	nonce: U256

max_priority_fee_per_gas ¶

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

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

314	max_fee_per_gas: Uint

gas ¶

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

320	gas: Uint

to ¶

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

325	to: Address

value ¶

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

331	value: U256

data ¶

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

336	data: Bytes

access_list ¶

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

342	access_list: Tuple[Access, ...]

max_fee_per_blob_gas ¶

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

348	max_fee_per_blob_gas: U256

blob_versioned_hashes ¶

A tuple of objects that represent the versioned hashes of the blobs included in the transaction.

353	blob_versioned_hashes: Tuple[VersionedHash, ...]

y_parity ¶

The recovery id of the signature.

359	y_parity: U256

r ¶

The first part of the signature.

364	r: U256

s ¶

The second part of the signature.

369	s: U256

SetCodeTransaction ¶

The transaction type added in EIP-7702.

This transaction type allows Ethereum Externally Owned Accounts (EOAs) to set code on their account, enabling them to act as smart contracts.

375	@final

376	@slotted_freezable

377	@dataclass

class SetCodeTransaction:

chain_id ¶

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

388	chain_id: U64

nonce ¶

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

393	nonce: U64

max_priority_fee_per_gas ¶

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

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

403	max_fee_per_gas: Uint

gas ¶

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

409	gas: Uint

to ¶

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

414	to: Address

value ¶

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

420	value: U256

data ¶

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

425	data: Bytes

access_list ¶

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

431	access_list: Tuple[Access, ...]

authorizations ¶

A tuple of Authorization objects that specify what code the signer desires to execute in the context of their EOA.

437	authorizations: Tuple[Authorization, ...]

y_parity ¶

The recovery id of the signature.

443	y_parity: U256

r ¶

The first part of the signature.

448	r: U256

s ¶

The second part of the signature.

453	s: U256

Transaction ¶

Union type representing any valid transaction type.

459	Transaction = (
460	LegacyTransaction
461	\| AccessListTransaction
462	\| FeeMarketTransaction
463	\| BlobTransaction
464	\| SetCodeTransaction
465	)

AccessListCapableTransaction ¶

Transaction types that include an EIP-2930-style access list.

See has_access_list and Access for more details.

471	AccessListCapableTransaction = (
472	AccessListTransaction
473	\| FeeMarketTransaction
474	\| BlobTransaction
475	\| SetCodeTransaction
476	)

FeeMarketCapableTransaction ¶

Transaction types that include the EIP-1559-style fee structure.

See FeeMarketTransaction for more details.

488	FeeMarketCapableTransaction = (
489	FeeMarketTransaction \| BlobTransaction \| SetCodeTransaction
490	)

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:

502	<snip>
509	if isinstance(tx, LegacyTransaction):
510	return tx
511	elif isinstance(tx, AccessListTransaction):
512	return b"\x01" + rlp.encode(tx)
513	elif isinstance(tx, FeeMarketTransaction):
514	return b"\x02" + rlp.encode(tx)
515	elif isinstance(tx, BlobTransaction):
516	return b"\x03" + rlp.encode(tx)
517	elif isinstance(tx, SetCodeTransaction):
518	return b"\x04" + rlp.encode(tx)
519	else:
520	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:

524	<snip>
531	if isinstance(tx, Bytes):
532	if tx[0] == 1:
533	return rlp.decode_to(AccessListTransaction, tx[1:])
534	elif tx[0] == 2:
535	return rlp.decode_to(FeeMarketTransaction, tx[1:])
536	elif tx[0] == 3:
537	return rlp.decode_to(BlobTransaction, tx[1:])
538	elif tx[0] == 4:
539	return rlp.decode_to(SetCodeTransaction, tx[1:])
540	else:
541	raise TransactionTypeError(tx[0])
542	else:
543	return tx

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.

Also, the code size of a contract creation transaction must be within limits of the protocol.

This function takes a transaction as a parameter and returns the intrinsic gas cost and the minimum calldata gas cost for 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, and 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) -> IntrinsicGasCost:

547	<snip>
577	from .vm.interpreter import MAX_INIT_CODE_SIZE
578
579	intrinsic = calculate_intrinsic_cost(tx)
580	if max(intrinsic.regular, intrinsic.calldata_floor) > tx.gas:
581	raise InsufficientTransactionGasError("Insufficient gas")
582	if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE:
583	raise InitCodeTooLargeError("Code size too large")
584	if tx.gas > TX_MAX_GAS_LIMIT:
585	raise TransactionGasLimitExceededError("Gas limit too high")
586	if U256(tx.nonce) >= U256(U64.MAX_VALUE):
587	raise NonceOverflowError("Nonce too high")
588	if isinstance(tx, FeeMarketCapableTransaction):
589	if tx.max_fee_per_gas < tx.max_priority_fee_per_gas:
590	raise PriorityFeeGreaterThanMaxFeeError(
591	"priority fee greater than max fee"
592	)
593
594	return intrinsic

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:

Base cost (TX_BASE)
Cost for data (zero and non-zero bytes)
Cost for contract creation (if applicable)
Cost for access list entries (if applicable)
Cost for authorizations (if applicable)

This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction and the minimum gas cost used by the transaction based on the calldata size.

def calculate_intrinsic_cost(tx: Transaction) -> IntrinsicGasCost:

598	<snip>
622	from .vm.gas import GasCosts, init_code_cost
623
624	num_zeros = Uint(tx.data.count(0))
625	num_non_zeros = ulen(tx.data) - num_zeros
626
627	tokens_in_calldata = num_zeros + num_non_zeros * Uint(4)
628	# EIP-7623 floor price (note: no EVM costs)
629	calldata_floor_gas_cost = (
630	tokens_in_calldata * GasCosts.TX_DATA_TOKEN_FLOOR + GasCosts.TX_BASE
631	)
632
633	data_cost = tokens_in_calldata * GasCosts.TX_DATA_TOKEN_STANDARD
634
635	if tx.to == Bytes0(b""):
636	create_cost = GasCosts.TX_CREATE + init_code_cost(ulen(tx.data))
637	else:
638	create_cost = Uint(0)
639
640	access_list_cost = Uint(0)
641	if has_access_list(tx):
642	for access in tx.access_list:
643	access_list_cost += GasCosts.TX_ACCESS_LIST_ADDRESS
644	access_list_cost += (
645	ulen(access.slots) * GasCosts.TX_ACCESS_LIST_STORAGE_KEY
646	)
647
648	auth_cost = Uint(0)
649	if isinstance(tx, SetCodeTransaction):
650	auth_cost += Uint(
651	GasCosts.AUTH_PER_EMPTY_ACCOUNT * len(tx.authorizations)
652	)
653
654	return IntrinsicGasCost(
655	regular=Uint(
656	GasCosts.TX_BASE
657	+ data_cost
658	+ create_cost
659	+ access_list_cost
660	+ auth_cost
661	),
662	calldata_floor=calldata_floor_gas_cost,
663	)

chain_id ¶

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

def chain_id(tx: Transaction) -> None | U64:

667	<snip>
672	if isinstance(tx, LegacyTransaction):
673	if tx.v == 27 or tx.v == 28:
674	return None
675
676	if tx.v < U256(35):
677	raise InvalidSignatureError("bad v")
678
679	return U64((tx.v - U256(35)) >> U256(1))
680	else:
681	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:

685	<snip>
698	r, s = tx.r, tx.s
699	if U256(0) >= r or r >= SECP256K1N:
700	raise InvalidSignatureError("bad r")
701	if U256(0) >= s or s > SECP256K1N // U256(2):
702	raise InvalidSignatureError("bad s")
703
704	if isinstance(tx, LegacyTransaction):
705	v = tx.v
706	if v == 27 or v == 28:
707	public_key = secp256k1_recover(
708	r, s, v - U256(27), signing_hash_pre155(tx)
709	)
710	else:
711	assert v >= U256(35), "call chain_id before recover_sender"
712	tx_chain_id = U64((v - U256(35)) >> U256(1))
713	v = (v - U256(35)) & U256(1)
714	public_key = secp256k1_recover(
715	r,
716	s,
717	v,
718	signing_hash_155(tx, tx_chain_id),
719	)
720	elif isinstance(tx, AccessListTransaction):
721	if tx.y_parity not in (U256(0), U256(1)):
722	raise InvalidSignatureError("bad y_parity")
723	public_key = secp256k1_recover(
724	r, s, tx.y_parity, signing_hash_2930(tx)
725	)
726	elif isinstance(tx, FeeMarketTransaction):
727	if tx.y_parity not in (U256(0), U256(1)):
728	raise InvalidSignatureError("bad y_parity")
729	public_key = secp256k1_recover(
730	r, s, tx.y_parity, signing_hash_1559(tx)
731	)
732	elif isinstance(tx, BlobTransaction):
733	if tx.y_parity not in (U256(0), U256(1)):
734	raise InvalidSignatureError("bad y_parity")
735	public_key = secp256k1_recover(
736	r, s, tx.y_parity, signing_hash_4844(tx)
737	)
738	elif isinstance(tx, SetCodeTransaction):
739	if tx.y_parity not in (U256(0), U256(1)):
740	raise InvalidSignatureError("bad y_parity")
741	public_key = secp256k1_recover(
742	r, s, tx.y_parity, signing_hash_7702(tx)
743	)
744
745	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:

749	<snip>
758	return keccak256(
759	rlp.encode(
760	(
761	tx.nonce,
762	tx.gas_price,
763	tx.gas,
764	tx.to,
765	tx.value,
766	tx.data,
767	)
768	)
769	)

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:

773	<snip>
781	return keccak256(
782	rlp.encode(
783	(
784	tx.nonce,
785	tx.gas_price,
786	tx.gas,
787	tx.to,
788	tx.value,
789	tx.data,
790	chain_id,
791	Uint(0),
792	Uint(0),
793	)
794	)
795	)

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:

799	<snip>
807	return keccak256(
808	b"\x01"
809	+ rlp.encode(
810	(
811	tx.chain_id,
812	tx.nonce,
813	tx.gas_price,
814	tx.gas,
815	tx.to,
816	tx.value,
817	tx.data,
818	tx.access_list,
819	)
820	)
821	)

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:

825	<snip>
833	return keccak256(
834	b"\x02"
835	+ rlp.encode(
836	(
837	tx.chain_id,
838	tx.nonce,
839	tx.max_priority_fee_per_gas,
840	tx.max_fee_per_gas,
841	tx.gas,
842	tx.to,
843	tx.value,
844	tx.data,
845	tx.access_list,
846	)
847	)
848	)

signing_hash_4844 ¶

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

This function takes a transaction as a parameter and returns the signing hash of the transaction used in an EIP-4844 signature.

def signing_hash_4844(tx: BlobTransaction) -> Hash32:

852	<snip>
860	return keccak256(
861	b"\x03"
862	+ rlp.encode(
863	(
864	tx.chain_id,
865	tx.nonce,
866	tx.max_priority_fee_per_gas,
867	tx.max_fee_per_gas,
868	tx.gas,
869	tx.to,
870	tx.value,
871	tx.data,
872	tx.access_list,
873	tx.max_fee_per_blob_gas,
874	tx.blob_versioned_hashes,
875	)
876	)
877	)

signing_hash_7702 ¶

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

This function takes a transaction as a parameter and returns the signing hash of the transaction used in a EIP-7702 signature.

def signing_hash_7702(tx: SetCodeTransaction) -> Hash32:

881	<snip>
889	return keccak256(
890	b"\x04"
891	+ rlp.encode(
892	(
893	tx.chain_id,
894	tx.nonce,
895	tx.max_priority_fee_per_gas,
896	tx.max_fee_per_gas,
897	tx.gas,
898	tx.to,
899	tx.value,
900	tx.data,
901	tx.access_list,
902	tx.authorizations,
903	)
904	)
905	)

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:

909	<snip>
917	assert isinstance(tx, (LegacyTransaction, Bytes))
918	if isinstance(tx, LegacyTransaction):
919	return keccak256(rlp.encode(tx))
920	else:
921	return keccak256(tx)

has_access_list ¶

Return whether the transaction has an EIP-2930-style access list.

def has_access_list(tx: Transaction) -> TypeGuard[AccessListCapableTransaction]:

927	<snip>
932	return isinstance(
933	tx,
934	AccessListCapableTransaction,
935	)

Search Results

ethereum.forks.osaka.transactions