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.

19
TX_BASE_COST = Uint(21000)

TX_DATA_COST_PER_NON_ZERO

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

25
TX_DATA_COST_PER_NON_ZERO = Uint(68)

TX_DATA_COST_PER_ZERO

Gas cost per zero byte in the transaction data.

30
TX_DATA_COST_PER_ZERO = Uint(4)

Transaction

Atomic operation performed on the block chain.

36
@slotted_freezable
37
@dataclass
class Transaction:

nonce

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

43
    nonce: U256

gas_price

The price of gas for this transaction, in wei.

48
    gas_price: Uint

gas

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

53
    gas: Uint

to

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

58
    to: Bytes0 | Address

value

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

64
    value: U256

data

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

69
    data: Bytes

v

The recovery id of the signature.

75
    v: U256

r

The first part of the signature.

80
    r: U256

s

The second part of the signature.

85
    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 InvalidTransaction exception if the transaction is invalid.

def validate_transaction(tx: Transaction) -> Uint:
92
    """
93
    Verifies a transaction.
94
95
    The gas in a transaction gets used to pay for the intrinsic cost of
96
    operations, therefore if there is insufficient gas then it would not
97
    be possible to execute a transaction and it will be declared invalid.
98
99
    Additionally, the nonce of a transaction must not equal or exceed the
100
    limit defined in [EIP-2681], applied retroactively.
101
    In practice, defining the limit as ``2**64-1`` has no impact because
102
    sending ``2**64-1`` transactions is improbable. It's not strictly
103
    impossible though, ``2**64-1`` transactions is the entire capacity of the
104
    Ethereum blockchain at 2022 gas limits for a little over 22 years.
105
106
    This function takes a transaction as a parameter and returns the intrinsic
107
    gas cost of the transaction after validation. It throws an
108
    `InvalidTransaction` exception if the transaction is invalid.
109
110
    [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681
111
    """
112
    intrinsic_gas = calculate_intrinsic_cost(tx)
113
    if intrinsic_gas > tx.gas:
114
        raise InvalidTransaction("Insufficient gas")
115
    if U256(tx.nonce) >= U256(U64.MAX_VALUE):
116
        raise InvalidTransaction("Nonce too high")
117
    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:
121
    """
122
    Calculates the gas that is charged before execution is started.
123
124
    The intrinsic cost of the transaction is charged before execution has
125
    begun. Functions/operations in the EVM cost money to execute so this
126
    intrinsic cost is for the operations that need to be paid for as part of
127
    the transaction. Data transfer, for example, is part of this intrinsic
128
    cost. It costs ether to send data over the wire and that ether is
129
    accounted for in the intrinsic cost calculated in this function. This
130
    intrinsic cost must be calculated and paid for before execution in order
131
    for all operations to be implemented.
132
133
    The intrinsic cost includes:
134
    1. Base cost (`TX_BASE_COST`)
135
    2. Cost for data (zero and non-zero bytes)
136
137
    This function takes a transaction as a parameter and returns the intrinsic
138
    gas cost of the transaction.
139
    """
140
    data_cost = Uint(0)
141
142
    for byte in tx.data:
143
        if byte == 0:
144
            data_cost += TX_DATA_COST_PER_ZERO
145
        else:
146
            data_cost += TX_DATA_COST_PER_NON_ZERO
147
148
    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:
152
    """
153
    Extracts the sender address from a transaction.
154
155
    The v, r, and s values are the three parts that make up the signature
156
    of a transaction. In order to recover the sender of a transaction the two
157
    components needed are the signature (``v``, ``r``, and ``s``) and the
158
    signing hash of the transaction. The sender's public key can be obtained
159
    with these two values and therefore the sender address can be retrieved.
160
161
    This function takes a transaction as a parameter and returns
162
    the address of the sender of the transaction. It raises an
163
    `InvalidSignatureError` if the signature values (r, s, v) are invalid.
164
    """
165
    v, r, s = tx.v, tx.r, tx.s
166
    if v != 27 and v != 28:
167
        raise InvalidSignatureError("bad v")
168
    if U256(0) >= r or r >= SECP256K1N:
169
        raise InvalidSignatureError("bad r")
170
    if U256(0) >= s or s >= SECP256K1N:
171
        raise InvalidSignatureError("bad s")
172
173
    public_key = secp256k1_recover(r, s, v - U256(27), signing_hash(tx))
174
    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:
178
    """
179
    Compute the hash of a transaction used in the signature.
180
181
    The values that are used to compute the signing hash set the rules for a
182
    transaction. For example, signing over the gas sets a limit for the
183
    amount of money that is allowed to be pulled out of the sender's account.
184
185
    This function takes a transaction as a parameter and returns the
186
    signing hash of the transaction.
187
    """
188
    return keccak256(
189
        rlp.encode(
190
            (
191
                tx.nonce,
192
                tx.gas_price,
193
                tx.gas,
194
                tx.to,
195
                tx.value,
196
                tx.data,
197
            )
198
        )
199
    )

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:
203
    """
204
    Compute the hash of a transaction.
205
206
    This function takes a transaction as a parameter and returns the
207
    hash of the transaction.
208
    """
209
    return keccak256(rlp.encode(tx))