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

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.

49	@final

50	@slotted_freezable

51	@dataclass

class LegacyTransaction:

nonce ¶

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

64	nonce: U256

gas_price ¶

The price of gas for this transaction, in wei.

69	gas_price: Uint

gas ¶

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

74	gas: Uint

to ¶

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

79	to: Bytes0 \| Address

value ¶

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

85	value: U256

data ¶

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

90	data: Bytes

v ¶

The recovery id of the signature.

96	v: U256

r ¶

The first part of the signature.

101	r: U256

s ¶

The second part of the signature.

106	s: U256

Access ¶

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

112	@final

113	@slotted_freezable

114	@dataclass

class Access:

account ¶

The address of the account that is accessed.

121	account: Address

slots ¶

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

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

132	@final

133	@slotted_freezable

134	@dataclass

class AccessListTransaction:

chain_id ¶

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

146	chain_id: U64

nonce ¶

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

151	nonce: U256

gas_price ¶

The price of gas for this transaction.

156	gas_price: Uint

gas ¶

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

161	gas: Uint

to ¶

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

166	to: Bytes0 \| Address

value ¶

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

172	value: U256

data ¶

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

177	data: Bytes

access_list ¶

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

183	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

189	y_parity: U256

r ¶

The first part of the signature.

194	r: U256

s ¶

The second part of the signature.

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

205	@final

206	@slotted_freezable

207	@dataclass

class FeeMarketTransaction:

chain_id ¶

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

218	chain_id: U64

nonce ¶

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

223	nonce: U256

max_priority_fee_per_gas ¶

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

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

233	max_fee_per_gas: Uint

gas ¶

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

239	gas: Uint

to ¶

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

244	to: Bytes0 \| Address

value ¶

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

250	value: U256

data ¶

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

255	data: Bytes

access_list ¶

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

261	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

267	y_parity: U256

r ¶

The first part of the signature.

272	r: U256

s ¶

The second part of the signature.

277	s: U256

BlobTransaction ¶

The transaction type added in EIP-4844.

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

283	@final

284	@slotted_freezable

285	@dataclass

class BlobTransaction:

chain_id ¶

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

296	chain_id: U64

nonce ¶

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

301	nonce: U256

max_priority_fee_per_gas ¶

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

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

311	max_fee_per_gas: Uint

gas ¶

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

317	gas: Uint

to ¶

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

322	to: Address

value ¶

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

328	value: U256

data ¶

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

333	data: Bytes

access_list ¶

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

339	access_list: Tuple[Access, ...]

max_fee_per_blob_gas ¶

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

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

350	blob_versioned_hashes: Tuple[VersionedHash, ...]

y_parity ¶

The recovery id of the signature.

356	y_parity: U256

r ¶

The first part of the signature.

361	r: U256

s ¶

The second part of the signature.

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

372	@final

373	@slotted_freezable

374	@dataclass

class SetCodeTransaction:

chain_id ¶

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

385	chain_id: U64

nonce ¶

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

390	nonce: U64

max_priority_fee_per_gas ¶

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

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

400	max_fee_per_gas: Uint

gas ¶

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

406	gas: Uint

to ¶

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

411	to: Address

value ¶

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

417	value: U256

data ¶

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

422	data: Bytes

access_list ¶

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

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

434	authorizations: Tuple[Authorization, ...]

y_parity ¶

The recovery id of the signature.

440	y_parity: U256

r ¶

The first part of the signature.

445	r: U256

s ¶

The second part of the signature.

450	s: U256

Transaction ¶

Union type representing any valid transaction type.

456	Transaction = (
457	LegacyTransaction
458	\| AccessListTransaction
459	\| FeeMarketTransaction
460	\| BlobTransaction
461	\| SetCodeTransaction
462	)

AccessListCapableTransaction ¶

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

See has_access_list and Access for more details.

468	AccessListCapableTransaction = (
469	AccessListTransaction
470	\| FeeMarketTransaction
471	\| BlobTransaction
472	\| SetCodeTransaction
473	)

FeeMarketCapableTransaction ¶

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

See FeeMarketTransaction for more details.

485	FeeMarketCapableTransaction = (
486	FeeMarketTransaction \| BlobTransaction \| SetCodeTransaction
487	)

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:

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

521	<snip>
528	if isinstance(tx, Bytes):
529	if tx[0] == 1:
530	return rlp.decode_to(AccessListTransaction, tx[1:])
531	elif tx[0] == 2:
532	return rlp.decode_to(FeeMarketTransaction, tx[1:])
533	elif tx[0] == 3:
534	return rlp.decode_to(BlobTransaction, tx[1:])
535	elif tx[0] == 4:
536	return rlp.decode_to(SetCodeTransaction, tx[1:])
537	else:
538	raise TransactionTypeError(tx[0])
539	else:
540	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:

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

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

chain_id ¶

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

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

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

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

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

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:

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

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:

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

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:

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

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:

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

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:

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

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:

907	<snip>
915	assert isinstance(tx, (LegacyTransaction, Bytes))
916	if isinstance(tx, LegacyTransaction):
917	return keccak256(rlp.encode(tx))
918	else:
919	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]:

925	<snip>
930	return isinstance(
931	tx,
932	AccessListCapableTransaction,
933	)

Search Results

ethereum.forks.osaka.transactions