ethereum.forks.paris.transactionsethereum.forks.shanghai.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.
GAS_TX_BASE¶
Base cost of a transaction in gas units. This is the minimum amount of gas required to execute a transaction.
| 26 | GAS_TX_BASE = Uint(21000) |
|---|
GAS_TX_DATA_PER_NON_ZERO¶
Gas cost per non-zero byte in the transaction data.
| 32 | GAS_TX_DATA_PER_NON_ZERO = Uint(16) |
|---|
GAS_TX_DATA_PER_ZERO¶
Gas cost per zero byte in the transaction data.
| 37 | GAS_TX_DATA_PER_ZERO = Uint(4) |
|---|
GAS_TX_CREATE¶
Additional gas cost for creating a new contract.
| 42 | GAS_TX_CREATE = Uint(32000) |
|---|
GAS_TX_ACCESS_LIST_ADDRESS¶
Gas cost for including an address in the access list of a transaction.
| 47 | GAS_TX_ACCESS_LIST_ADDRESS = Uint(2400) |
|---|
GAS_TX_ACCESS_LIST_STORAGE_KEY¶
Gas cost for including a storage key in the access list of a transaction.
| 52 | GAS_TX_ACCESS_LIST_STORAGE_KEY = Uint(1900) |
|---|
LegacyTransaction ¶
| 58 | @slotted_freezable |
|---|
| 59 | @dataclass |
|---|
class LegacyTransaction:
nonce¶
A scalar value equal to the number of transactions sent by the sender.
| 69 | nonce: U256 |
|---|
gas_price¶
The price of gas for this transaction, in wei.
| 74 | gas_price: Uint |
|---|
gas¶
The maximum amount of gas that can be used by this transaction.
| 79 | gas: Uint |
|---|
to¶
The address of the recipient. If empty, the transaction is a contract creation.
| 84 | to: Bytes0 | Address |
|---|
value¶
The amount of ether (in wei) to send with this transaction.
| 90 | value: U256 |
|---|
data¶
The data payload of the transaction, which can be used to call functions on contracts or to create new contracts.
| 95 | data: Bytes |
|---|
v¶
The recovery id of the signature.
| 101 | v: U256 |
|---|
r¶
The first part of the signature.
| 106 | r: U256 |
|---|
s¶
The second part of the signature.
| 111 | s: U256 |
|---|
Access ¶
A mapping from account address to storage slots that are pre-warmed as part of a transaction.
| 117 | @slotted_freezable |
|---|
| 118 | @dataclass |
|---|
class Access:
account¶
The address of the account that is accessed.
| 125 | account: Address |
|---|
slots¶
A tuple of storage slots that are accessed in the account.
| 130 | 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.
| 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 | @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 |
|---|
Transaction¶
Union type representing any valid transaction type.
| 285 | Transaction = LegacyTransaction | AccessListTransaction | FeeMarketTransaction |
|---|
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:
| 292 | """ |
|---|---|
| 293 | Encode a transaction into its RLP or typed transaction format. |
| 294 | Needed because non-legacy transactions aren't RLP. |
| 295 | |
| 296 | Legacy transactions are returned as-is, while other transaction types |
| 297 | are prefixed with their type identifier and RLP encoded. |
| 298 | """ |
| 299 | if isinstance(tx, LegacyTransaction): |
| 300 | return tx |
| 301 | elif isinstance(tx, AccessListTransaction): |
| 302 | return b"\x01" + rlp.encode(tx) |
| 303 | elif isinstance(tx, FeeMarketTransaction): |
| 304 | return b"\x02" + rlp.encode(tx) |
| 305 | else: |
| 306 | 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:
| 310 | """ |
|---|---|
| 311 | Decode a transaction from its RLP or typed transaction format. |
| 312 | Needed because non-legacy transactions aren't RLP. |
| 313 | |
| 314 | Legacy transactions are returned as-is, while other transaction types |
| 315 | are decoded based on their type identifier prefix. |
| 316 | """ |
| 317 | if isinstance(tx, Bytes): |
| 318 | if tx[0] == 1: |
| 319 | return rlp.decode_to(AccessListTransaction, tx[1:]) |
| 320 | elif tx[0] == 2: |
| 321 | return rlp.decode_to(FeeMarketTransaction, tx[1:]) |
| 322 | else: |
| 323 | raise TransactionTypeError(tx[0]) |
| 324 | else: |
| 325 | 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 intrinsicAlso, the code size of a contract creation transaction must be within
gas cost of the transaction after validation. It throws an
limits of the protocol.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.
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. It also raises an
InitCodeTooLargeError if the code size of a contract creation transaction
exceeds the maximum allowed size.
def validate_transaction(tx: Transaction) -> Uint:
| 329 | """ |
|---|---|
| 330 | Verifies a transaction. |
| 331 | |
| 332 | The gas in a transaction gets used to pay for the intrinsic cost of |
| 333 | operations, therefore if there is insufficient gas then it would not |
| 334 | be possible to execute a transaction and it will be declared invalid. |
| 335 | |
| 336 | Additionally, the nonce of a transaction must not equal or exceed the |
| 337 | limit defined in [EIP-2681]. |
| 338 | In practice, defining the limit as ``2**64-1`` has no impact because |
| 339 | sending ``2**64-1`` transactions is improbable. It's not strictly |
| 340 | impossible though, ``2**64-1`` transactions is the entire capacity of the |
| 341 | Ethereum blockchain at 2022 gas limits for a little over 22 years. |
| 342 | |
| 343 | Also, the code size of a contract creation transaction must be within |
| 344 | limits of the protocol. |
| 345 | |
| 346 | This function takes a transaction as a parameter and returns the intrinsic |
| 347 | gas cost of the transaction after validation. It throws an |
| 348 | `InsufficientTransactionGasError` exception if the transaction does not |
| 349 | provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` |
| 347 | exception if the nonce is greater than `2**64 - 2`. |
| 350 | exception if the nonce is greater than `2**64 - 2`. It also raises an |
| 351 | `InitCodeTooLargeError` if the code size of a contract creation transaction |
| 352 | exceeds the maximum allowed size. |
| 353 | |
| 354 | [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 |
| 355 | """ |
| 356 | from .vm.interpreter import MAX_INIT_CODE_SIZE |
| 357 | |
| 358 | intrinsic_gas = calculate_intrinsic_cost(tx) |
| 359 | if intrinsic_gas > tx.gas: |
| 360 | raise InsufficientTransactionGasError("Insufficient gas") |
| 361 | if U256(tx.nonce) >= U256(U64.MAX_VALUE): |
| 362 | raise NonceOverflowError("Nonce too high") |
| 363 | if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE: |
| 364 | raise InitCodeTooLargeError("Code size too large") |
| 365 | |
| 366 | 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:
Base cost (
GAS_TX_BASE)Cost for data (zero and non-zero bytes)
Cost for contract creation (if applicable)
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:
| 370 | """ |
|---|---|
| 371 | Calculates the gas that is charged before execution is started. |
| 372 | |
| 373 | The intrinsic cost of the transaction is charged before execution has |
| 374 | begun. Functions/operations in the EVM cost money to execute so this |
| 375 | intrinsic cost is for the operations that need to be paid for as part of |
| 376 | the transaction. Data transfer, for example, is part of this intrinsic |
| 377 | cost. It costs ether to send data over the wire and that ether is |
| 378 | accounted for in the intrinsic cost calculated in this function. This |
| 379 | intrinsic cost must be calculated and paid for before execution in order |
| 380 | for all operations to be implemented. |
| 381 | |
| 382 | The intrinsic cost includes: |
| 383 | 1. Base cost (`GAS_TX_BASE`) |
| 384 | 2. Cost for data (zero and non-zero bytes) |
| 385 | 3. Cost for contract creation (if applicable) |
| 386 | 4. Cost for access list entries (if applicable) |
| 387 | |
| 388 | This function takes a transaction as a parameter and returns the intrinsic |
| 389 | gas cost of the transaction. |
| 390 | """ |
| 391 | from .vm.gas import init_code_cost |
| 392 | |
| 393 | data_cost = Uint(0) |
| 394 | |
| 395 | for byte in tx.data: |
| 396 | if byte == 0: |
| 397 | data_cost += GAS_TX_DATA_PER_ZERO |
| 398 | else: |
| 399 | data_cost += GAS_TX_DATA_PER_NON_ZERO |
| 400 | |
| 401 | if tx.to == Bytes0(b""): |
| 390 | create_cost = GAS_TX_CREATE |
| 402 | create_cost = GAS_TX_CREATE + init_code_cost(ulen(tx.data)) |
| 403 | else: |
| 404 | create_cost = Uint(0) |
| 405 | |
| 406 | access_list_cost = Uint(0) |
| 407 | if isinstance(tx, (AccessListTransaction, FeeMarketTransaction)): |
| 408 | for access in tx.access_list: |
| 409 | access_list_cost += GAS_TX_ACCESS_LIST_ADDRESS |
| 410 | access_list_cost += ( |
| 411 | ulen(access.slots) * GAS_TX_ACCESS_LIST_STORAGE_KEY |
| 412 | ) |
| 413 | |
| 414 | return GAS_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:
| 418 | """ |
|---|---|
| 419 | Extracts the sender address from a transaction. |
| 420 | |
| 421 | The v, r, and s values are the three parts that make up the signature |
| 422 | of a transaction. In order to recover the sender of a transaction the two |
| 423 | components needed are the signature (``v``, ``r``, and ``s``) and the |
| 424 | signing hash of the transaction. The sender's public key can be obtained |
| 425 | with these two values and therefore the sender address can be retrieved. |
| 426 | |
| 427 | This function takes chain_id and a transaction as parameters and returns |
| 428 | the address of the sender of the transaction. It raises an |
| 429 | `InvalidSignatureError` if the signature values (r, s, v) are invalid. |
| 430 | """ |
| 431 | r, s = tx.r, tx.s |
| 432 | if U256(0) >= r or r >= SECP256K1N: |
| 433 | raise InvalidSignatureError("bad r") |
| 434 | if U256(0) >= s or s > SECP256K1N // U256(2): |
| 435 | raise InvalidSignatureError("bad s") |
| 436 | |
| 437 | if isinstance(tx, LegacyTransaction): |
| 438 | v = tx.v |
| 439 | if v == 27 or v == 28: |
| 440 | public_key = secp256k1_recover( |
| 441 | r, s, v - U256(27), signing_hash_pre155(tx) |
| 442 | ) |
| 443 | else: |
| 444 | chain_id_x2 = U256(chain_id) * U256(2) |
| 445 | if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2: |
| 446 | raise InvalidSignatureError("bad v") |
| 447 | public_key = secp256k1_recover( |
| 448 | r, |
| 449 | s, |
| 450 | v - U256(35) - chain_id_x2, |
| 451 | signing_hash_155(tx, chain_id), |
| 452 | ) |
| 453 | elif isinstance(tx, AccessListTransaction): |
| 454 | if tx.y_parity not in (U256(0), U256(1)): |
| 455 | raise InvalidSignatureError("bad y_parity") |
| 456 | public_key = secp256k1_recover( |
| 457 | r, s, tx.y_parity, signing_hash_2930(tx) |
| 458 | ) |
| 459 | elif isinstance(tx, FeeMarketTransaction): |
| 460 | if tx.y_parity not in (U256(0), U256(1)): |
| 461 | raise InvalidSignatureError("bad y_parity") |
| 462 | public_key = secp256k1_recover( |
| 463 | r, s, tx.y_parity, signing_hash_1559(tx) |
| 464 | ) |
| 465 | |
| 466 | 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:
| 470 | """ |
|---|---|
| 471 | Compute the hash of a transaction used in a legacy (pre [EIP-155]) |
| 472 | signature. |
| 473 | |
| 474 | This function takes a legacy transaction as a parameter and returns the |
| 475 | signing hash of the transaction. |
| 476 | |
| 477 | [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 |
| 478 | """ |
| 479 | return keccak256( |
| 480 | rlp.encode( |
| 481 | ( |
| 482 | tx.nonce, |
| 483 | tx.gas_price, |
| 484 | tx.gas, |
| 485 | tx.to, |
| 486 | tx.value, |
| 487 | tx.data, |
| 488 | ) |
| 489 | ) |
| 490 | ) |
signing_hash_155 ¶
def signing_hash_155(tx: LegacyTransaction, chain_id: U64) -> Hash32:
| 494 | """ |
|---|---|
| 495 | Compute the hash of a transaction used in a [EIP-155] signature. |
| 496 | |
| 497 | This function takes a legacy transaction and a chain ID as parameters |
| 498 | and returns the hash of the transaction used in an [EIP-155] signature. |
| 499 | |
| 500 | [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 |
| 501 | """ |
| 502 | return keccak256( |
| 503 | rlp.encode( |
| 504 | ( |
| 505 | tx.nonce, |
| 506 | tx.gas_price, |
| 507 | tx.gas, |
| 508 | tx.to, |
| 509 | tx.value, |
| 510 | tx.data, |
| 511 | chain_id, |
| 512 | Uint(0), |
| 513 | Uint(0), |
| 514 | ) |
| 515 | ) |
| 516 | ) |
signing_hash_2930 ¶
def signing_hash_2930(tx: AccessListTransaction) -> Hash32:
| 520 | """ |
|---|---|
| 521 | Compute the hash of a transaction used in a [EIP-2930] signature. |
| 522 | |
| 523 | This function takes an access list transaction as a parameter |
| 524 | and returns the hash of the transaction used in an [EIP-2930] signature. |
| 525 | |
| 526 | [EIP-2930]: https://eips.ethereum.org/EIPS/eip-2930 |
| 527 | """ |
| 528 | return keccak256( |
| 529 | b"\x01" |
| 530 | + rlp.encode( |
| 531 | ( |
| 532 | tx.chain_id, |
| 533 | tx.nonce, |
| 534 | tx.gas_price, |
| 535 | tx.gas, |
| 536 | tx.to, |
| 537 | tx.value, |
| 538 | tx.data, |
| 539 | tx.access_list, |
| 540 | ) |
| 541 | ) |
| 542 | ) |
signing_hash_1559 ¶
def signing_hash_1559(tx: FeeMarketTransaction) -> Hash32:
| 546 | """ |
|---|---|
| 547 | Compute the hash of a transaction used in an [EIP-1559] signature. |
| 548 | |
| 549 | This function takes a fee market transaction as a parameter |
| 550 | and returns the hash of the transaction used in an [EIP-1559] signature. |
| 551 | |
| 552 | [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 |
| 553 | """ |
| 554 | return keccak256( |
| 555 | b"\x02" |
| 556 | + rlp.encode( |
| 557 | ( |
| 558 | tx.chain_id, |
| 559 | tx.nonce, |
| 560 | tx.max_priority_fee_per_gas, |
| 561 | tx.max_fee_per_gas, |
| 562 | tx.gas, |
| 563 | tx.to, |
| 564 | tx.value, |
| 565 | tx.data, |
| 566 | tx.access_list, |
| 567 | ) |
| 568 | ) |
| 569 | ) |
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:
| 573 | """ |
|---|---|
| 574 | Compute the hash of a transaction. |
| 575 | |
| 576 | This function takes a transaction as a parameter and returns the |
| 577 | keccak256 hash of the transaction. It can handle both legacy transactions |
| 578 | and typed transactions (`AccessListTransaction`, `FeeMarketTransaction`, |
| 579 | etc.). |
| 580 | """ |
| 581 | assert isinstance(tx, (LegacyTransaction, Bytes)) |
| 582 | if isinstance(tx, LegacyTransaction): |
| 583 | return keccak256(rlp.encode(tx)) |
| 584 | else: |
| 585 | return keccak256(tx) |