ethereum.frontier.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.

TX_BASE_COST

Base cost of a transaction in gas units. This is the minimum amount of gas required to execute a transaction.

23
TX_BASE_COST = Uint(21000)

TX_DATA_COST_PER_NON_ZERO

Gas cost per non-zero byte in the transaction data.

29
TX_DATA_COST_PER_NON_ZERO = Uint(68)

TX_DATA_COST_PER_ZERO

Gas cost per zero byte in the transaction data.

34
TX_DATA_COST_PER_ZERO = Uint(4)

Transaction

Atomic operation performed on the block chain.

40
@slotted_freezable
41
@dataclass
class Transaction:

nonce

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

47
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

52
    gas_price: Uint

gas

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

57
    gas: Uint

to

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

62
    to: Bytes0 | Address

value

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

68
    value: U256

data

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

73
    data: Bytes

v

The recovery id of the signature.

79
    v: U256

r

The first part of the signature.

84
    r: U256

s

The second part of the signature.

89
    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, applied retroactively. 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:
96
    """
97
    Verifies a transaction.
98
99
    The gas in a transaction gets used to pay for the intrinsic cost of
100
    operations, therefore if there is insufficient gas then it would not
101
    be possible to execute a transaction and it will be declared invalid.
102
103
    Additionally, the nonce of a transaction must not equal or exceed the
104
    limit defined in [EIP-2681], applied retroactively.
105
    In practice, defining the limit as ``2**64-1`` has no impact because
106
    sending ``2**64-1`` transactions is improbable. It's not strictly
107
    impossible though, ``2**64-1`` transactions is the entire capacity of the
108
    Ethereum blockchain at 2022 gas limits for a little over 22 years.
109
110
    This function takes a transaction as a parameter and returns the intrinsic
111
    gas cost of the transaction after validation. It throws an
112
    `InsufficientTransactionGasError` exception if the transaction does not
113
    provide enough gas to cover the intrinsic cost, and a `NonceOverflowError`
114
    exception if the nonce is greater than `2**64 - 2`.
115
116
    [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681
117
    """
118
    intrinsic_gas = calculate_intrinsic_cost(tx)
119
    if intrinsic_gas > tx.gas:
120
        raise InsufficientTransactionGasError("Insufficient gas")
121
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
122
        raise NonceOverflowError("Nonce too high")
123
    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:

  1. Base cost (TX_BASE_COST)

  2. Cost for data (zero and non-zero bytes)

This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction.

def calculate_intrinsic_cost(tx: Transaction) -> Uint:
127
    """
128
    Calculates the gas that is charged before execution is started.
129
130
    The intrinsic cost of the transaction is charged before execution has
131
    begun. Functions/operations in the EVM cost money to execute so this
132
    intrinsic cost is for the operations that need to be paid for as part of
133
    the transaction. Data transfer, for example, is part of this intrinsic
134
    cost. It costs ether to send data over the wire and that ether is
135
    accounted for in the intrinsic cost calculated in this function. This
136
    intrinsic cost must be calculated and paid for before execution in order
137
    for all operations to be implemented.
138
139
    The intrinsic cost includes:
140
    1. Base cost (`TX_BASE_COST`)
141
    2. Cost for data (zero and non-zero bytes)
142
143
    This function takes a transaction as a parameter and returns the intrinsic
144
    gas cost of the transaction.
145
    """
146
    data_cost = Uint(0)
147
148
    for byte in tx.data:
149
        if byte == 0:
150
            data_cost += TX_DATA_COST_PER_ZERO
151
        else:
152
            data_cost += TX_DATA_COST_PER_NON_ZERO
153
154
    return TX_BASE_COST + data_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 a transaction as a parameter 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:
158
    """
159
    Extracts the sender address from a transaction.
160
161
    The v, r, and s values are the three parts that make up the signature
162
    of a transaction. In order to recover the sender of a transaction the two
163
    components needed are the signature (``v``, ``r``, and ``s``) and the
164
    signing hash of the transaction. The sender's public key can be obtained
165
    with these two values and therefore the sender address can be retrieved.
166
167
    This function takes a transaction as a parameter and returns
168
    the address of the sender of the transaction. It raises an
169
    `InvalidSignatureError` if the signature values (r, s, v) are invalid.
170
    """
171
    v, r, s = tx.v, tx.r, tx.s
172
    if v != 27 and v != 28:
173
        raise InvalidSignatureError("bad v")
174
    if U256(0) >= r or r >= SECP256K1N:
175
        raise InvalidSignatureError("bad r")
176
    if U256(0) >= s or s >= SECP256K1N:
177
        raise InvalidSignatureError("bad s")
178
179
    public_key = secp256k1_recover(r, s, v - U256(27), signing_hash(tx))
180
    return Address(keccak256(public_key)[12:32])

signing_hash

Compute the hash of a transaction used in the signature.

The values that are used to compute the signing hash set the rules for a transaction. For example, signing over the gas sets a limit for the amount of money that is allowed to be pulled out of the sender's account.

This function takes a transaction as a parameter and returns the signing hash of the transaction.

def signing_hash(tx: Transaction) -> Hash32:
184
    """
185
    Compute the hash of a transaction used in the signature.
186
187
    The values that are used to compute the signing hash set the rules for a
188
    transaction. For example, signing over the gas sets a limit for the
189
    amount of money that is allowed to be pulled out of the sender's account.
190
191
    This function takes a transaction as a parameter and returns the
192
    signing hash of the transaction.
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
    )

get_transaction_hash

Compute the hash of a transaction.

This function takes a transaction as a parameter and returns the hash of the transaction.

def get_transaction_hash(tx: Transaction) -> Hash32:
209
    """
210
    Compute the hash of a transaction.
211
212
    This function takes a transaction as a parameter and returns the
213
    hash of the transaction.
214
    """
215
    return keccak256(rlp.encode(tx))