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

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

45	@final

46	@slotted_freezable

47	@dataclass

class LegacyTransaction:

nonce ¶

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

60	nonce: U256

gas_price ¶

The price of gas for this transaction, in wei.

65	gas_price: Uint

gas ¶

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

70	gas: Uint

to ¶

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

75	to: Bytes0 \| Address

value ¶

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

81	value: U256

data ¶

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

86	data: Bytes

v ¶

The recovery id of the signature.

92	v: U256

r ¶

The first part of the signature.

97	r: U256

s ¶

The second part of the signature.

102	s: U256

Access ¶

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

108	@final

109	@slotted_freezable

110	@dataclass

class Access:

account ¶

The address of the account that is accessed.

117	account: Address

slots ¶

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

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

128	@final

129	@slotted_freezable

130	@dataclass

class AccessListTransaction:

chain_id ¶

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

142	chain_id: U64

nonce ¶

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

147	nonce: U256

gas_price ¶

The price of gas for this transaction.

152	gas_price: Uint

gas ¶

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

157	gas: Uint

to ¶

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

162	to: Bytes0 \| Address

value ¶

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

168	value: U256

data ¶

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

173	data: Bytes

access_list ¶

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

179	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

185	y_parity: U256

r ¶

The first part of the signature.

190	r: U256

s ¶

The second part of the signature.

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

201	@final

202	@slotted_freezable

203	@dataclass

class FeeMarketTransaction:

chain_id ¶

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

214	chain_id: U64

nonce ¶

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

219	nonce: U256

max_priority_fee_per_gas ¶

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

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

229	max_fee_per_gas: Uint

gas ¶

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

235	gas: Uint

to ¶

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

240	to: Bytes0 \| Address

value ¶

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

246	value: U256

data ¶

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

251	data: Bytes

access_list ¶

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

257	access_list: Tuple[Access, ...]

y_parity ¶

The recovery id of the signature.

263	y_parity: U256

r ¶

The first part of the signature.

268	r: U256

s ¶

The second part of the signature.

273	s: U256

BlobTransaction ¶

The transaction type added in EIP-4844.

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

279	@final

280	@slotted_freezable

281	@dataclass

class BlobTransaction:

chain_id ¶

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

292	chain_id: U64

nonce ¶

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

297	nonce: U256

max_priority_fee_per_gas ¶

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

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

307	max_fee_per_gas: Uint

gas ¶

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

313	gas: Uint

to ¶

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

318	to: Address

value ¶

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

324	value: U256

data ¶

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

329	data: Bytes

access_list ¶

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

335	access_list: Tuple[Access, ...]

max_fee_per_blob_gas ¶

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

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

346	blob_versioned_hashes: Tuple[VersionedHash, ...]

y_parity ¶

The recovery id of the signature.

352	y_parity: U256

r ¶

The first part of the signature.

357	r: U256

s ¶

The second part of the signature.

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

368	@final

369	@slotted_freezable

370	@dataclass

class SetCodeTransaction:

chain_id ¶

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

381	chain_id: U64

nonce ¶

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

386	nonce: U64

max_priority_fee_per_gas ¶

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

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

396	max_fee_per_gas: Uint

gas ¶

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

402	gas: Uint

to ¶

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

407	to: Address

value ¶

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

413	value: U256

data ¶

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

418	data: Bytes

access_list ¶

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

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

430	authorizations: Tuple[Authorization, ...]

y_parity ¶

The recovery id of the signature.

436	y_parity: U256

r ¶

The first part of the signature.

441	r: U256

s ¶

The second part of the signature.

446	s: U256

Transaction ¶

Union type representing any valid transaction type.

452	Transaction = (
453	LegacyTransaction
454	\| AccessListTransaction
455	\| FeeMarketTransaction
456	\| BlobTransaction
457	\| SetCodeTransaction
458	)

AccessListCapableTransaction ¶

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

See has_access_list and Access for more details.

464	AccessListCapableTransaction = (
465	AccessListTransaction
466	\| FeeMarketTransaction
467	\| BlobTransaction
468	\| SetCodeTransaction
469	)

FeeMarketCapableTransaction ¶

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

See FeeMarketTransaction for more details.

481	FeeMarketCapableTransaction = (
482	FeeMarketTransaction \| BlobTransaction \| SetCodeTransaction
483	)

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:

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

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

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

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

chain_id ¶

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

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

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

679	<snip>
692	r, s = tx.r, tx.s
693	if U256(0) >= r or r >= SECP256K1N:
694	raise InvalidSignatureError("bad r")
695	if U256(0) >= s or s > SECP256K1N // U256(2):
696	raise InvalidSignatureError("bad s")
697
698	if isinstance(tx, LegacyTransaction):
699	v = tx.v
700	if v == 27 or v == 28:
701	public_key = secp256k1_recover(
702	r, s, v - U256(27), signing_hash_pre155(tx)
703	)
704	else:
705	assert v >= U256(35), "call chain_id before recover_sender"
706	tx_chain_id = U64((v - U256(35)) >> U256(1))
707	v = (v - U256(35)) & U256(1)
708	public_key = secp256k1_recover(
709	r,
710	s,
711	v,
712	signing_hash_155(tx, tx_chain_id),
713	)
714	elif isinstance(tx, AccessListTransaction):
715	if tx.y_parity not in (U256(0), U256(1)):
716	raise InvalidSignatureError("bad y_parity")
717	public_key = secp256k1_recover(
718	r, s, tx.y_parity, signing_hash_2930(tx)
719	)
720	elif isinstance(tx, FeeMarketTransaction):
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_1559(tx)
725	)
726	elif isinstance(tx, BlobTransaction):
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_4844(tx)
731	)
732	elif isinstance(tx, SetCodeTransaction):
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_7702(tx)
737	)
738
739	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:

743	<snip>
752	return keccak256(
753	rlp.encode(
754	(
755	tx.nonce,
756	tx.gas_price,
757	tx.gas,
758	tx.to,
759	tx.value,
760	tx.data,
761	)
762	)
763	)

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:

767	<snip>
775	return keccak256(
776	rlp.encode(
777	(
778	tx.nonce,
779	tx.gas_price,
780	tx.gas,
781	tx.to,
782	tx.value,
783	tx.data,
784	chain_id,
785	Uint(0),
786	Uint(0),
787	)
788	)
789	)

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:

793	<snip>
801	return keccak256(
802	b"\x01"
803	+ rlp.encode(
804	(
805	tx.chain_id,
806	tx.nonce,
807	tx.gas_price,
808	tx.gas,
809	tx.to,
810	tx.value,
811	tx.data,
812	tx.access_list,
813	)
814	)
815	)

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:

819	<snip>
827	return keccak256(
828	b"\x02"
829	+ rlp.encode(
830	(
831	tx.chain_id,
832	tx.nonce,
833	tx.max_priority_fee_per_gas,
834	tx.max_fee_per_gas,
835	tx.gas,
836	tx.to,
837	tx.value,
838	tx.data,
839	tx.access_list,
840	)
841	)
842	)

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:

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

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:

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

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:

903	<snip>
911	assert isinstance(tx, (LegacyTransaction, Bytes))
912	if isinstance(tx, LegacyTransaction):
913	return keccak256(rlp.encode(tx))
914	else:
915	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]:

921	<snip>
926	return isinstance(
927	tx,
928	AccessListCapableTransaction,
929	)

Search Results

ethereum.forks.bpo4.transactions