ethereum.forks.frontier.vm.interpreter
Ethereum Virtual Machine (EVM) Interpreter.
.. contents:: Table of Contents :backlinks: none :local:
Introduction
A straightforward interpreter that executes EVM code.
STACK_DEPTH_LIMIT¶
| 57 | STACK_DEPTH_LIMIT = Uint(1024) |
|---|
MessageCallOutput ¶
Output of a particular message call.
Contains the following:
1. `gas_left`: remaining gas after execution.
2. `refund_counter`: gas to refund after execution.
3. `logs`: list of `Log` generated during execution.
4. `accounts_to_delete`: Contracts which have self-destructed.
5. `error`: The error from the execution if any.
| 60 | @dataclass |
|---|
class MessageCallOutput:
gas_left¶
| 74 | gas_left: Uint |
|---|
refund_counter¶
| 75 | refund_counter: U256 |
|---|
logs¶
| 76 | logs: Tuple[Log, ...] |
|---|
accounts_to_delete¶
| 77 | accounts_to_delete: Set[Address] |
|---|
error¶
| 78 | error: Optional[EthereumException] |
|---|
process_message_call ¶
If message.target is empty then it creates a smart contract
else it executes a call from the message.caller to the message.target.
Parameters
message : Transaction specific items.
Returns
output : MessageCallOutput
Output of the message call
def process_message_call(message: Message) -> MessageCallOutput:
| 82 | """ |
|---|---|
| 83 | If `message.target` is empty then it creates a smart contract |
| 84 | else it executes a call from the `message.caller` to the `message.target`. |
| 85 | |
| 86 | Parameters |
| 87 | ---------- |
| 88 | message : |
| 89 | Transaction specific items. |
| 90 | |
| 91 | Returns |
| 92 | ------- |
| 93 | output : `MessageCallOutput` |
| 94 | Output of the message call |
| 95 | |
| 96 | """ |
| 97 | tx_state = message.tx_env.state |
| 98 | refund_counter = U256(0) |
| 99 | if message.target == Bytes0(b""): |
| 100 | is_collision = account_has_code_or_nonce( |
| 101 | tx_state, message.current_target |
| 102 | ) or account_has_storage(tx_state, message.current_target) |
| 103 | if is_collision: |
| 104 | return MessageCallOutput( |
| 105 | gas_left=Uint(0), |
| 106 | refund_counter=U256(0), |
| 107 | logs=tuple(), |
| 108 | accounts_to_delete=set(), |
| 109 | error=AddressCollision(), |
| 110 | ) |
| 111 | else: |
| 112 | evm = process_create_message(message) |
| 113 | else: |
| 114 | evm = process_message(message) |
| 115 | |
| 116 | if evm.error: |
| 117 | logs: Tuple[Log, ...] = () |
| 118 | accounts_to_delete = set() |
| 119 | else: |
| 120 | logs = evm.logs |
| 121 | accounts_to_delete = evm.accounts_to_delete |
| 122 | refund_counter += U256(evm.refund_counter) |
| 123 | |
| 124 | tx_end = TransactionEnd( |
| 125 | int(message.gas) - int(evm.gas_left), evm.output, evm.error |
| 126 | ) |
| 127 | evm_trace(evm, tx_end) |
| 128 | |
| 129 | return MessageCallOutput( |
| 130 | gas_left=evm.gas_left, |
| 131 | refund_counter=refund_counter, |
| 132 | logs=logs, |
| 133 | accounts_to_delete=accounts_to_delete, |
| 134 | error=evm.error, |
| 135 | ) |
process_create_message ¶
Executes a call to create a smart contract.
Parameters
message : Transaction specific items.
Returns
evm: :py:class:~ethereum.forks.frontier.vm.Evm
Items containing execution specific objects.
def process_create_message(message: Message) -> Evm:
| 139 | """ |
|---|---|
| 140 | Executes a call to create a smart contract. |
| 141 | |
| 142 | Parameters |
| 143 | ---------- |
| 144 | message : |
| 145 | Transaction specific items. |
| 146 | |
| 147 | Returns |
| 148 | ------- |
| 149 | evm: :py:class:`~ethereum.forks.frontier.vm.Evm` |
| 150 | Items containing execution specific objects. |
| 151 | |
| 152 | """ |
| 153 | tx_state = message.tx_env.state |
| 154 | # take snapshot of state before processing the message |
| 155 | snapshot = copy_tx_state(tx_state) |
| 156 | |
| 157 | # If the address where the account is being created has storage, it is |
| 158 | # destroyed. This can only happen in the following highly unlikely |
| 159 | # circumstances: |
| 160 | # * The address created by a `CREATE` call collides with a subsequent |
| 161 | # `CREATE` call. |
| 162 | destroy_storage(tx_state, message.current_target) |
| 163 | |
| 164 | evm = process_message(message) |
| 165 | if not evm.error: |
| 166 | contract_code = evm.output |
| 167 | contract_code_gas = ( |
| 168 | ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE |
| 169 | ) |
| 170 | try: |
| 171 | charge_gas(evm, contract_code_gas) |
| 172 | except ExceptionalHalt: |
| 173 | evm.output = b"" |
| 174 | else: |
| 175 | set_code(tx_state, message.current_target, contract_code) |
| 176 | else: |
| 177 | restore_tx_state(tx_state, snapshot) |
| 178 | return evm |
process_message ¶
Move ether and execute the relevant code.
Parameters
message : Transaction specific items.
Returns
evm: :py:class:~ethereum.forks.frontier.vm.Evm
Items containing execution specific objects
def process_message(message: Message) -> Evm:
| 182 | """ |
|---|---|
| 183 | Move ether and execute the relevant code. |
| 184 | |
| 185 | Parameters |
| 186 | ---------- |
| 187 | message : |
| 188 | Transaction specific items. |
| 189 | |
| 190 | Returns |
| 191 | ------- |
| 192 | evm: :py:class:`~ethereum.forks.frontier.vm.Evm` |
| 193 | Items containing execution specific objects |
| 194 | |
| 195 | """ |
| 196 | tx_state = message.tx_env.state |
| 197 | if message.depth > STACK_DEPTH_LIMIT: |
| 198 | raise StackDepthLimitError("Stack depth limit reached") |
| 199 | |
| 200 | code = message.code |
| 201 | valid_jump_destinations = get_valid_jump_destinations(code) |
| 202 | evm = Evm( |
| 203 | pc=Uint(0), |
| 204 | stack=[], |
| 205 | memory=bytearray(), |
| 206 | code=code, |
| 207 | gas_left=message.gas, |
| 208 | valid_jump_destinations=valid_jump_destinations, |
| 209 | logs=(), |
| 210 | refund_counter=0, |
| 211 | running=True, |
| 212 | message=message, |
| 213 | output=b"", |
| 214 | accounts_to_delete=set(), |
| 215 | error=None, |
| 216 | ) |
| 217 | |
| 218 | # take snapshot of state before processing the message |
| 219 | snapshot = copy_tx_state(tx_state) |
| 220 | |
| 221 | touch_account(tx_state, message.current_target) |
| 222 | |
| 223 | if message.value != 0: |
| 224 | move_ether( |
| 225 | tx_state, |
| 226 | message.caller, |
| 227 | message.current_target, |
| 228 | message.value, |
| 229 | ) |
| 230 | |
| 231 | try: |
| 232 | if evm.message.code_address in PRE_COMPILED_CONTRACTS: |
| 233 | evm_trace(evm, PrecompileStart(evm.message.code_address)) |
| 234 | PRE_COMPILED_CONTRACTS[evm.message.code_address](evm) |
| 235 | evm_trace(evm, PrecompileEnd()) |
| 236 | else: |
| 237 | while evm.running and evm.pc < ulen(evm.code): |
| 238 | try: |
| 239 | op = Ops(evm.code[evm.pc]) |
| 240 | except ValueError as e: |
| 241 | raise InvalidOpcode(evm.code[evm.pc]) from e |
| 242 | |
| 243 | evm_trace(evm, OpStart(op)) |
| 244 | op_implementation[op](evm) |
| 245 | evm_trace(evm, OpEnd()) |
| 246 | |
| 247 | evm_trace(evm, EvmStop(Ops.STOP)) |
| 248 | |
| 249 | except ExceptionalHalt as error: |
| 250 | evm_trace(evm, OpException(error)) |
| 251 | evm.gas_left = Uint(0) |
| 252 | evm.error = error |
| 253 | |
| 254 | if evm.error: |
| 255 | restore_tx_state(tx_state, snapshot) |
| 256 | return evm |