evm_interpreter/
opcode.rs

1/// Opcode enum. One-to-one corresponding to an `u8` value.
2#[derive(Clone, Copy, Debug, Eq, PartialEq)]
3#[cfg_attr(
4	feature = "scale",
5	derive(scale_codec::Encode, scale_codec::Decode, scale_info::TypeInfo)
6)]
7#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
8pub struct Opcode(pub u8);
9
10// Core opcodes.
11impl Opcode {
12	/// `STOP`
13	pub const STOP: Opcode = Opcode(0x00);
14	/// `ADD`
15	pub const ADD: Opcode = Opcode(0x01);
16	/// `MUL`
17	pub const MUL: Opcode = Opcode(0x02);
18	/// `SUB`
19	pub const SUB: Opcode = Opcode(0x03);
20	/// `DIV`
21	pub const DIV: Opcode = Opcode(0x04);
22	/// `SDIV`
23	pub const SDIV: Opcode = Opcode(0x05);
24	/// `MOD`
25	pub const MOD: Opcode = Opcode(0x06);
26	/// `SMOD`
27	pub const SMOD: Opcode = Opcode(0x07);
28	/// `ADDMOD`
29	pub const ADDMOD: Opcode = Opcode(0x08);
30	/// `MULMOD`
31	pub const MULMOD: Opcode = Opcode(0x09);
32	/// `EXP`
33	pub const EXP: Opcode = Opcode(0x0a);
34	/// `SIGNEXTEND`
35	pub const SIGNEXTEND: Opcode = Opcode(0x0b);
36
37	/// `LT`
38	pub const LT: Opcode = Opcode(0x10);
39	/// `GT`
40	pub const GT: Opcode = Opcode(0x11);
41	/// `SLT`
42	pub const SLT: Opcode = Opcode(0x12);
43	/// `SGT`
44	pub const SGT: Opcode = Opcode(0x13);
45	/// `EQ`
46	pub const EQ: Opcode = Opcode(0x14);
47	/// `ISZERO`
48	pub const ISZERO: Opcode = Opcode(0x15);
49	/// `AND`
50	pub const AND: Opcode = Opcode(0x16);
51	/// `OR`
52	pub const OR: Opcode = Opcode(0x17);
53	/// `XOR`
54	pub const XOR: Opcode = Opcode(0x18);
55	/// `NOT`
56	pub const NOT: Opcode = Opcode(0x19);
57	/// `BYTE`
58	pub const BYTE: Opcode = Opcode(0x1a);
59
60	/// `SHL`
61	pub const SHL: Opcode = Opcode(0x1b);
62	/// `SHR`
63	pub const SHR: Opcode = Opcode(0x1c);
64	/// `SAR`
65	pub const SAR: Opcode = Opcode(0x1d);
66
67	/// `CALLDATALOAD`
68	pub const CALLDATALOAD: Opcode = Opcode(0x35);
69	/// `CALLDATASIZE`
70	pub const CALLDATASIZE: Opcode = Opcode(0x36);
71	/// `CALLDATACOPY`
72	pub const CALLDATACOPY: Opcode = Opcode(0x37);
73	/// `CODESIZE`
74	pub const CODESIZE: Opcode = Opcode(0x38);
75	/// `CODECOPY`
76	pub const CODECOPY: Opcode = Opcode(0x39);
77
78	/// `POP`
79	pub const POP: Opcode = Opcode(0x50);
80	/// `MLOAD`
81	pub const MLOAD: Opcode = Opcode(0x51);
82	/// `MSTORE`
83	pub const MSTORE: Opcode = Opcode(0x52);
84	/// `MSTORE8`
85	pub const MSTORE8: Opcode = Opcode(0x53);
86
87	/// `JUMP`
88	pub const JUMP: Opcode = Opcode(0x56);
89	/// `JUMPI`
90	pub const JUMPI: Opcode = Opcode(0x57);
91	/// `PC`
92	pub const PC: Opcode = Opcode(0x58);
93	/// `MSIZE`
94	pub const MSIZE: Opcode = Opcode(0x59);
95
96	/// `JUMPDEST`
97	pub const JUMPDEST: Opcode = Opcode(0x5b);
98	/// `MCOPY`
99	pub const MCOPY: Opcode = Opcode(0x5e);
100
101	/// `PUSHn`
102	pub const PUSH0: Opcode = Opcode(0x5f);
103	pub const PUSH1: Opcode = Opcode(0x60);
104	pub const PUSH2: Opcode = Opcode(0x61);
105	pub const PUSH3: Opcode = Opcode(0x62);
106	pub const PUSH4: Opcode = Opcode(0x63);
107	pub const PUSH5: Opcode = Opcode(0x64);
108	pub const PUSH6: Opcode = Opcode(0x65);
109	pub const PUSH7: Opcode = Opcode(0x66);
110	pub const PUSH8: Opcode = Opcode(0x67);
111	pub const PUSH9: Opcode = Opcode(0x68);
112	pub const PUSH10: Opcode = Opcode(0x69);
113	pub const PUSH11: Opcode = Opcode(0x6a);
114	pub const PUSH12: Opcode = Opcode(0x6b);
115	pub const PUSH13: Opcode = Opcode(0x6c);
116	pub const PUSH14: Opcode = Opcode(0x6d);
117	pub const PUSH15: Opcode = Opcode(0x6e);
118	pub const PUSH16: Opcode = Opcode(0x6f);
119	pub const PUSH17: Opcode = Opcode(0x70);
120	pub const PUSH18: Opcode = Opcode(0x71);
121	pub const PUSH19: Opcode = Opcode(0x72);
122	pub const PUSH20: Opcode = Opcode(0x73);
123	pub const PUSH21: Opcode = Opcode(0x74);
124	pub const PUSH22: Opcode = Opcode(0x75);
125	pub const PUSH23: Opcode = Opcode(0x76);
126	pub const PUSH24: Opcode = Opcode(0x77);
127	pub const PUSH25: Opcode = Opcode(0x78);
128	pub const PUSH26: Opcode = Opcode(0x79);
129	pub const PUSH27: Opcode = Opcode(0x7a);
130	pub const PUSH28: Opcode = Opcode(0x7b);
131	pub const PUSH29: Opcode = Opcode(0x7c);
132	pub const PUSH30: Opcode = Opcode(0x7d);
133	pub const PUSH31: Opcode = Opcode(0x7e);
134	pub const PUSH32: Opcode = Opcode(0x7f);
135
136	/// `DUPn`
137	pub const DUP1: Opcode = Opcode(0x80);
138	pub const DUP2: Opcode = Opcode(0x81);
139	pub const DUP3: Opcode = Opcode(0x82);
140	pub const DUP4: Opcode = Opcode(0x83);
141	pub const DUP5: Opcode = Opcode(0x84);
142	pub const DUP6: Opcode = Opcode(0x85);
143	pub const DUP7: Opcode = Opcode(0x86);
144	pub const DUP8: Opcode = Opcode(0x87);
145	pub const DUP9: Opcode = Opcode(0x88);
146	pub const DUP10: Opcode = Opcode(0x89);
147	pub const DUP11: Opcode = Opcode(0x8a);
148	pub const DUP12: Opcode = Opcode(0x8b);
149	pub const DUP13: Opcode = Opcode(0x8c);
150	pub const DUP14: Opcode = Opcode(0x8d);
151	pub const DUP15: Opcode = Opcode(0x8e);
152	pub const DUP16: Opcode = Opcode(0x8f);
153
154	/// `SWAPn`
155	pub const SWAP1: Opcode = Opcode(0x90);
156	pub const SWAP2: Opcode = Opcode(0x91);
157	pub const SWAP3: Opcode = Opcode(0x92);
158	pub const SWAP4: Opcode = Opcode(0x93);
159	pub const SWAP5: Opcode = Opcode(0x94);
160	pub const SWAP6: Opcode = Opcode(0x95);
161	pub const SWAP7: Opcode = Opcode(0x96);
162	pub const SWAP8: Opcode = Opcode(0x97);
163	pub const SWAP9: Opcode = Opcode(0x98);
164	pub const SWAP10: Opcode = Opcode(0x99);
165	pub const SWAP11: Opcode = Opcode(0x9a);
166	pub const SWAP12: Opcode = Opcode(0x9b);
167	pub const SWAP13: Opcode = Opcode(0x9c);
168	pub const SWAP14: Opcode = Opcode(0x9d);
169	pub const SWAP15: Opcode = Opcode(0x9e);
170	pub const SWAP16: Opcode = Opcode(0x9f);
171
172	/// See [EIP-3541](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-3541.md)
173	pub const EOFMAGIC: Opcode = Opcode(0xef);
174
175	/// `RETURN`
176	pub const RETURN: Opcode = Opcode(0xf3);
177
178	/// `REVERT`
179	pub const REVERT: Opcode = Opcode(0xfd);
180
181	/// `INVALID`
182	pub const INVALID: Opcode = Opcode(0xfe);
183}
184
185// External opcodes
186impl Opcode {
187	/// `SHA3`
188	pub const SHA3: Opcode = Opcode(0x20);
189
190	/// `ADDRESS`
191	pub const ADDRESS: Opcode = Opcode(0x30);
192	/// `BALANCE`
193	pub const BALANCE: Opcode = Opcode(0x31);
194	/// `ORIGIN`
195	pub const ORIGIN: Opcode = Opcode(0x32);
196	/// `CALLER`
197	pub const CALLER: Opcode = Opcode(0x33);
198	/// `CALLVALUE`
199	pub const CALLVALUE: Opcode = Opcode(0x34);
200
201	/// `GASPRICE`
202	pub const GASPRICE: Opcode = Opcode(0x3a);
203	/// `EXTCODESIZE`
204	pub const EXTCODESIZE: Opcode = Opcode(0x3b);
205	/// `EXTCODECOPY`
206	pub const EXTCODECOPY: Opcode = Opcode(0x3c);
207	/// `RETURNDATASIZE`
208	pub const RETURNDATASIZE: Opcode = Opcode(0x3d);
209	/// `RETURNDATACOPY`
210	pub const RETURNDATACOPY: Opcode = Opcode(0x3e);
211	/// `EXTCODEHASH`
212	pub const EXTCODEHASH: Opcode = Opcode(0x3f);
213
214	/// `BLOCKHASH`
215	pub const BLOCKHASH: Opcode = Opcode(0x40);
216	/// `COINBASE`
217	pub const COINBASE: Opcode = Opcode(0x41);
218	/// `TIMESTAMP`
219	pub const TIMESTAMP: Opcode = Opcode(0x42);
220	/// `NUMBER`
221	pub const NUMBER: Opcode = Opcode(0x43);
222	/// `DIFFICULTY`
223	pub const DIFFICULTY: Opcode = Opcode(0x44);
224	/// `GASLIMIT`
225	pub const GASLIMIT: Opcode = Opcode(0x45);
226	/// `CHAINID`
227	pub const CHAINID: Opcode = Opcode(0x46);
228	/// `SELFBALANCE`
229	pub const SELFBALANCE: Opcode = Opcode(0x47);
230	/// `BASEFEE`
231	pub const BASEFEE: Opcode = Opcode(0x48);
232
233	/// `SLOAD`
234	pub const SLOAD: Opcode = Opcode(0x54);
235	/// `SSTORE`
236	pub const SSTORE: Opcode = Opcode(0x55);
237
238	/// `GAS`
239	pub const GAS: Opcode = Opcode(0x5a);
240
241	/// `TLOAD`
242	pub const TLOAD: Opcode = Opcode(0x5c);
243	/// `TSTORE`
244	pub const TSTORE: Opcode = Opcode(0x5d);
245
246	/// `LOGn`
247	pub const LOG0: Opcode = Opcode(0xa0);
248	pub const LOG1: Opcode = Opcode(0xa1);
249	pub const LOG2: Opcode = Opcode(0xa2);
250	pub const LOG3: Opcode = Opcode(0xa3);
251	pub const LOG4: Opcode = Opcode(0xa4);
252
253	/// `CREATE`
254	pub const CREATE: Opcode = Opcode(0xf0);
255	/// `CALL`
256	pub const CALL: Opcode = Opcode(0xf1);
257	/// `CALLCODE`
258	pub const CALLCODE: Opcode = Opcode(0xf2);
259
260	/// `DELEGATECALL`
261	pub const DELEGATECALL: Opcode = Opcode(0xf4);
262	/// `CREATE2`
263	pub const CREATE2: Opcode = Opcode(0xf5);
264
265	/// `STATICCALL`
266	pub const STATICCALL: Opcode = Opcode(0xfa);
267
268	/// `SUICIDE`
269	pub const SUICIDE: Opcode = Opcode(0xff);
270}
271
272impl Opcode {
273	/// Whether the opcode is a push opcode.
274	#[must_use]
275	pub fn is_push(&self) -> Option<u8> {
276		let value = self.0;
277		if (0x60..=0x7f).contains(&value) {
278			Some(value - 0x60 + 1)
279		} else {
280			None
281		}
282	}
283
284	#[inline]
285	#[must_use]
286	pub const fn as_u8(&self) -> u8 {
287		self.0
288	}
289
290	#[inline]
291	#[must_use]
292	pub const fn as_usize(&self) -> usize {
293		self.0 as usize
294	}
295}
evm_interpreter/opcode.rs

evm_interpreter/
opcode.rs
