1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef H_BITCOIN_SCRIPT
6 #define H_BITCOIN_SCRIPT
11 #include <boost/foreach.hpp>
12 #include <boost/variant.hpp>
20 /** Signature hash types/flags */
26 SIGHASH_ANYONECANPAY = 0x80,
29 /** Script verification flags */
32 SCRIPT_VERIFY_NONE = 0,
33 SCRIPT_VERIFY_P2SH = (1U << 0),
34 SCRIPT_VERIFY_STRICTENC = (1U << 1),
40 // 'standard' transaction types:
47 class CNoDestination {
49 friend bool operator==(const CNoDestination &a, const CNoDestination &b) { return true; }
50 friend bool operator<(const CNoDestination &a, const CNoDestination &b) { return true; }
53 /** A txout script template with a specific destination. It is either:
54 * * CNoDestination: no destination set
55 * * CKeyID: TX_PUBKEYHASH destination
56 * * CScriptID: TX_SCRIPTHASH destination
57 * A CTxDestination is the internal data type encoded in a CBitcoinAddress
59 typedef boost::variant<CNoDestination, CKeyID, CScriptID> CTxDestination;
61 const char* GetTxnOutputType(txnouttype t);
105 OP_TOALTSTACK = 0x6b,
106 OP_FROMALTSTACK = 0x6c,
138 OP_EQUALVERIFY = 0x88,
163 OP_NUMEQUALVERIFY = 0x9d,
164 OP_NUMNOTEQUAL = 0x9e,
166 OP_GREATERTHAN = 0xa0,
167 OP_LESSTHANOREQUAL = 0xa1,
168 OP_GREATERTHANOREQUAL = 0xa2,
180 OP_CODESEPARATOR = 0xab,
182 OP_CHECKSIGVERIFY = 0xad,
183 OP_CHECKMULTISIG = 0xae,
184 OP_CHECKMULTISIGVERIFY = 0xaf,
200 // template matching params
201 OP_SMALLINTEGER = 0xfa,
203 OP_PUBKEYHASH = 0xfd,
206 OP_INVALIDOPCODE = 0xff,
209 const char* GetOpName(opcodetype opcode);
213 inline std::string ValueString(const std::vector<unsigned char>& vch)
216 return strprintf("%d", CBigNum(vch).getint());
221 inline std::string StackString(const std::vector<std::vector<unsigned char> >& vStack)
224 BOOST_FOREACH(const std::vector<unsigned char>& vch, vStack)
228 str += ValueString(vch);
240 /** Serialized script, used inside transaction inputs and outputs */
241 class CScript : public std::vector<unsigned char>
244 CScript& push_int64(int64 n)
246 if (n == -1 || (n >= 1 && n <= 16))
248 push_back(n + (OP_1 - 1));
253 *this << bn.getvch();
258 CScript& push_uint64(uint64 n)
260 if (n >= 1 && n <= 16)
262 push_back(n + (OP_1 - 1));
267 *this << bn.getvch();
274 CScript(const CScript& b) : std::vector<unsigned char>(b.begin(), b.end()) { }
275 CScript(const_iterator pbegin, const_iterator pend) : std::vector<unsigned char>(pbegin, pend) { }
277 CScript(const unsigned char* pbegin, const unsigned char* pend) : std::vector<unsigned char>(pbegin, pend) { }
280 CScript& operator+=(const CScript& b)
282 insert(end(), b.begin(), b.end());
286 friend CScript operator+(const CScript& a, const CScript& b)
294 //explicit CScript(char b) is not portable. Use 'signed char' or 'unsigned char'.
295 explicit CScript(signed char b) { operator<<(b); }
296 explicit CScript(short b) { operator<<(b); }
297 explicit CScript(int b) { operator<<(b); }
298 explicit CScript(long b) { operator<<(b); }
299 explicit CScript(int64 b) { operator<<(b); }
300 explicit CScript(unsigned char b) { operator<<(b); }
301 explicit CScript(unsigned int b) { operator<<(b); }
302 explicit CScript(unsigned short b) { operator<<(b); }
303 explicit CScript(unsigned long b) { operator<<(b); }
304 explicit CScript(uint64 b) { operator<<(b); }
306 explicit CScript(opcodetype b) { operator<<(b); }
307 explicit CScript(const uint256& b) { operator<<(b); }
308 explicit CScript(const CBigNum& b) { operator<<(b); }
309 explicit CScript(const std::vector<unsigned char>& b) { operator<<(b); }
312 //CScript& operator<<(char b) is not portable. Use 'signed char' or 'unsigned char'.
313 CScript& operator<<(signed char b) { return push_int64(b); }
314 CScript& operator<<(short b) { return push_int64(b); }
315 CScript& operator<<(int b) { return push_int64(b); }
316 CScript& operator<<(long b) { return push_int64(b); }
317 CScript& operator<<(int64 b) { return push_int64(b); }
318 CScript& operator<<(unsigned char b) { return push_uint64(b); }
319 CScript& operator<<(unsigned int b) { return push_uint64(b); }
320 CScript& operator<<(unsigned short b) { return push_uint64(b); }
321 CScript& operator<<(unsigned long b) { return push_uint64(b); }
322 CScript& operator<<(uint64 b) { return push_uint64(b); }
324 CScript& operator<<(opcodetype opcode)
326 if (opcode < 0 || opcode > 0xff)
327 throw std::runtime_error("CScript::operator<<() : invalid opcode");
328 insert(end(), (unsigned char)opcode);
332 CScript& operator<<(const uint160& b)
334 insert(end(), sizeof(b));
335 insert(end(), (unsigned char*)&b, (unsigned char*)&b + sizeof(b));
339 CScript& operator<<(const uint256& b)
341 insert(end(), sizeof(b));
342 insert(end(), (unsigned char*)&b, (unsigned char*)&b + sizeof(b));
346 CScript& operator<<(const CPubKey& key)
348 std::vector<unsigned char> vchKey = key.Raw();
349 return (*this) << vchKey;
352 CScript& operator<<(const CBigNum& b)
358 CScript& operator<<(const std::vector<unsigned char>& b)
360 if (b.size() < OP_PUSHDATA1)
362 insert(end(), (unsigned char)b.size());
364 else if (b.size() <= 0xff)
366 insert(end(), OP_PUSHDATA1);
367 insert(end(), (unsigned char)b.size());
369 else if (b.size() <= 0xffff)
371 insert(end(), OP_PUSHDATA2);
372 unsigned short nSize = b.size();
373 insert(end(), (unsigned char*)&nSize, (unsigned char*)&nSize + sizeof(nSize));
377 insert(end(), OP_PUSHDATA4);
378 unsigned int nSize = b.size();
379 insert(end(), (unsigned char*)&nSize, (unsigned char*)&nSize + sizeof(nSize));
381 insert(end(), b.begin(), b.end());
385 CScript& operator<<(const CScript& b)
387 // I'm not sure if this should push the script or concatenate scripts.
388 // If there's ever a use for pushing a script onto a script, delete this member fn
389 assert(!"Warning: Pushing a CScript onto a CScript with << is probably not intended, use + to concatenate!");
394 bool GetOp(iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>& vchRet)
396 // Wrapper so it can be called with either iterator or const_iterator
397 const_iterator pc2 = pc;
398 bool fRet = GetOp2(pc2, opcodeRet, &vchRet);
399 pc = begin() + (pc2 - begin());
403 bool GetOp(iterator& pc, opcodetype& opcodeRet)
405 const_iterator pc2 = pc;
406 bool fRet = GetOp2(pc2, opcodeRet, NULL);
407 pc = begin() + (pc2 - begin());
411 bool GetOp(const_iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>& vchRet) const
413 return GetOp2(pc, opcodeRet, &vchRet);
416 bool GetOp(const_iterator& pc, opcodetype& opcodeRet) const
418 return GetOp2(pc, opcodeRet, NULL);
421 bool GetOp2(const_iterator& pc, opcodetype& opcodeRet, std::vector<unsigned char>* pvchRet) const
423 opcodeRet = OP_INVALIDOPCODE;
432 unsigned int opcode = *pc++;
435 if (opcode <= OP_PUSHDATA4)
438 if (opcode < OP_PUSHDATA1)
442 else if (opcode == OP_PUSHDATA1)
448 else if (opcode == OP_PUSHDATA2)
453 memcpy(&nSize, &pc[0], 2);
456 else if (opcode == OP_PUSHDATA4)
460 memcpy(&nSize, &pc[0], 4);
463 if (end() - pc < 0 || (unsigned int)(end() - pc) < nSize)
466 pvchRet->assign(pc, pc + nSize);
470 opcodeRet = (opcodetype)opcode;
474 // Encode/decode small integers:
475 static int DecodeOP_N(opcodetype opcode)
479 assert(opcode >= OP_1 && opcode <= OP_16);
480 return (int)opcode - (int)(OP_1 - 1);
482 static opcodetype EncodeOP_N(int n)
484 assert(n >= 0 && n <= 16);
487 return (opcodetype)(OP_1+n-1);
490 int FindAndDelete(const CScript& b)
495 iterator pc = begin();
499 while (end() - pc >= (long)b.size() && memcmp(&pc[0], &b[0], b.size()) == 0)
501 erase(pc, pc + b.size());
505 while (GetOp(pc, opcode));
508 int Find(opcodetype op) const
512 for (const_iterator pc = begin(); pc != end() && GetOp(pc, opcode);)
518 // Pre-version-0.6, Bitcoin always counted CHECKMULTISIGs
519 // as 20 sigops. With pay-to-script-hash, that changed:
520 // CHECKMULTISIGs serialized in scriptSigs are
521 // counted more accurately, assuming they are of the form
522 // ... OP_N CHECKMULTISIG ...
523 unsigned int GetSigOpCount(bool fAccurate) const;
525 // Accurately count sigOps, including sigOps in
526 // pay-to-script-hash transactions:
527 unsigned int GetSigOpCount(const CScript& scriptSig) const;
529 bool IsPayToScriptHash() const;
531 // Called by CTransaction::IsStandard
532 bool IsPushOnly() const
534 const_iterator pc = begin();
538 if (!GetOp(pc, opcode))
547 void SetDestination(const CTxDestination& address);
548 void SetMultisig(int nRequired, const std::vector<CKey>& keys);
551 void PrintHex() const
553 printf("CScript(%s)\n", HexStr(begin(), end(), true).c_str());
556 std::string ToString() const
560 std::vector<unsigned char> vch;
561 const_iterator pc = begin();
566 if (!GetOp(pc, opcode, vch))
571 if (0 <= opcode && opcode <= OP_PUSHDATA4)
572 str += ValueString(vch);
574 str += GetOpName(opcode);
581 printf("%s\n", ToString().c_str());
584 CScriptID GetID() const
586 return CScriptID(Hash160(*this));
590 /** Compact serializer for scripts.
592 * It detects common cases and encodes them much more efficiently.
593 * 3 special cases are defined:
594 * * Pay to pubkey hash (encoded as 21 bytes)
595 * * Pay to script hash (encoded as 21 bytes)
596 * * Pay to pubkey starting with 0x02, 0x03 or 0x04 (encoded as 33 bytes)
598 * Other scripts up to 121 bytes require 1 byte + script length. Above
599 * that, scripts up to 16505 bytes require 2 bytes + script length.
601 class CScriptCompressor
604 // make this static for now (there are only 6 special scripts defined)
605 // this can potentially be extended together with a new nVersion for
606 // transactions, in which case this value becomes dependent on nVersion
607 // and nHeight of the enclosing transaction.
608 static const unsigned int nSpecialScripts = 6;
612 // These check for scripts for which a special case with a shorter encoding is defined.
613 // They are implemented separately from the CScript test, as these test for exact byte
614 // sequence correspondences, and are more strict. For example, IsToPubKey also verifies
615 // whether the public key is valid (as invalid ones cannot be represented in compressed
617 bool IsToKeyID(CKeyID &hash) const;
618 bool IsToScriptID(CScriptID &hash) const;
619 bool IsToPubKey(std::vector<unsigned char> &pubkey) const;
621 bool Compress(std::vector<unsigned char> &out) const;
622 unsigned int GetSpecialSize(unsigned int nSize) const;
623 bool Decompress(unsigned int nSize, const std::vector<unsigned char> &out);
625 CScriptCompressor(CScript &scriptIn) : script(scriptIn) { }
627 unsigned int GetSerializeSize(int nType, int nVersion) const {
628 std::vector<unsigned char> compr;
631 unsigned int nSize = script.size() + nSpecialScripts;
632 return script.size() + VARINT(nSize).GetSerializeSize(nType, nVersion);
635 template<typename Stream>
636 void Serialize(Stream &s, int nType, int nVersion) const {
637 std::vector<unsigned char> compr;
638 if (Compress(compr)) {
639 s << CFlatData(&compr[0], &compr[compr.size()]);
642 unsigned int nSize = script.size() + nSpecialScripts;
644 s << CFlatData(&script[0], &script[script.size()]);
647 template<typename Stream>
648 void Unserialize(Stream &s, int nType, int nVersion) {
651 if (nSize < nSpecialScripts) {
652 std::vector<unsigned char> vch(GetSpecialSize(nSize), 0x00);
653 s >> REF(CFlatData(&vch[0], &vch[vch.size()]));
654 Decompress(nSize, vch);
657 nSize -= nSpecialScripts;
658 script.resize(nSize);
659 s >> REF(CFlatData(&script[0], &script[script.size()]));
663 bool IsCanonicalPubKey(const std::vector<unsigned char> &vchPubKey);
664 bool IsCanonicalSignature(const std::vector<unsigned char> &vchSig);
666 bool EvalScript(std::vector<std::vector<unsigned char> >& stack, const CScript& script, const CTransaction& txTo, unsigned int nIn, unsigned int flags, int nHashType);
667 bool Solver(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<std::vector<unsigned char> >& vSolutionsRet);
668 int ScriptSigArgsExpected(txnouttype t, const std::vector<std::vector<unsigned char> >& vSolutions);
669 bool IsStandard(const CScript& scriptPubKey);
670 bool IsMine(const CKeyStore& keystore, const CScript& scriptPubKey);
671 bool IsMine(const CKeyStore& keystore, const CTxDestination &dest);
672 bool ExtractDestination(const CScript& scriptPubKey, CTxDestination& addressRet);
673 bool ExtractDestinations(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<CTxDestination>& addressRet, int& nRequiredRet);
674 bool SignSignature(const CKeyStore& keystore, const CScript& fromPubKey, CTransaction& txTo, unsigned int nIn, int nHashType=SIGHASH_ALL);
675 bool SignSignature(const CKeyStore& keystore, const CTransaction& txFrom, CTransaction& txTo, unsigned int nIn, int nHashType=SIGHASH_ALL);
676 bool VerifyScript(const CScript& scriptSig, const CScript& scriptPubKey, const CTransaction& txTo, unsigned int nIn, unsigned int flags, int nHashType);
678 // Given two sets of signatures for scriptPubKey, possibly with OP_0 placeholders,
679 // combine them intelligently and return the result.
680 CScript CombineSignatures(CScript scriptPubKey, const CTransaction& txTo, unsigned int nIn, const CScript& scriptSig1, const CScript& scriptSig2);