Opcodes#

Opcodes are the instructions that the EVM can execute. There are different categories of opcodes. Some of them are arithmetic or logic operations. Others deal with memory, storage and the stack.

Implementation#

In the following notebooks we will implement most of these opcodes. All opcodes have one thing in common. They manipulate the current state of the EVM. That is why we will create a function for each of them, that takes an EVM instance as parameter.

Every opcode function will be structured like this.

def opcode(evm):
    # manipulate the evm
    # ...

Each opcode has a unique identifier. A number that represents that opcode. Because all opcodes are not larger than 1 byte it is very convenient to denote them in hexadecimal.

To make it easier for us to deal with opcodes we give them a short descriptive name. All opcodes can be found here.

STOP = 0x0

Math#

ADD        = 0x1
MUL        = 0x2
SUB        = 0x3
DIV        = 0x4
SDIV       = 0x5
MOD        = 0x6
SMOD       = 0x7
ADDMOD     = 0x8
MULMOD     = 0x9
EXP        = 0xA
SIGNEXTEND = 0xB

Comparisons#

LT     = 0x10
GT     = 0x11
SLT    = 0x12
SGT    = 0x13
EQ     = 0x14
ISZERO = 0x15

Logic#

AND = 0x16
OR  = 0x17
XOR = 0x18
NOT = 0x19

Bit Ops#

BYTE = 0x1A
SHL  = 0x1B
SHR  = 0x1C
SAR  = 0x1D

Misc#

SHA3 = 0x20

Ethereum State#

ADDRESS        = 0x30
BALANCE        = 0x31
ORIGIN         = 0x32
CALLER         = 0x33
CALLVALUE      = 0x34
CALLDATALOAD   = 0x35
CALLDATASIZE   = 0x36
CALLDATACOPY   = 0x37
CODESIZE       = 0x38
CODECOPY       = 0x39
GASPRICE       = 0x3A
EXTCODESIZE    = 0x3B
EXTCODECOPY    = 0x3C
RETURNDATASIZE = 0x3D
RETURNDATACOPY = 0x3E
EXTCODEHASH    = 0x3F
BLOCKHASH      = 0x40
COINBASE       = 0x41
TIMESTAMP      = 0x42
NUMBER         = 0x43
DIFFICULTY     = 0x44
GASLIMIT       = 0x45
CHAINID        = 0x46
SELFBALANCE    = 0x47
BASEFEE        = 0x48

Pop#

POP = 0x50

Memory#

MLOAD   = 0x51
MSTORE  = 0x52
MSTORE8 = 0x53

Storage#

SLOAD  = 0x54
SSTORE = 0x55

Jump#

JUMP     = 0x56
JUMPI    = 0x57
PC       = 0x58
JUMPDEST = 0x5B

Transient Storage#

TLOAD  = 0x5c
TSTORE = 0x5d

Push#

PUSH1  = 0x60
PUSH2  = 0x61
PUSH3  = 0x62
PUSH4  = 0x63
PUSH5  = 0x64
PUSH6  = 0x65
PUSH7  = 0x66
PUSH8  = 0x67
PUSH9  = 0x68
PUSH10 = 0x69
PUSH11 = 0x6A
PUSH12 = 0x6B
PUSH13 = 0x6C
PUSH14 = 0x6D
PUSH15 = 0x6E
PUSH16 = 0x6F
PUSH17 = 0x70
PUSH18 = 0x71
PUSH19 = 0x72
PUSH20 = 0x73
PUSH21 = 0x74
PUSH22 = 0x75
PUSH23 = 0x76
PUSH24 = 0x77
PUSH25 = 0x78
PUSH26 = 0x79
PUSH27 = 0x7A
PUSH28 = 0x7B
PUSH29 = 0x7C
PUSH30 = 0x7D
PUSH31 = 0x7E
PUSH32 = 0x7F

Dup#

DUP1  = 0x80
DUP2  = 0x81
DUP3  = 0x82
DUP4  = 0x83
DUP5  = 0x84
DUP6  = 0x85
DUP7  = 0x86
DUP8  = 0x87
DUP9  = 0x88
DUP10 = 0x89
DUP11 = 0x8A
DUP12 = 0x8B
DUP13 = 0x8C
DUP14 = 0x8D
DUP15 = 0x8E
DUP16 = 0x8F

Swap#

SWAP1  = 0x90
SWAP2  = 0x91
SWAP3  = 0x92
SWAP4  = 0x93
SWAP5  = 0x94
SWAP6  = 0x95
SWAP7  = 0x96
SWAP8  = 0x97
SWAP9  = 0x98
SWAP10 = 0x99
SWAP11 = 0x9A
SWAP12 = 0x9B
SWAP13 = 0x9C
SWAP14 = 0x9D
SWAP15 = 0x9E
SWAP16 = 0x9F

Log#

LOG0 = 0xA0
LOG1 = 0xA1
LOG2 = 0xA2
LOG3 = 0xA3
LOG4 = 0xA4

Contract#

CREATE       = 0xF0
CALL         = 0xF1
CALLCODE     = 0xF2 # legacy NOT supported by us, fixed by DELEGATECALL
RETURN       = 0xF3
DELEGATECALL = 0xF4
CREATE2      = 0xF5
STATICCALL   = 0xFA
REVERT       = 0xFD
INVALID      = 0xFE
SELFDESTRUCT = 0xFF

Implementation#

Each opcode has a unique identifier. A number that represents that opcode. Because all opcodes are not larger than 1 byte it is very convenient to denote them in hexadecimal.

To make it easier for us to deal with opcodes we give them a short descriptive name. All opcodes can be found here.

STOP = 0x0

Math#

ADD        = 0x1
MUL        = 0x2
SUB        = 0x3
DIV        = 0x4
SDIV       = 0x5
MOD        = 0x6
SMOD       = 0x7
ADDMOD     = 0x8
MULMOD     = 0x9
EXP        = 0xA
SIGNEXTEND = 0xB

Comparisons#

LT     = 0x10
GT     = 0x11
SLT    = 0x12
SGT    = 0x13
EQ     = 0x14
ISZERO = 0x15

Logic#

AND = 0x16
OR  = 0x17
XOR = 0x18
NOT = 0x19

Bit Ops#

BYTE = 0x1A
SHL  = 0x1B
SHR  = 0x1C
SAR  = 0x1D

Misc#

SHA3 = 0x20

Ethereum State#

ADDRESS        = 0x30
BALANCE        = 0x31
ORIGIN         = 0x32
CALLER         = 0x33
CALLVALUE      = 0x34
CALLDATALOAD   = 0x35
CALLDATASIZE   = 0x36
CALLDATACOPY   = 0x37
CODESIZE       = 0x38
CODECOPY       = 0x39
GASPRICE       = 0x3A
EXTCODESIZE    = 0x3B
EXTCODECOPY    = 0x3C
RETURNDATASIZE = 0x3D
RETURNDATACOPY = 0x3E
EXTCODEHASH    = 0x3F
BLOCKHASH      = 0x40
COINBASE       = 0x41
TIMESTAMP      = 0x42
NUMBER         = 0x43
DIFFICULTY     = 0x44
GASLIMIT       = 0x45
CHAINID        = 0x46
SELFBALANCE    = 0x47
BASEFEE        = 0x48

Pop#

POP = 0x50

Memory#

MLOAD   = 0x51
MSTORE  = 0x52
MSTORE8 = 0x53

Storage#

SLOAD  = 0x54
SSTORE = 0x55

Jump#

JUMP     = 0x56
JUMPI    = 0x57
PC       = 0x58
JUMPDEST = 0x5B

Push#

PUSH1  = 0x60
PUSH2  = 0x61
PUSH3  = 0x62
PUSH4  = 0x63
PUSH5  = 0x64
PUSH6  = 0x65
PUSH7  = 0x66
PUSH8  = 0x67
PUSH9  = 0x68
PUSH10 = 0x69
PUSH11 = 0x6A
PUSH12 = 0x6B
PUSH13 = 0x6C
PUSH14 = 0x6D
PUSH15 = 0x6E
PUSH16 = 0x6F
PUSH17 = 0x70
PUSH18 = 0x71
PUSH19 = 0x72
PUSH20 = 0x73
PUSH21 = 0x74
PUSH22 = 0x75
PUSH23 = 0x76
PUSH24 = 0x77
PUSH25 = 0x78
PUSH26 = 0x79
PUSH27 = 0x7A
PUSH28 = 0x7B
PUSH29 = 0x7C
PUSH30 = 0x7D
PUSH31 = 0x7E
PUSH32 = 0x7F

Dup#

DUP1  = 0x80
DUP2  = 0x81
DUP3  = 0x82
DUP4  = 0x83
DUP5  = 0x84
DUP6  = 0x85
DUP7  = 0x86
DUP8  = 0x87
DUP9  = 0x88
DUP10 = 0x89
DUP11 = 0x8A
DUP12 = 0x8B
DUP13 = 0x8C
DUP14 = 0x8D
DUP15 = 0x8E
DUP16 = 0x8F

Swap#

SWAP1  = 0x90
SWAP2  = 0x91
SWAP3  = 0x92
SWAP4  = 0x93
SWAP5  = 0x94
SWAP6  = 0x95
SWAP7  = 0x96
SWAP8  = 0x97
SWAP9  = 0x98
SWAP10 = 0x99
SWAP11 = 0x9A
SWAP12 = 0x9B
SWAP13 = 0x9C
SWAP14 = 0x9D
SWAP15 = 0x9E
SWAP16 = 0x9F

Log#

LOG0 = 0xA0
LOG1 = 0xA1
LOG2 = 0xA2
LOG3 = 0xA3
LOG4 = 0xA4

Contract#

CREATE       = 0xF0
CALL         = 0xF1
CALLCODE     = 0xF2 # legacy NOT supported by us, fixed by DELEGATECALL
RETURN       = 0xF3
DELEGATECALL = 0xF4
CREATE2      = 0xF5
STATICCALL   = 0xFA
REVERT       = 0xFD
INVALID      = 0xFE
SELFDESTRUCT = 0xFF