1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2011 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef H_BITCOIN_SCRIPT
6 #define H_BITCOIN_SCRIPT
21 SIGHASH_ANYONECANPAY = 0x80,
130 OP_GREATERTHANOREQUAL,
146 OP_CHECKMULTISIGVERIFY,
162 // template matching params
163 OP_PUBKEYHASH = 0xfd,
166 OP_INVALIDOPCODE = 0xff,
176 inline const char* GetOpName(opcodetype opcode)
181 case OP_0 : return "0";
182 case OP_PUSHDATA1 : return "OP_PUSHDATA1";
183 case OP_PUSHDATA2 : return "OP_PUSHDATA2";
184 case OP_PUSHDATA4 : return "OP_PUSHDATA4";
185 case OP_1NEGATE : return "-1";
186 case OP_RESERVED : return "OP_RESERVED";
187 case OP_1 : return "1";
188 case OP_2 : return "2";
189 case OP_3 : return "3";
190 case OP_4 : return "4";
191 case OP_5 : return "5";
192 case OP_6 : return "6";
193 case OP_7 : return "7";
194 case OP_8 : return "8";
195 case OP_9 : return "9";
196 case OP_10 : return "10";
197 case OP_11 : return "11";
198 case OP_12 : return "12";
199 case OP_13 : return "13";
200 case OP_14 : return "14";
201 case OP_15 : return "15";
202 case OP_16 : return "16";
205 case OP_NOP : return "OP_NOP";
206 case OP_VER : return "OP_VER";
207 case OP_IF : return "OP_IF";
208 case OP_NOTIF : return "OP_NOTIF";
209 case OP_VERIF : return "OP_VERIF";
210 case OP_VERNOTIF : return "OP_VERNOTIF";
211 case OP_ELSE : return "OP_ELSE";
212 case OP_ENDIF : return "OP_ENDIF";
213 case OP_VERIFY : return "OP_VERIFY";
214 case OP_RETURN : return "OP_RETURN";
217 case OP_TOALTSTACK : return "OP_TOALTSTACK";
218 case OP_FROMALTSTACK : return "OP_FROMALTSTACK";
219 case OP_2DROP : return "OP_2DROP";
220 case OP_2DUP : return "OP_2DUP";
221 case OP_3DUP : return "OP_3DUP";
222 case OP_2OVER : return "OP_2OVER";
223 case OP_2ROT : return "OP_2ROT";
224 case OP_2SWAP : return "OP_2SWAP";
225 case OP_IFDUP : return "OP_IFDUP";
226 case OP_DEPTH : return "OP_DEPTH";
227 case OP_DROP : return "OP_DROP";
228 case OP_DUP : return "OP_DUP";
229 case OP_NIP : return "OP_NIP";
230 case OP_OVER : return "OP_OVER";
231 case OP_PICK : return "OP_PICK";
232 case OP_ROLL : return "OP_ROLL";
233 case OP_ROT : return "OP_ROT";
234 case OP_SWAP : return "OP_SWAP";
235 case OP_TUCK : return "OP_TUCK";
238 case OP_CAT : return "OP_CAT";
239 case OP_SUBSTR : return "OP_SUBSTR";
240 case OP_LEFT : return "OP_LEFT";
241 case OP_RIGHT : return "OP_RIGHT";
242 case OP_SIZE : return "OP_SIZE";
245 case OP_INVERT : return "OP_INVERT";
246 case OP_AND : return "OP_AND";
247 case OP_OR : return "OP_OR";
248 case OP_XOR : return "OP_XOR";
249 case OP_EQUAL : return "OP_EQUAL";
250 case OP_EQUALVERIFY : return "OP_EQUALVERIFY";
251 case OP_RESERVED1 : return "OP_RESERVED1";
252 case OP_RESERVED2 : return "OP_RESERVED2";
255 case OP_1ADD : return "OP_1ADD";
256 case OP_1SUB : return "OP_1SUB";
257 case OP_2MUL : return "OP_2MUL";
258 case OP_2DIV : return "OP_2DIV";
259 case OP_NEGATE : return "OP_NEGATE";
260 case OP_ABS : return "OP_ABS";
261 case OP_NOT : return "OP_NOT";
262 case OP_0NOTEQUAL : return "OP_0NOTEQUAL";
263 case OP_ADD : return "OP_ADD";
264 case OP_SUB : return "OP_SUB";
265 case OP_MUL : return "OP_MUL";
266 case OP_DIV : return "OP_DIV";
267 case OP_MOD : return "OP_MOD";
268 case OP_LSHIFT : return "OP_LSHIFT";
269 case OP_RSHIFT : return "OP_RSHIFT";
270 case OP_BOOLAND : return "OP_BOOLAND";
271 case OP_BOOLOR : return "OP_BOOLOR";
272 case OP_NUMEQUAL : return "OP_NUMEQUAL";
273 case OP_NUMEQUALVERIFY : return "OP_NUMEQUALVERIFY";
274 case OP_NUMNOTEQUAL : return "OP_NUMNOTEQUAL";
275 case OP_LESSTHAN : return "OP_LESSTHAN";
276 case OP_GREATERTHAN : return "OP_GREATERTHAN";
277 case OP_LESSTHANOREQUAL : return "OP_LESSTHANOREQUAL";
278 case OP_GREATERTHANOREQUAL : return "OP_GREATERTHANOREQUAL";
279 case OP_MIN : return "OP_MIN";
280 case OP_MAX : return "OP_MAX";
281 case OP_WITHIN : return "OP_WITHIN";
284 case OP_RIPEMD160 : return "OP_RIPEMD160";
285 case OP_SHA1 : return "OP_SHA1";
286 case OP_SHA256 : return "OP_SHA256";
287 case OP_HASH160 : return "OP_HASH160";
288 case OP_HASH256 : return "OP_HASH256";
289 case OP_CODESEPARATOR : return "OP_CODESEPARATOR";
290 case OP_CHECKSIG : return "OP_CHECKSIG";
291 case OP_CHECKSIGVERIFY : return "OP_CHECKSIGVERIFY";
292 case OP_CHECKMULTISIG : return "OP_CHECKMULTISIG";
293 case OP_CHECKMULTISIGVERIFY : return "OP_CHECKMULTISIGVERIFY";
296 case OP_NOP1 : return "OP_NOP1";
297 case OP_NOP2 : return "OP_NOP2";
298 case OP_NOP3 : return "OP_NOP3";
299 case OP_NOP4 : return "OP_NOP4";
300 case OP_NOP5 : return "OP_NOP5";
301 case OP_NOP6 : return "OP_NOP6";
302 case OP_NOP7 : return "OP_NOP7";
303 case OP_NOP8 : return "OP_NOP8";
304 case OP_NOP9 : return "OP_NOP9";
305 case OP_NOP10 : return "OP_NOP10";
309 // template matching params
310 case OP_PUBKEYHASH : return "OP_PUBKEYHASH";
311 case OP_PUBKEY : return "OP_PUBKEY";
313 case OP_INVALIDOPCODE : return "OP_INVALIDOPCODE";
322 inline std::string ValueString(const std::vector<unsigned char>& vch)
325 return strprintf("%d", CBigNum(vch).getint());
330 inline std::string StackString(const std::vector<std::vector<unsigned char> >& vStack)
333 BOOST_FOREACH(const std::vector<unsigned char>& vch, vStack)
337 str += ValueString(vch);
350 class CScript : public std::vector<unsigned char>
353 CScript& push_int64(int64 n)
355 if (n == -1 || (n >= 1 && n <= 16))
357 push_back(n + (OP_1 - 1));
362 *this << bn.getvch();
367 CScript& push_uint64(uint64 n)
369 if (n >= 1 && n <= 16)
371 push_back(n + (OP_1 - 1));
376 *this << bn.getvch();
383 CScript(const CScript& b) : std::vector<unsigned char>(b.begin(), b.end()) { }
384 CScript(const_iterator pbegin, const_iterator pend) : std::vector<unsigned char>(pbegin, pend) { }
386 CScript(const unsigned char* pbegin, const unsigned char* pend) : std::vector<unsigned char>(pbegin, pend) { }
389 CScript& operator+=(const CScript& b)
391 insert(end(), b.begin(), b.end());
395 friend CScript operator+(const CScript& a, const CScript& b)
403 explicit CScript(char b) { operator<<(b); }
404 explicit CScript(short b) { operator<<(b); }
405 explicit CScript(int b) { operator<<(b); }
406 explicit CScript(long b) { operator<<(b); }
407 explicit CScript(int64 b) { operator<<(b); }
408 explicit CScript(unsigned char b) { operator<<(b); }
409 explicit CScript(unsigned int b) { operator<<(b); }
410 explicit CScript(unsigned short b) { operator<<(b); }
411 explicit CScript(unsigned long b) { operator<<(b); }
412 explicit CScript(uint64 b) { operator<<(b); }
414 explicit CScript(opcodetype b) { operator<<(b); }
415 explicit CScript(const uint256& b) { operator<<(b); }
416 explicit CScript(const CBigNum& b) { operator<<(b); }
417 explicit CScript(const std::vector<unsigned char>& b) { operator<<(b); }
420 CScript& operator<<(char b) { return push_int64(b); }
421 CScript& operator<<(short b) { return push_int64(b); }
422 CScript& operator<<(int b) { return push_int64(b); }
423 CScript& operator<<(long b) { return push_int64(b); }
424 CScript& operator<<(int64 b) { return push_int64(b); }
425 CScript& operator<<(unsigned char b) { return push_uint64(b); }
426 CScript& operator<<(unsigned int b) { return push_uint64(b); }
427 CScript& operator<<(unsigned short b) { return push_uint64(b); }
428 CScript& operator<<(unsigned long b) { return push_uint64(b); }
429 CScript& operator<<(uint64 b) { return push_uint64(b); }
431 CScript& operator<<(opcodetype opcode)
433 if (opcode < 0 || opcode > 0xff)
434 throw std::runtime_error("CScript::operator<<() : invalid opcode");
435 insert(end(), (unsigned char)opcode);
439 CScript& operator<<(const uint160& b)
441 insert(end(), sizeof(b));
442 insert(end(), (unsigned char*)&b, (unsigned char*)&b + sizeof(b));
446 CScript& operator<<(const uint256& b)
448 insert(end(), sizeof(b));
449 insert(end(), (unsigned char*)&b, (unsigned char*)&b + sizeof(b));
453 CScript& operator<<(const CBigNum& b)
459 CScript& operator<<(const std::vector<unsigned char>& b)
461 if (b.size() < OP_PUSHDATA1)
463 insert(end(), (unsigned char)b.size());
465 else if (b.size() <= 0xff)
467 insert(end(), OP_PUSHDATA1);
468 insert(end(), (unsigned char)b.size());
470 else if (b.size() <= 0xffff)
472 insert(end(), OP_PUSHDATA2);
473 unsigned short nSize = b.size();
474 insert(end(), (unsigned char*)&nSize, (unsigned char*)&nSize + sizeof(nSize));
478 insert(end(), OP_PUSHDATA4);
479 unsigned int nSize = b.size();
480 insert(end(), (unsigned char*)&nSize, (unsigned char*)&nSize + sizeof(nSize));
482 insert(end(), b.begin(), b.end());
486 CScript& operator<<(const CScript& b)
488 // I'm not sure if this should push the script or concatenate scripts.
489 // If there's ever a use for pushing a script onto a script, delete this member fn
490 assert(!"warning: pushing a CScript onto a CScript with << is probably not intended, use + to concatenate");
495 bool GetOp(iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>& vchRet)
497 // Wrapper so it can be called with either iterator or const_iterator
498 const_iterator pc2 = pc;
499 bool fRet = GetOp2(pc2, opcodeRet, &vchRet);
500 pc = begin() + (pc2 - begin());
504 bool GetOp(iterator& pc, opcodetype& opcodeRet)
506 const_iterator pc2 = pc;
507 bool fRet = GetOp2(pc2, opcodeRet, NULL);
508 pc = begin() + (pc2 - begin());
512 bool GetOp(const_iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>& vchRet) const
514 return GetOp2(pc, opcodeRet, &vchRet);
517 bool GetOp(const_iterator& pc, opcodetype& opcodeRet) const
519 return GetOp2(pc, opcodeRet, NULL);
522 bool GetOp2(const_iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>* pvchRet) const
524 opcodeRet = OP_INVALIDOPCODE;
533 unsigned int opcode = *pc++;
536 if (opcode <= OP_PUSHDATA4)
539 if (opcode < OP_PUSHDATA1)
543 else if (opcode == OP_PUSHDATA1)
549 else if (opcode == OP_PUSHDATA2)
554 memcpy(&nSize, &pc[0], 2);
557 else if (opcode == OP_PUSHDATA4)
561 memcpy(&nSize, &pc[0], 4);
564 if (end() - pc < nSize)
567 pvchRet->assign(pc, pc + nSize);
571 opcodeRet = (opcodetype)opcode;
576 void FindAndDelete(const CScript& b)
580 iterator pc = begin();
584 while (end() - pc >= b.size() && memcmp(&pc[0], &b[0], b.size()) == 0)
585 erase(pc, pc + b.size());
587 while (GetOp(pc, opcode));
591 int GetSigOpCount() const
594 const_iterator pc = begin();
598 if (!GetOp(pc, opcode))
600 if (opcode == OP_CHECKSIG || opcode == OP_CHECKSIGVERIFY)
602 else if (opcode == OP_CHECKMULTISIG || opcode == OP_CHECKMULTISIGVERIFY)
609 bool IsPushOnly() const
613 const_iterator pc = begin();
617 if (!GetOp(pc, opcode))
626 CBitcoinAddress GetBitcoinAddress() const
629 std::vector<unsigned char> vch;
630 CScript::const_iterator pc = begin();
631 if (!GetOp(pc, opcode, vch) || opcode != OP_DUP) return 0;
632 if (!GetOp(pc, opcode, vch) || opcode != OP_HASH160) return 0;
633 if (!GetOp(pc, opcode, vch) || vch.size() != sizeof(uint160)) return 0;
634 uint160 hash160 = uint160(vch);
635 if (!GetOp(pc, opcode, vch) || opcode != OP_EQUALVERIFY) return 0;
636 if (!GetOp(pc, opcode, vch) || opcode != OP_CHECKSIG) return 0;
637 if (pc != end()) return 0;
638 return CBitcoinAddress(hash160);
641 void SetBitcoinAddress(const CBitcoinAddress& address)
644 *this << OP_DUP << OP_HASH160 << address.GetHash160() << OP_EQUALVERIFY << OP_CHECKSIG;
647 void SetBitcoinAddress(const std::vector<unsigned char>& vchPubKey)
649 SetBitcoinAddress(CBitcoinAddress(vchPubKey));
653 void PrintHex() const
655 printf("CScript(%s)\n", HexStr(begin(), end(), true).c_str());
658 std::string ToString() const
662 std::vector<unsigned char> vch;
663 const_iterator pc = begin();
668 if (!GetOp(pc, opcode, vch))
673 if (0 <= opcode && opcode <= OP_PUSHDATA4)
674 str += ValueString(vch);
676 str += GetOpName(opcode);
683 printf("%s\n", ToString().c_str());
694 bool IsStandard(const CScript& scriptPubKey);
695 bool IsMine(const CKeyStore& keystore, const CScript& scriptPubKey);
696 bool ExtractAddress(const CScript& scriptPubKey, const CKeyStore* pkeystore, CBitcoinAddress& addressRet);
697 bool SignSignature(const CKeyStore& keystore, const CTransaction& txFrom, CTransaction& txTo, unsigned int nIn, int nHashType=SIGHASH_ALL, CScript scriptPrereq=CScript());
698 bool VerifySignature(const CTransaction& txFrom, const CTransaction& txTo, unsigned int nIn, int nHashType=0);