ethereum.forks.byzantium.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.
Transaction ¶
Atomic operation performed on the block chain.
| 25 | @slotted_freezable |
|---|
| 26 | @dataclass |
|---|
class Transaction:
nonce¶
A scalar value equal to the number of transactions sent by the sender.
| 32 | nonce: U256 |
|---|
gas_price¶
The price of gas for this transaction, in wei.
| 37 | gas_price: Uint |
|---|
gas¶
The maximum amount of gas that can be used by this transaction.
| 42 | gas: Uint |
|---|
to¶
The address of the recipient. If empty, the transaction is a contract creation.
| 47 | to: Bytes0 | Address |
|---|
value¶
The amount of ether (in wei) to send with this transaction.
| 53 | value: U256 |
|---|
data¶
The data payload of the transaction, which can be used to call functions on contracts or to create new contracts.
| 58 | data: Bytes |
|---|
v¶
The recovery id of the signature.
| 64 | v: U256 |
|---|
r¶
The first part of the signature.
| 69 | r: U256 |
|---|
s¶
The second part of the signature.
| 74 | s: U256 |
|---|
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 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.
def validate_transaction(tx: Transaction) -> Uint:
| 81 | """ |
|---|---|
| 82 | Verifies a transaction. |
| 83 | |
| 84 | The gas in a transaction gets used to pay for the intrinsic cost of |
| 85 | operations, therefore if there is insufficient gas then it would not |
| 86 | be possible to execute a transaction and it will be declared invalid. |
| 87 | |
| 88 | Additionally, the nonce of a transaction must not equal or exceed the |
| 89 | limit defined in [EIP-2681]. |
| 90 | In practice, defining the limit as ``2**64-1`` has no impact because |
| 91 | sending ``2**64-1`` transactions is improbable. It's not strictly |
| 92 | impossible though, ``2**64-1`` transactions is the entire capacity of the |
| 93 | Ethereum blockchain at 2022 gas limits for a little over 22 years. |
| 94 | |
| 95 | This function takes a transaction as a parameter and returns the intrinsic |
| 96 | gas cost of the transaction after validation. It throws an |
| 97 | `InsufficientTransactionGasError` exception if the transaction does not |
| 98 | provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` |
| 99 | exception if the nonce is greater than `2**64 - 2`. |
| 100 | |
| 101 | [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 |
| 102 | """ |
| 103 | intrinsic_gas = calculate_intrinsic_cost(tx) |
| 104 | if intrinsic_gas > tx.gas: |
| 105 | raise InsufficientTransactionGasError("Insufficient gas") |
| 106 | if U256(tx.nonce) >= U256(U64.MAX_VALUE): |
| 107 | raise NonceOverflowError("Nonce too high") |
| 108 | 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 (
TX_BASE)Cost for data (zero and non-zero bytes)
Cost for contract creation (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:
| 112 | """ |
|---|---|
| 113 | Calculates the gas that is charged before execution is started. |
| 114 | |
| 115 | The intrinsic cost of the transaction is charged before execution has |
| 116 | begun. Functions/operations in the EVM cost money to execute so this |
| 117 | intrinsic cost is for the operations that need to be paid for as part of |
| 118 | the transaction. Data transfer, for example, is part of this intrinsic |
| 119 | cost. It costs ether to send data over the wire and that ether is |
| 120 | accounted for in the intrinsic cost calculated in this function. This |
| 121 | intrinsic cost must be calculated and paid for before execution in order |
| 122 | for all operations to be implemented. |
| 123 | |
| 124 | The intrinsic cost includes: |
| 125 | 1. Base cost (`TX_BASE`) |
| 126 | 2. Cost for data (zero and non-zero bytes) |
| 127 | 3. Cost for contract creation (if applicable) |
| 128 | |
| 129 | This function takes a transaction as a parameter and returns the intrinsic |
| 130 | gas cost of the transaction. |
| 131 | """ |
| 132 | from .vm.gas import GasCosts |
| 133 | |
| 134 | num_zeros = Uint(tx.data.count(0)) |
| 135 | num_non_zeros = ulen(tx.data) - num_zeros |
| 136 | data_cost = ( |
| 137 | num_zeros * GasCosts.TX_DATA_PER_ZERO |
| 138 | + num_non_zeros * GasCosts.TX_DATA_PER_NON_ZERO |
| 139 | ) |
| 140 | |
| 141 | if tx.to == Bytes0(b""): |
| 142 | create_cost = GasCosts.TX_CREATE |
| 143 | else: |
| 144 | create_cost = Uint(0) |
| 145 | |
| 146 | return GasCosts.TX_BASE + data_cost + create_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:
| 150 | """ |
|---|---|
| 151 | Extracts the sender address from a transaction. |
| 152 | |
| 153 | The v, r, and s values are the three parts that make up the signature |
| 154 | of a transaction. In order to recover the sender of a transaction the two |
| 155 | components needed are the signature (``v``, ``r``, and ``s``) and the |
| 156 | signing hash of the transaction. The sender's public key can be obtained |
| 157 | with these two values and therefore the sender address can be retrieved. |
| 158 | |
| 159 | This function takes chain_id and a transaction as parameters and returns |
| 160 | the address of the sender of the transaction. It raises an |
| 161 | `InvalidSignatureError` if the signature values (r, s, v) are invalid. |
| 162 | """ |
| 163 | v, r, s = tx.v, tx.r, tx.s |
| 164 | if U256(0) >= r or r >= SECP256K1N: |
| 165 | raise InvalidSignatureError("bad r") |
| 166 | if U256(0) >= s or s > SECP256K1N // U256(2): |
| 167 | raise InvalidSignatureError("bad s") |
| 168 | |
| 169 | if v == 27 or v == 28: |
| 170 | public_key = secp256k1_recover( |
| 171 | r, s, v - U256(27), signing_hash_pre155(tx) |
| 172 | ) |
| 173 | else: |
| 174 | chain_id_x2 = U256(chain_id) * U256(2) |
| 175 | if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2: |
| 176 | raise InvalidSignatureError("bad v") |
| 177 | public_key = secp256k1_recover( |
| 178 | r, s, v - U256(35) - chain_id_x2, signing_hash_155(tx, chain_id) |
| 179 | ) |
| 180 | |
| 181 | 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 transaction as a parameter and returns the signing hash of the transaction.
def signing_hash_pre155(tx: Transaction) -> Hash32:
| 185 | """ |
|---|---|
| 186 | Compute the hash of a transaction used in a legacy (pre [EIP-155]) |
| 187 | signature. |
| 188 | |
| 189 | This function takes a transaction as a parameter and returns the |
| 190 | signing hash of the transaction. |
| 191 | |
| 192 | [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 |
| 193 | """ |
| 194 | return keccak256( |
| 195 | rlp.encode( |
| 196 | ( |
| 197 | tx.nonce, |
| 198 | tx.gas_price, |
| 199 | tx.gas, |
| 200 | tx.to, |
| 201 | tx.value, |
| 202 | tx.data, |
| 203 | ) |
| 204 | ) |
| 205 | ) |
signing_hash_155 ¶
def signing_hash_155(tx: Transaction, chain_id: U64) -> Hash32:
| 209 | """ |
|---|---|
| 210 | Compute the hash of a transaction used in a [EIP-155] signature. |
| 211 | |
| 212 | This function takes a transaction and chain ID as parameters and returns |
| 213 | the hash of the transaction used in a [EIP-155] signature. |
| 214 | |
| 215 | [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 |
| 216 | """ |
| 217 | return keccak256( |
| 218 | rlp.encode( |
| 219 | ( |
| 220 | tx.nonce, |
| 221 | tx.gas_price, |
| 222 | tx.gas, |
| 223 | tx.to, |
| 224 | tx.value, |
| 225 | tx.data, |
| 226 | chain_id, |
| 227 | Uint(0), |
| 228 | Uint(0), |
| 229 | ) |
| 230 | ) |
| 231 | ) |
get_transaction_hash ¶
Compute the hash of a transaction.
This function takes a transaction as a parameter and returns the hash of the transaction.