ethereum.forks.constantinople.vm.gas

Ethereum Virtual Machine (EVM) Gas.

.. contents:: Table of Contents :backlinks: none :local:

Introduction

EVM gas constants and calculators.

GasCosts

Constant gas values for the EVM.

class GasCosts:

BASE

33
    BASE = Uint(2)

VERY_LOW

34
    VERY_LOW = Uint(3)

LOW

35
    LOW = Uint(5)

MID

36
    MID = Uint(8)

HIGH

37
    HIGH = Uint(10)

SLOAD

40
    SLOAD = Uint(200)

STORAGE_SET

43
    STORAGE_SET = Uint(20000)

COLD_STORAGE_WRITE

44
    COLD_STORAGE_WRITE = Uint(5000)

CALL_VALUE

47
    CALL_VALUE = Uint(9000)

CALL_STIPEND

48
    CALL_STIPEND = Uint(2300)

NEW_ACCOUNT

49
    NEW_ACCOUNT = Uint(25000)

CODE_DEPOSIT_PER_BYTE

52
    CODE_DEPOSIT_PER_BYTE = Uint(200)

ZERO

55
    ZERO = Uint(0)

MEMORY_PER_WORD

56
    MEMORY_PER_WORD = Uint(3)

REFUND_STORAGE_CLEAR

59
    REFUND_STORAGE_CLEAR = 15000

REFUND_SELF_DESTRUCT

60
    REFUND_SELF_DESTRUCT = 24000

PRECOMPILE_ECRECOVER

63
    PRECOMPILE_ECRECOVER = Uint(3000)

PRECOMPILE_SHA256_BASE

64
    PRECOMPILE_SHA256_BASE = Uint(60)

PRECOMPILE_SHA256_PER_WORD

65
    PRECOMPILE_SHA256_PER_WORD = Uint(12)

PRECOMPILE_RIPEMD160_BASE

66
    PRECOMPILE_RIPEMD160_BASE = Uint(600)

PRECOMPILE_RIPEMD160_PER_WORD

67
    PRECOMPILE_RIPEMD160_PER_WORD = Uint(120)

PRECOMPILE_IDENTITY_BASE

68
    PRECOMPILE_IDENTITY_BASE = Uint(15)

PRECOMPILE_IDENTITY_PER_WORD

69
    PRECOMPILE_IDENTITY_PER_WORD = Uint(3)

PRECOMPILE_ECADD

70
    PRECOMPILE_ECADD = Uint(500)

PRECOMPILE_ECMUL

71
    PRECOMPILE_ECMUL = Uint(40000)

PRECOMPILE_ECPAIRING_BASE

72
    PRECOMPILE_ECPAIRING_BASE = Uint(100000)

PRECOMPILE_ECPAIRING_PER_POINT

73
    PRECOMPILE_ECPAIRING_PER_POINT = Uint(80000)

TX_BASE

76
    TX_BASE = Uint(21000)

TX_CREATE

77
    TX_CREATE = Uint(32000)

TX_DATA_PER_ZERO

78
    TX_DATA_PER_ZERO = Uint(4)

TX_DATA_PER_NON_ZERO

79
    TX_DATA_PER_NON_ZERO = Uint(68)

LIMIT_ADJUSTMENT_FACTOR

82
    LIMIT_ADJUSTMENT_FACTOR = Uint(1024)

LIMIT_MINIMUM

83
    LIMIT_MINIMUM = Uint(5000)

OPCODE_ADD

86
    OPCODE_ADD = VERY_LOW

OPCODE_SUB

87
    OPCODE_SUB = VERY_LOW

OPCODE_MUL

88
    OPCODE_MUL = LOW

OPCODE_DIV

89
    OPCODE_DIV = LOW

OPCODE_SDIV

90
    OPCODE_SDIV = LOW

OPCODE_MOD

91
    OPCODE_MOD = LOW

OPCODE_SMOD

92
    OPCODE_SMOD = LOW

OPCODE_ADDMOD

93
    OPCODE_ADDMOD = MID

OPCODE_MULMOD

94
    OPCODE_MULMOD = MID

OPCODE_SIGNEXTEND

95
    OPCODE_SIGNEXTEND = LOW

OPCODE_LT

96
    OPCODE_LT = VERY_LOW

OPCODE_GT

97
    OPCODE_GT = VERY_LOW

OPCODE_SLT

98
    OPCODE_SLT = VERY_LOW

OPCODE_SGT

99
    OPCODE_SGT = VERY_LOW

OPCODE_EQ

100
    OPCODE_EQ = VERY_LOW

OPCODE_ISZERO

101
    OPCODE_ISZERO = VERY_LOW

OPCODE_AND

102
    OPCODE_AND = VERY_LOW

OPCODE_OR

103
    OPCODE_OR = VERY_LOW

OPCODE_XOR

104
    OPCODE_XOR = VERY_LOW

OPCODE_NOT

105
    OPCODE_NOT = VERY_LOW

OPCODE_BYTE

106
    OPCODE_BYTE = VERY_LOW

OPCODE_SHL

107
    OPCODE_SHL = VERY_LOW

OPCODE_SHR

108
    OPCODE_SHR = VERY_LOW

OPCODE_SAR

109
    OPCODE_SAR = VERY_LOW

OPCODE_JUMP

110
    OPCODE_JUMP = MID

OPCODE_JUMPI

111
    OPCODE_JUMPI = HIGH

OPCODE_JUMPDEST

112
    OPCODE_JUMPDEST = Uint(1)

OPCODE_CALLDATALOAD

113
    OPCODE_CALLDATALOAD = VERY_LOW

OPCODE_EXTCODEHASH

114
    OPCODE_EXTCODEHASH = Uint(400)

OPCODE_BLOCKHASH

115
    OPCODE_BLOCKHASH = Uint(20)

OPCODE_COINBASE

116
    OPCODE_COINBASE = BASE

OPCODE_POP

117
    OPCODE_POP = BASE

OPCODE_MSIZE

118
    OPCODE_MSIZE = BASE

OPCODE_PC

119
    OPCODE_PC = BASE

OPCODE_GAS

120
    OPCODE_GAS = BASE

OPCODE_ADDRESS

121
    OPCODE_ADDRESS = BASE

OPCODE_ORIGIN

122
    OPCODE_ORIGIN = BASE

OPCODE_CALLER

123
    OPCODE_CALLER = BASE

OPCODE_CALLVALUE

124
    OPCODE_CALLVALUE = BASE

OPCODE_CALLDATASIZE

125
    OPCODE_CALLDATASIZE = BASE

OPCODE_CODESIZE

126
    OPCODE_CODESIZE = BASE

OPCODE_GASPRICE

127
    OPCODE_GASPRICE = BASE

OPCODE_TIMESTAMP

128
    OPCODE_TIMESTAMP = BASE

OPCODE_NUMBER

129
    OPCODE_NUMBER = BASE

OPCODE_GASLIMIT

130
    OPCODE_GASLIMIT = BASE

OPCODE_DIFFICULTY

131
    OPCODE_DIFFICULTY = BASE

OPCODE_RETURNDATASIZE

132
    OPCODE_RETURNDATASIZE = BASE

OPCODE_PUSH

133
    OPCODE_PUSH = VERY_LOW

OPCODE_DUP

134
    OPCODE_DUP = VERY_LOW

OPCODE_SWAP

135
    OPCODE_SWAP = VERY_LOW

OPCODE_RETURNDATACOPY_BASE

138
    OPCODE_RETURNDATACOPY_BASE = VERY_LOW

OPCODE_RETURNDATACOPY_PER_WORD

139
    OPCODE_RETURNDATACOPY_PER_WORD = Uint(3)

OPCODE_CALLDATACOPY_BASE

140
    OPCODE_CALLDATACOPY_BASE = VERY_LOW

OPCODE_CODECOPY_BASE

141
    OPCODE_CODECOPY_BASE = VERY_LOW

OPCODE_MLOAD_BASE

142
    OPCODE_MLOAD_BASE = VERY_LOW

OPCODE_MSTORE_BASE

143
    OPCODE_MSTORE_BASE = VERY_LOW

OPCODE_MSTORE8_BASE

144
    OPCODE_MSTORE8_BASE = VERY_LOW

OPCODE_COPY_PER_WORD

145
    OPCODE_COPY_PER_WORD = Uint(3)

OPCODE_CREATE_BASE

146
    OPCODE_CREATE_BASE = Uint(32000)

OPCODE_EXP_BASE

147
    OPCODE_EXP_BASE = Uint(10)

OPCODE_EXP_PER_BYTE

148
    OPCODE_EXP_PER_BYTE = Uint(50)

OPCODE_KECCAK256_BASE

149
    OPCODE_KECCAK256_BASE = Uint(30)

OPCODE_KECCACK256_PER_WORD

150
    OPCODE_KECCACK256_PER_WORD = Uint(6)

OPCODE_LOG_BASE

151
    OPCODE_LOG_BASE = Uint(375)

OPCODE_LOG_DATA_PER_BYTE

152
    OPCODE_LOG_DATA_PER_BYTE = Uint(8)

OPCODE_LOG_TOPIC

153
    OPCODE_LOG_TOPIC = Uint(375)

OPCODE_SELFDESTRUCT_BASE

154
    OPCODE_SELFDESTRUCT_BASE = Uint(5000)

OPCODE_SELFDESTRUCT_NEW_ACCOUNT

155
    OPCODE_SELFDESTRUCT_NEW_ACCOUNT = Uint(25000)

OPCODE_EXTERNAL_BASE

156
    OPCODE_EXTERNAL_BASE = Uint(700)

OPCODE_BALANCE

157
    OPCODE_BALANCE = Uint(400)

OPCODE_CALL_BASE

158
    OPCODE_CALL_BASE = Uint(700)

ExtendMemory

Define the parameters for memory extension in opcodes.

cost: ethereum.base_types.Uint The gas required to perform the extension expand_by: ethereum.base_types.Uint The size by which the memory will be extended

161
@dataclass
class ExtendMemory:

cost

172
    cost: Uint

expand_by

173
    expand_by: Uint

MessageCallGas

Define the gas cost and gas given to the sub-call for executing the call opcodes.

cost: ethereum.base_types.Uint The gas required to execute the call opcode, excludes memory expansion costs. sub_call: ethereum.base_types.Uint The portion of gas available to sub-calls that is refundable if not consumed.

176
@dataclass
class MessageCallGas:

cost

190
    cost: Uint

sub_call

191
    sub_call: Uint

charge_gas

Subtracts amount from evm.gas_left.

Parameters

evm : The current EVM. amount : The amount of gas the current operation requires.

def charge_gas(evm: Evm, ​​amount: Uint) -> None:
195
    """
196
    Subtracts `amount` from `evm.gas_left`.
197
198
    Parameters
199
    ----------
200
    evm :
201
        The current EVM.
202
    amount :
203
        The amount of gas the current operation requires.
204
205
    """
206
    evm_trace(evm, GasAndRefund(int(amount)))
207
208
    if evm.gas_left < amount:
209
        raise OutOfGasError
210
    else:
211
        evm.gas_left -= amount

calculate_memory_gas_cost

Calculates the gas cost for allocating memory to the smallest multiple of 32 bytes, such that the allocated size is at least as big as the given size.

Parameters

size_in_bytes : The size of the data in bytes.

Returns

total_gas_cost : ethereum.base_types.Uint The gas cost for storing data in memory.

def calculate_memory_gas_cost(size_in_bytes: Uint) -> Uint:
215
    """
216
    Calculates the gas cost for allocating memory
217
    to the smallest multiple of 32 bytes,
218
    such that the allocated size is at least as big as the given size.
219
220
    Parameters
221
    ----------
222
    size_in_bytes :
223
        The size of the data in bytes.
224
225
    Returns
226
    -------
227
    total_gas_cost : `ethereum.base_types.Uint`
228
        The gas cost for storing data in memory.
229
230
    """
231
    size_in_words = ceil32(size_in_bytes) // Uint(32)
232
    linear_cost = size_in_words * GasCosts.MEMORY_PER_WORD
233
    quadratic_cost = size_in_words ** Uint(2) // Uint(512)
234
    total_gas_cost = linear_cost + quadratic_cost
235
    try:
236
        return total_gas_cost
237
    except ValueError as e:
238
        raise OutOfGasError from e

calculate_gas_extend_memory

Calculates the gas amount to extend memory.

Parameters

memory : Memory contents of the EVM. extensions: List of extensions to be made to the memory. Consists of a tuple of start position and size.

Returns

extend_memory: ExtendMemory

def calculate_gas_extend_memory(memory: bytearray, ​​extensions: List[Tuple[U256, U256]]) -> ExtendMemory:
244
    """
245
    Calculates the gas amount to extend memory.
246
247
    Parameters
248
    ----------
249
    memory :
250
        Memory contents of the EVM.
251
    extensions:
252
        List of extensions to be made to the memory.
253
        Consists of a tuple of start position and size.
254
255
    Returns
256
    -------
257
    extend_memory: `ExtendMemory`
258
259
    """
260
    size_to_extend = Uint(0)
261
    to_be_paid = Uint(0)
262
    current_size = ulen(memory)
263
    for start_position, size in extensions:
264
        if size == 0:
265
            continue
266
        before_size = ceil32(current_size)
267
        after_size = ceil32(Uint(start_position) + Uint(size))
268
        if after_size <= before_size:
269
            continue
270
271
        size_to_extend += after_size - before_size
272
        already_paid = calculate_memory_gas_cost(before_size)
273
        total_cost = calculate_memory_gas_cost(after_size)
274
        to_be_paid += total_cost - already_paid
275
276
        current_size = after_size
277
278
    return ExtendMemory(to_be_paid, size_to_extend)

calculate_message_call_gas

Calculates the MessageCallGas (cost and gas made available to the sub-call) for executing call Opcodes.

Parameters

value: The amount of ETH that needs to be transferred. gas : The amount of gas provided to the message-call. gas_left : The amount of gas left in the current frame. memory_cost : The amount needed to extend the memory in the current frame. extra_gas : The amount of gas needed for transferring value + creating a new account inside a message call. call_stipend : The amount of stipend provided to a message call to execute code while transferring value (ETH).

Returns

message_call_gas: MessageCallGas

def calculate_message_call_gas(value: U256, ​​gas: Uint, ​​gas_left: Uint, ​​memory_cost: Uint, ​​extra_gas: Uint, ​​call_stipend: Uint) -> MessageCallGas:
289
    """
290
    Calculates the MessageCallGas (cost and gas made available to the sub-call)
291
    for executing call Opcodes.
292
293
    Parameters
294
    ----------
295
    value:
296
        The amount of `ETH` that needs to be transferred.
297
    gas :
298
        The amount of gas provided to the message-call.
299
    gas_left :
300
        The amount of gas left in the current frame.
301
    memory_cost :
302
        The amount needed to extend the memory in the current frame.
303
    extra_gas :
304
        The amount of gas needed for transferring value + creating a new
305
        account inside a message call.
306
    call_stipend :
307
        The amount of stipend provided to a message call to execute code while
308
        transferring value (ETH).
309
310
    Returns
311
    -------
312
    message_call_gas: `MessageCallGas`
313
314
    """
315
    call_stipend = Uint(0) if value == 0 else call_stipend
316
    if gas_left < extra_gas + memory_cost:
317
        return MessageCallGas(gas + extra_gas, gas + call_stipend)
318
319
    gas = min(gas, max_message_call_gas(gas_left - memory_cost - extra_gas))
320
321
    return MessageCallGas(gas + extra_gas, gas + call_stipend)

max_message_call_gas

Calculates the maximum gas that is allowed for making a message call.

Parameters

gas : The amount of gas provided to the message-call.

Returns

max_allowed_message_call_gas: ethereum.base_types.Uint The maximum gas allowed for making the message-call.

def max_message_call_gas(gas: Uint) -> Uint:
325
    """
326
    Calculates the maximum gas that is allowed for making a message call.
327
328
    Parameters
329
    ----------
330
    gas :
331
        The amount of gas provided to the message-call.
332
333
    Returns
334
    -------
335
    max_allowed_message_call_gas: `ethereum.base_types.Uint`
336
        The maximum gas allowed for making the message-call.
337
338
    """
339
    return gas - (gas // Uint(64))