9 "github.com/vapor/errors"
10 "github.com/vapor/math/checked"
15 func (op Op) String() string {
19 type Instruction struct {
27 OP_0 Op = 0x00 // synonym
30 OP_TRUE Op = 0x51 // synonym
124 OP_PUSHDATA1 Op = 0x4c
125 OP_PUSHDATA2 Op = 0x4d
126 OP_PUSHDATA4 Op = 0x4e
134 OP_CHECKPREDICATE Op = 0xc0
136 OP_TOALTSTACK Op = 0x6b
137 OP_FROMALTSTACK Op = 0x6c
161 OP_CATPUSHDATA Op = 0x89
168 OP_EQUALVERIFY Op = 0x88
177 OP_0NOTEQUAL Op = 0x92
187 OP_NUMEQUAL Op = 0x9c
188 OP_NUMEQUALVERIFY Op = 0x9d
189 OP_NUMNOTEQUAL Op = 0x9e
190 OP_LESSTHAN Op = 0x9f
191 OP_GREATERTHAN Op = 0xa0
192 OP_LESSTHANOREQUAL Op = 0xa1
193 OP_GREATERTHANOREQUAL Op = 0xa2
201 OP_CHECKSIG Op = 0xac
202 OP_CHECKMULTISIG Op = 0xad
203 OP_TXSIGHASH Op = 0xae
205 OP_CHECKOUTPUT Op = 0xc1
211 OP_OUTPUTID Op = 0xcb
212 OP_BLOCKHEIGHT Op = 0xcd
218 fn func(*virtualMachine) error
224 OP_FALSE: {OP_FALSE, "FALSE", opFalse},
226 // sic: the PUSHDATA ops all share an implementation
227 OP_PUSHDATA1: {OP_PUSHDATA1, "PUSHDATA1", opPushdata},
228 OP_PUSHDATA2: {OP_PUSHDATA2, "PUSHDATA2", opPushdata},
229 OP_PUSHDATA4: {OP_PUSHDATA4, "PUSHDATA4", opPushdata},
231 OP_1NEGATE: {OP_1NEGATE, "1NEGATE", op1Negate},
233 OP_NOP: {OP_NOP, "NOP", opNop},
236 OP_JUMP: {OP_JUMP, "JUMP", opJump},
237 OP_JUMPIF: {OP_JUMPIF, "JUMPIF", opJumpIf},
239 OP_VERIFY: {OP_VERIFY, "VERIFY", opVerify},
240 OP_FAIL: {OP_FAIL, "FAIL", opFail},
242 OP_TOALTSTACK: {OP_TOALTSTACK, "TOALTSTACK", opToAltStack},
243 OP_FROMALTSTACK: {OP_FROMALTSTACK, "FROMALTSTACK", opFromAltStack},
244 OP_2DROP: {OP_2DROP, "2DROP", op2Drop},
245 OP_2DUP: {OP_2DUP, "2DUP", op2Dup},
246 OP_3DUP: {OP_3DUP, "3DUP", op3Dup},
247 OP_2OVER: {OP_2OVER, "2OVER", op2Over},
248 OP_2ROT: {OP_2ROT, "2ROT", op2Rot},
249 OP_2SWAP: {OP_2SWAP, "2SWAP", op2Swap},
250 OP_IFDUP: {OP_IFDUP, "IFDUP", opIfDup},
251 OP_DEPTH: {OP_DEPTH, "DEPTH", opDepth},
252 OP_DROP: {OP_DROP, "DROP", opDrop},
253 OP_DUP: {OP_DUP, "DUP", opDup},
254 OP_NIP: {OP_NIP, "NIP", opNip},
255 OP_OVER: {OP_OVER, "OVER", opOver},
256 OP_PICK: {OP_PICK, "PICK", opPick},
257 OP_ROLL: {OP_ROLL, "ROLL", opRoll},
258 OP_ROT: {OP_ROT, "ROT", opRot},
259 OP_SWAP: {OP_SWAP, "SWAP", opSwap},
260 OP_TUCK: {OP_TUCK, "TUCK", opTuck},
262 OP_CAT: {OP_CAT, "CAT", opCat},
263 OP_SUBSTR: {OP_SUBSTR, "SUBSTR", opSubstr},
264 OP_LEFT: {OP_LEFT, "LEFT", opLeft},
265 OP_RIGHT: {OP_RIGHT, "RIGHT", opRight},
266 OP_SIZE: {OP_SIZE, "SIZE", opSize},
267 OP_CATPUSHDATA: {OP_CATPUSHDATA, "CATPUSHDATA", opCatpushdata},
269 OP_INVERT: {OP_INVERT, "INVERT", opInvert},
270 OP_AND: {OP_AND, "AND", opAnd},
271 OP_OR: {OP_OR, "OR", opOr},
272 OP_XOR: {OP_XOR, "XOR", opXor},
273 OP_EQUAL: {OP_EQUAL, "EQUAL", opEqual},
274 OP_EQUALVERIFY: {OP_EQUALVERIFY, "EQUALVERIFY", opEqualVerify},
276 OP_1ADD: {OP_1ADD, "1ADD", op1Add},
277 OP_1SUB: {OP_1SUB, "1SUB", op1Sub},
278 OP_2MUL: {OP_2MUL, "2MUL", op2Mul},
279 OP_2DIV: {OP_2DIV, "2DIV", op2Div},
280 OP_NEGATE: {OP_NEGATE, "NEGATE", opNegate},
281 OP_ABS: {OP_ABS, "ABS", opAbs},
282 OP_NOT: {OP_NOT, "NOT", opNot},
283 OP_0NOTEQUAL: {OP_0NOTEQUAL, "0NOTEQUAL", op0NotEqual},
284 OP_ADD: {OP_ADD, "ADD", opAdd},
285 OP_SUB: {OP_SUB, "SUB", opSub},
286 OP_MUL: {OP_MUL, "MUL", opMul},
287 OP_DIV: {OP_DIV, "DIV", opDiv},
288 OP_MOD: {OP_MOD, "MOD", opMod},
289 OP_LSHIFT: {OP_LSHIFT, "LSHIFT", opLshift},
290 OP_RSHIFT: {OP_RSHIFT, "RSHIFT", opRshift},
291 OP_BOOLAND: {OP_BOOLAND, "BOOLAND", opBoolAnd},
292 OP_BOOLOR: {OP_BOOLOR, "BOOLOR", opBoolOr},
293 OP_NUMEQUAL: {OP_NUMEQUAL, "NUMEQUAL", opNumEqual},
294 OP_NUMEQUALVERIFY: {OP_NUMEQUALVERIFY, "NUMEQUALVERIFY", opNumEqualVerify},
295 OP_NUMNOTEQUAL: {OP_NUMNOTEQUAL, "NUMNOTEQUAL", opNumNotEqual},
296 OP_LESSTHAN: {OP_LESSTHAN, "LESSTHAN", opLessThan},
297 OP_GREATERTHAN: {OP_GREATERTHAN, "GREATERTHAN", opGreaterThan},
298 OP_LESSTHANOREQUAL: {OP_LESSTHANOREQUAL, "LESSTHANOREQUAL", opLessThanOrEqual},
299 OP_GREATERTHANOREQUAL: {OP_GREATERTHANOREQUAL, "GREATERTHANOREQUAL", opGreaterThanOrEqual},
300 OP_MIN: {OP_MIN, "MIN", opMin},
301 OP_MAX: {OP_MAX, "MAX", opMax},
302 OP_WITHIN: {OP_WITHIN, "WITHIN", opWithin},
304 OP_SHA256: {OP_SHA256, "SHA256", opSha256},
305 OP_SHA3: {OP_SHA3, "SHA3", opSha3},
306 OP_HASH160: {OP_HASH160, "HASH160", opHash160},
307 OP_CHECKSIG: {OP_CHECKSIG, "CHECKSIG", opCheckSig},
308 OP_CHECKMULTISIG: {OP_CHECKMULTISIG, "CHECKMULTISIG", opCheckMultiSig},
309 OP_TXSIGHASH: {OP_TXSIGHASH, "TXSIGHASH", opTxSigHash},
311 OP_CHECKOUTPUT: {OP_CHECKOUTPUT, "CHECKOUTPUT", opCheckOutput},
312 OP_ASSET: {OP_ASSET, "ASSET", opAsset},
313 OP_AMOUNT: {OP_AMOUNT, "AMOUNT", opAmount},
314 OP_PROGRAM: {OP_PROGRAM, "PROGRAM", opProgram},
315 OP_INDEX: {OP_INDEX, "INDEX", opIndex},
316 OP_ENTRYID: {OP_ENTRYID, "ENTRYID", opEntryID},
317 OP_OUTPUTID: {OP_OUTPUTID, "OUTPUTID", opOutputID},
318 OP_BLOCKHEIGHT: {OP_BLOCKHEIGHT, "BLOCKHEIGHT", opBlockHeight},
321 opsByName map[string]opInfo
324 // ParseOp parses the op at position pc in prog, returning the parsed
325 // instruction (opcode plus any associated data).
326 func ParseOp(prog []byte, pc uint32) (inst Instruction, err error) {
327 if len(prog) > math.MaxInt32 {
330 l := uint32(len(prog))
332 err = ErrShortProgram
335 opcode := Op(prog[pc])
338 if opcode >= OP_1 && opcode <= OP_16 {
339 inst.Data = []byte{uint8(opcode-OP_1) + 1}
342 if opcode >= OP_DATA_1 && opcode <= OP_DATA_75 {
343 inst.Len += uint32(opcode - OP_DATA_1 + 1)
344 end, ok := checked.AddUint32(pc, inst.Len)
346 err = errors.WithDetail(checked.ErrOverflow, "data length exceeds max program size")
350 err = ErrShortProgram
353 inst.Data = prog[pc+1 : end]
356 if opcode == OP_PUSHDATA1 {
358 err = ErrShortProgram
362 inst.Len += uint32(n) + 1
363 end, ok := checked.AddUint32(pc, inst.Len)
365 err = errors.WithDetail(checked.ErrOverflow, "data length exceeds max program size")
368 err = ErrShortProgram
371 inst.Data = prog[pc+2 : end]
374 if opcode == OP_PUSHDATA2 {
375 if len(prog) < 3 || pc > l-3 {
376 err = ErrShortProgram
379 n := binary.LittleEndian.Uint16(prog[pc+1 : pc+3])
380 inst.Len += uint32(n) + 2
381 end, ok := checked.AddUint32(pc, inst.Len)
383 err = errors.WithDetail(checked.ErrOverflow, "data length exceeds max program size")
387 err = ErrShortProgram
390 inst.Data = prog[pc+3 : end]
393 if opcode == OP_PUSHDATA4 {
394 if len(prog) < 5 || pc > l-5 {
395 err = ErrShortProgram
400 n := binary.LittleEndian.Uint32(prog[pc+1 : pc+5])
402 inst.Len, ok = checked.AddUint32(inst.Len, n)
404 err = errors.WithDetail(checked.ErrOverflow, "data length exceeds max program size")
407 end, ok := checked.AddUint32(pc, inst.Len)
409 err = errors.WithDetail(checked.ErrOverflow, "data length exceeds max program size")
413 err = ErrShortProgram
416 inst.Data = prog[pc+5 : end]
419 if opcode == OP_JUMP || opcode == OP_JUMPIF {
421 end, ok := checked.AddUint32(pc, inst.Len)
423 err = errors.WithDetail(checked.ErrOverflow, "jump target exceeds max program size")
427 err = ErrShortProgram
430 inst.Data = prog[pc+1 : end]
436 func ParseProgram(prog []byte) ([]Instruction, error) {
437 var result []Instruction
438 for pc := uint32(0); pc < uint32(len(prog)); { // update pc inside the loop
439 inst, err := ParseOp(prog, pc)
443 result = append(result, inst)
445 pc, ok = checked.AddUint32(pc, inst.Len)
447 return nil, errors.WithDetail(checked.ErrOverflow, "program counter exceeds max program size")
453 var isExpansion [256]bool
456 for i := 1; i <= 75; i++ {
457 ops[i] = opInfo{Op(i), fmt.Sprintf("DATA_%d", i), opPushdata}
459 for i := uint8(0); i <= 15; i++ {
460 op := uint8(OP_1) + i
461 ops[op] = opInfo{Op(op), fmt.Sprintf("%d", i+1), opPushdata}
464 // This is here to break a dependency cycle
465 ops[OP_CHECKPREDICATE] = opInfo{OP_CHECKPREDICATE, "CHECKPREDICATE", opCheckPredicate}
467 opsByName = make(map[string]opInfo)
468 for _, info := range ops {
469 opsByName[info.name] = info
471 opsByName["0"] = ops[OP_FALSE]
472 opsByName["TRUE"] = ops[OP_1]
474 for i := 0; i <= 255; i++ {
475 if ops[i].name == "" {
476 ops[i] = opInfo{Op(i), fmt.Sprintf("NOPx%02x", i), opNop}
477 isExpansion[i] = true
482 // IsPushdata judge instruction whether is a pushdata operation(include opFalse operation)
483 func (inst *Instruction) IsPushdata() bool {
484 if reflect.ValueOf(ops[inst.Op].fn) == reflect.ValueOf(ops[OP_1].fn) ||
485 reflect.ValueOf(ops[inst.Op].fn) == reflect.ValueOf(ops[OP_0].fn) {