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.

32	@final

33	@dataclass

class IntrinsicGasCost:

regular ¶

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

37	regular: Uint

calldata_floor ¶

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

40	calldata_floor: Uint

TX_MAX_GAS_LIMIT ¶

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

51	@final

52	@slotted_freezable

53	@dataclass

class LegacyTransaction:

nonce ¶

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

66	nonce: U256

gas_price ¶

The price of gas for this transaction, in wei.

71	gas_price: Uint

gas ¶

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

76	gas: Uint

to ¶

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

81	to: Bytes0 \| Address

value ¶

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

87	value: U256

data ¶

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

92	data: Bytes

v ¶

The recovery id of the signature.

98	v: U256

r ¶

The first part of the signature.

103	r: U256

s ¶

The second part of the signature.

108	s: U256

Access ¶

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

114	@final

115	@slotted_freezable

116	@dataclass

class Access:

account ¶

The address of the account that is accessed.

123	account: Address

slots ¶

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

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

134	@final

135	@slotted_freezable

136	@dataclass

class AccessListTransaction:

chain_id ¶

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

148	chain_id: U64

nonce ¶

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

153	nonce: U256

gas_price ¶

The price of gas for this transaction.

158	gas_price: Uint

gas ¶

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

163	gas: Uint

to ¶

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

168	to: Bytes0 \| Address

value ¶

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

174	value: U256

data ¶

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

179	data: Bytes

access_list ¶

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

185	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

191	y_parity: U256

r ¶

The first part of the signature.

196	r: U256

s ¶

The second part of the signature.

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

207	@final

208	@slotted_freezable

209	@dataclass

class FeeMarketTransaction:

chain_id ¶

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

220	chain_id: U64

nonce ¶

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

225	nonce: U256

max_priority_fee_per_gas ¶

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

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

235	max_fee_per_gas: Uint

gas ¶

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

241	gas: Uint

to ¶

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

246	to: Bytes0 \| Address

value ¶

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

252	value: U256

data ¶

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

257	data: Bytes

access_list ¶

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

263	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

269	y_parity: U256

r ¶

The first part of the signature.

274	r: U256

s ¶

The second part of the signature.

279	s: U256

BlobTransaction ¶

The transaction type added in EIP-4844.

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

285	@final

286	@slotted_freezable

287	@dataclass

class BlobTransaction:

chain_id ¶

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

298	chain_id: U64

nonce ¶

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

303	nonce: U256

max_priority_fee_per_gas ¶

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

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

313	max_fee_per_gas: Uint

gas ¶

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

319	gas: Uint

to ¶

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

324	to: Address

value ¶

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

330	value: U256

data ¶

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

335	data: Bytes

access_list ¶

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

341	access_list: Tuple[Access, ...]

max_fee_per_blob_gas ¶

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

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

352	blob_versioned_hashes: Tuple[VersionedHash, ...]

y_parity ¶

The recovery id of the signature.

358	y_parity: U256

r ¶

The first part of the signature.

363	r: U256

s ¶

The second part of the signature.

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

374	@final

375	@slotted_freezable

376	@dataclass

class SetCodeTransaction:

chain_id ¶

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

387	chain_id: U64

nonce ¶

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

392	nonce: U64

max_priority_fee_per_gas ¶

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

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

402	max_fee_per_gas: Uint

gas ¶

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

408	gas: Uint

to ¶

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

413	to: Address

value ¶

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

419	value: U256

data ¶

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

424	data: Bytes

access_list ¶

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

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

436	authorizations: Tuple[Authorization, ...]

y_parity ¶

The recovery id of the signature.

442	y_parity: U256

r ¶

The first part of the signature.

447	r: U256

s ¶

The second part of the signature.

452	s: U256

Transaction ¶

Union type representing any valid transaction type.

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

AccessListCapableTransaction ¶

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

See has_access_list and Access for more details.

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

FeeMarketCapableTransaction ¶

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

See FeeMarketTransaction for more details.

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

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:

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

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

def validate_transaction(tx: Transaction) -> IntrinsicGasCost:

546	<snip>
574	from .vm.interpreter import MAX_INIT_CODE_SIZE
575
576	intrinsic = calculate_intrinsic_cost(tx)
577	if max(intrinsic.regular, intrinsic.calldata_floor) > tx.gas:
578	raise InsufficientTransactionGasError("Insufficient gas")
579	if U256(tx.nonce) >= U256(U64.MAX_VALUE):
580	raise NonceOverflowError("Nonce too high")
581	if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE:
582	raise InitCodeTooLargeError("Code size too large")
583	if tx.gas > TX_MAX_GAS_LIMIT:
584	raise TransactionGasLimitExceededError("Gas limit too high")
585
586	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:

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

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:

659	<snip>
672	r, s = tx.r, tx.s
673	if U256(0) >= r or r >= SECP256K1N:
674	raise InvalidSignatureError("bad r")
675	if U256(0) >= s or s > SECP256K1N // U256(2):
676	raise InvalidSignatureError("bad s")
677
678	if isinstance(tx, LegacyTransaction):
679	v = tx.v
680	if v == 27 or v == 28:
681	public_key = secp256k1_recover(
682	r, s, v - U256(27), signing_hash_pre155(tx)
683	)
684	else:
685	chain_id_x2 = U256(chain_id) * U256(2)
686	if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2:
687	raise InvalidSignatureError("bad v")
688	public_key = secp256k1_recover(
689	r,
690	s,
691	v - U256(35) - chain_id_x2,
692	signing_hash_155(tx, chain_id),
693	)
694	elif isinstance(tx, AccessListTransaction):
695	if tx.y_parity not in (U256(0), U256(1)):
696	raise InvalidSignatureError("bad y_parity")
697	public_key = secp256k1_recover(
698	r, s, tx.y_parity, signing_hash_2930(tx)
699	)
700	elif isinstance(tx, FeeMarketTransaction):
701	if tx.y_parity not in (U256(0), U256(1)):
702	raise InvalidSignatureError("bad y_parity")
703	public_key = secp256k1_recover(
704	r, s, tx.y_parity, signing_hash_1559(tx)
705	)
706	elif isinstance(tx, BlobTransaction):
707	if tx.y_parity not in (U256(0), U256(1)):
708	raise InvalidSignatureError("bad y_parity")
709	public_key = secp256k1_recover(
710	r, s, tx.y_parity, signing_hash_4844(tx)
711	)
712	elif isinstance(tx, SetCodeTransaction):
713	if tx.y_parity not in (U256(0), U256(1)):
714	raise InvalidSignatureError("bad y_parity")
715	public_key = secp256k1_recover(
716	r, s, tx.y_parity, signing_hash_7702(tx)
717	)
718
719	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:

723	<snip>
732	return keccak256(
733	rlp.encode(
734	(
735	tx.nonce,
736	tx.gas_price,
737	tx.gas,
738	tx.to,
739	tx.value,
740	tx.data,
741	)
742	)
743	)

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:

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

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:

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

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:

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

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:

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

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:

855	<snip>
863	return keccak256(
864	b"\x04"
865	+ rlp.encode(
866	(
867	tx.chain_id,
868	tx.nonce,
869	tx.max_priority_fee_per_gas,
870	tx.max_fee_per_gas,
871	tx.gas,
872	tx.to,
873	tx.value,
874	tx.data,
875	tx.access_list,
876	tx.authorizations,
877	)
878	)
879	)

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:

883	<snip>
891	assert isinstance(tx, (LegacyTransaction, Bytes))
892	if isinstance(tx, LegacyTransaction):
893	return keccak256(rlp.encode(tx))
894	else:
895	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]:

901	<snip>
906	return isinstance(
907	tx,
908	AccessListCapableTransaction,
909	)

Search Results

ethereum.forks.osaka.transactions