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>
16 typedef std::vector<uint8_t> valtype;
20 static const unsigned int MAX_SCRIPT_ELEMENT_SIZE = 520; // bytes
22 /** IsMine() return codes */
28 MINE_ALL = MINE_WATCH_ONLY | MINE_SPENDABLE
31 typedef uint8_t isminefilter;
33 /** Signature hash types/flags */
39 SIGHASH_ANYONECANPAY = 0x80
42 /** Script verification flags */
45 SCRIPT_VERIFY_NONE = 0,
46 SCRIPT_VERIFY_P2SH = (1U << 0), // evaluate P2SH (BIP16) subscripts
47 SCRIPT_VERIFY_STRICTENC = (1U << 1), // enforce strict conformance to DER and SEC2 for signatures and pubkeys
48 SCRIPT_VERIFY_LOW_S = (1U << 2), // enforce low S values in signatures (depends on STRICTENC)
49 SCRIPT_VERIFY_NOCACHE = (1U << 3), // do not store results in signature cache (but do query it)
50 SCRIPT_VERIFY_NULLDUMMY = (1U << 4), // verify dummy stack item consumed by CHECKMULTISIG is of zero-length
51 SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY = (1U << 9)
55 // Strict verification:
57 // * force DER encoding;
59 // * ensure that CHECKMULTISIG dummy argument is null.
60 static const unsigned int STRICT_FORMAT_FLAGS = SCRIPT_VERIFY_STRICTENC | SCRIPT_VERIFY_LOW_S | SCRIPT_VERIFY_NULLDUMMY;
62 // Mandatory script verification flags that all new blocks must comply with for
63 // them to be valid. (but old blocks may not comply with) Currently just P2SH,
64 // but in the future other flags may be added, such as a soft-fork to enforce
65 // strict DER encoding.
67 // Failing one of these tests may trigger a DoS ban - see ConnectInputs() for
69 static const unsigned int MANDATORY_SCRIPT_VERIFY_FLAGS = SCRIPT_VERIFY_P2SH;
71 // Standard script verification flags that standard transactions will comply
72 // with. However scripts violating these flags may still be present in valid
73 // blocks and we must accept those blocks.
74 static const unsigned int STRICT_FLAGS = MANDATORY_SCRIPT_VERIFY_FLAGS | STRICT_FORMAT_FLAGS;
79 // 'standard' transaction types:
88 const char* GetTxnOutputType(txnouttype t);
130 OP_CHECKLOCKTIMEVERIFY = 0xb1,
133 OP_TOALTSTACK = 0x6b,
134 OP_FROMALTSTACK = 0x6c,
166 OP_EQUALVERIFY = 0x88,
191 OP_NUMEQUALVERIFY = 0x9d,
192 OP_NUMNOTEQUAL = 0x9e,
194 OP_GREATERTHAN = 0xa0,
195 OP_LESSTHANOREQUAL = 0xa1,
196 OP_GREATERTHANOREQUAL = 0xa2,
208 OP_CODESEPARATOR = 0xab,
210 OP_CHECKSIGVERIFY = 0xad,
211 OP_CHECKMULTISIG = 0xae,
212 OP_CHECKMULTISIGVERIFY = 0xaf,
225 // template matching params
227 OP_SMALLINTEGER = 0xfa,
230 OP_PUBKEYHASH = 0xfd,
233 OP_INVALIDOPCODE = 0xff
236 const char* GetOpName(opcodetype opcode);
238 inline std::string ValueString(const std::vector<unsigned char>& vch)
241 return strprintf("%d", CBigNum(vch).getint32());
246 inline std::string StackString(const std::vector<std::vector<unsigned char> >& vStack)
249 BOOST_FOREACH(const std::vector<unsigned char>& vch, vStack)
253 str += ValueString(vch);
258 /** Serialized script, used inside transaction inputs and outputs */
259 class CScript : public std::vector<uint8_t>
262 CScript& push_int64(int64_t n)
264 if (n == -1 || (n >= 1 && n <= 16))
266 push_back((uint8_t)n + (OP_1 - 1));
271 *this << bn.getvch();
276 CScript& push_uint64(uint64_t n)
278 if (n >= 1 && n <= 16)
280 push_back((uint8_t)n + (OP_1 - 1));
285 *this << bn.getvch();
292 CScript(const CScript& b) : std::vector<uint8_t>(b.begin(), b.end()) { }
293 CScript(const_iterator pbegin, const_iterator pend) : std::vector<uint8_t>(pbegin, pend) { }
295 CScript(const uint8_t* pbegin, const uint8_t* pend) : std::vector<uint8_t>(pbegin, pend) { }
298 CScript& operator+=(const CScript& b)
300 insert(end(), b.begin(), b.end());
304 friend CScript operator+(const CScript& a, const CScript& b)
311 explicit CScript(int8_t b) { operator<<(b); }
312 explicit CScript(int16_t b) { operator<<(b); }
313 explicit CScript(int32_t b) { operator<<(b); }
314 explicit CScript(int64_t b) { operator<<(b); }
316 explicit CScript(uint8_t b) { operator<<(b); }
317 explicit CScript(uint16_t b) { operator<<(b); }
318 explicit CScript(uint32_t b) { operator<<(b); }
319 explicit CScript(uint64_t b) { operator<<(b); }
321 explicit CScript(opcodetype b) { operator<<(b); }
322 explicit CScript(const uint256& b) { operator<<(b); }
323 explicit CScript(const CBigNum& b) { operator<<(b); }
324 explicit CScript(const std::vector<uint8_t>& b) { operator<<(b); }
326 CScript& operator<<(int8_t b) { return push_int64(b); }
327 CScript& operator<<(int16_t b) { return push_int64(b); }
328 CScript& operator<<(int32_t b) { return push_int64(b); }
329 CScript& operator<<(int64_t b) { return push_int64(b); }
331 CScript& operator<<(uint8_t b) { return push_uint64(b); }
332 CScript& operator<<(uint16_t b) { return push_uint64(b); }
333 CScript& operator<<(uint32_t b) { return push_uint64(b); }
334 CScript& operator<<(uint64_t b) { return push_uint64(b); }
336 CScript& operator<<(opcodetype opcode)
338 if (opcode < 0 || opcode > 0xff)
339 throw std::runtime_error("CScript::operator<<() : invalid opcode");
340 insert(end(), (uint8_t)opcode);
344 CScript& operator<<(const uint160& b)
346 insert(end(), sizeof(b));
347 insert(end(), (uint8_t*)&b, (uint8_t*)&b + sizeof(b));
351 CScript& operator<<(const uint256& b)
353 insert(end(), sizeof(b));
354 insert(end(), (uint8_t*)&b, (uint8_t*)&b + sizeof(b));
358 CScript& operator<<(const CPubKey& key)
360 std::vector<uint8_t> vchKey = key.Raw();
361 return (*this) << vchKey;
364 CScript& operator<<(const CBigNum& b)
370 CScript& operator<<(const std::vector<uint8_t>& b)
372 if (b.size() < OP_PUSHDATA1)
374 insert(end(), (uint8_t)b.size());
376 else if (b.size() <= 0xff)
378 insert(end(), OP_PUSHDATA1);
379 insert(end(), (uint8_t)b.size());
381 else if (b.size() <= 0xffff)
383 insert(end(), OP_PUSHDATA2);
384 uint16_t nSize = (uint16_t) b.size();
385 insert(end(), (uint8_t*)&nSize, (uint8_t*)&nSize + sizeof(nSize));
389 insert(end(), OP_PUSHDATA4);
390 uint32_t nSize = (uint32_t) b.size();
391 insert(end(), (uint8_t*)&nSize, (uint8_t*)&nSize + sizeof(nSize));
393 insert(end(), b.begin(), b.end());
397 CScript& operator<<(const CScript& b)
399 // I'm not sure if this should push the script or concatenate scripts.
400 // If there's ever a use for pushing a script onto a script, delete this member fn
401 assert(!"Warning: Pushing a CScript onto a CScript with << is probably not intended, use + to concatenate!");
406 bool GetOp(iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>& vchRet)
408 // Wrapper so it can be called with either iterator or const_iterator
409 const_iterator pc2 = pc;
410 bool fRet = GetOp2(pc2, opcodeRet, &vchRet);
411 pc = begin() + (pc2 - begin());
415 bool GetOp(iterator& pc, opcodetype& opcodeRet)
417 const_iterator pc2 = pc;
418 bool fRet = GetOp2(pc2, opcodeRet, NULL);
419 pc = begin() + (pc2 - begin());
423 bool GetOp(const_iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>& vchRet) const
425 return GetOp2(pc, opcodeRet, &vchRet);
428 bool GetOp(const_iterator& pc, opcodetype& opcodeRet) const
430 return GetOp2(pc, opcodeRet, NULL);
433 bool GetOp2(const_iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>* pvchRet) const
435 opcodeRet = OP_INVALIDOPCODE;
444 uint32_t opcode = *pc++;
447 if (opcode <= OP_PUSHDATA4)
449 uint32_t nSize = OP_0;
450 if (opcode < OP_PUSHDATA1)
454 else if (opcode == OP_PUSHDATA1)
460 else if (opcode == OP_PUSHDATA2)
464 memcpy(&nSize, &pc[0], 2);
467 else if (opcode == OP_PUSHDATA4)
471 memcpy(&nSize, &pc[0], 4);
474 if (end() - pc < 0 || (uint32_t)(end() - pc) < nSize)
477 pvchRet->assign(pc, pc + nSize);
481 opcodeRet = (opcodetype)opcode;
485 // Encode/decode small integers:
486 static int DecodeOP_N(opcodetype opcode)
490 assert(opcode >= OP_1 && opcode <= OP_16);
491 return (opcode - (OP_1 - 1));
493 static opcodetype EncodeOP_N(int n)
495 assert(n >= 0 && n <= 16);
498 return (opcodetype)(OP_1+n-1);
501 int FindAndDelete(const CScript& b)
506 iterator pc = begin();
510 while (end() - pc >= (long)b.size() && memcmp(&pc[0], &b[0], b.size()) == 0)
512 erase(pc, pc + b.size());
516 while (GetOp(pc, opcode));
519 int Find(opcodetype op) const
523 for (const_iterator pc = begin(); pc != end() && GetOp(pc, opcode);)
529 // Pre-version-0.6, Bitcoin always counted CHECKMULTISIGs
530 // as 20 sigops. With pay-to-script-hash, that changed:
531 // CHECKMULTISIGs serialized in scriptSigs are
532 // counted more accurately, assuming they are of the form
533 // ... OP_N CHECKMULTISIG ...
534 unsigned int GetSigOpCount(bool fAccurate) const;
536 // Accurately count sigOps, including sigOps in
537 // pay-to-script-hash transactions:
538 unsigned int GetSigOpCount(const CScript& scriptSig) const;
540 bool IsPayToScriptHash() const;
542 bool IsPushOnly(const_iterator pc) const
547 if (!GetOp(pc, opcode))
555 // Called by CTransaction::IsStandard and P2SH VerifyScript (which makes it consensus-critical).
556 bool IsPushOnly() const
558 return this->IsPushOnly(begin());
561 // Called by CTransaction::IsStandard.
562 bool HasCanonicalPushes() const;
564 void SetDestination(const CTxDestination& address);
565 void SetDestination(const CPubKey& R, CPubKey& pubKeyVariant);
566 void SetMultisig(int nRequired, const std::vector<CKey>& keys);
569 void PrintHex() const
571 printf("CScript(%s)\n", HexStr(begin(), end(), true).c_str());
574 std::string ToString(bool fShort=false) const
578 std::vector<uint8_t> vch;
579 const_iterator pc = begin();
584 if (!GetOp(pc, opcode, vch))
589 if (0 <= opcode && opcode <= OP_PUSHDATA4)
590 str += fShort? ValueString(vch).substr(0, 10) : ValueString(vch);
592 str += GetOpName(opcode);
599 printf("%s\n", ToString().c_str());
602 CScriptID GetID() const
604 return CScriptID(Hash160(*this));
608 bool IsCanonicalPubKey(const std::vector<unsigned char> &vchPubKey, unsigned int flags);
609 bool IsDERSignature(const valtype &vchSig, bool fWithHashType=false, bool fCheckLow=false);
610 bool IsCanonicalSignature(const std::vector<unsigned char> &vchSig, unsigned int flags);
612 bool EvalScript(std::vector<std::vector<unsigned char> >& stack, const CScript& script, const CTransaction& txTo, unsigned int nIn, unsigned int flags, int nHashType);
613 bool Solver(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<std::vector<unsigned char> >& vSolutionsRet);
614 int ScriptSigArgsExpected(txnouttype t, const std::vector<std::vector<unsigned char> >& vSolutions);
615 bool IsStandard(const CScript& scriptPubKey, txnouttype& whichType);
616 isminetype IsMine(const CKeyStore& keystore, const CScript& scriptPubKey);
617 isminetype IsMine(const CKeyStore& keystore, const CTxDestination& dest);
618 void ExtractAffectedKeys(const CKeyStore &keystore, const CScript& scriptPubKey, std::vector<CKeyID> &vKeys);
619 bool ExtractDestination(const CScript& scriptPubKey, CTxDestination& addressRet);
620 bool ExtractDestinations(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<CTxDestination>& addressRet, int& nRequiredRet);
621 bool SignSignature(const CKeyStore& keystore, const CScript& fromPubKey, CTransaction& txTo, unsigned int nIn, int nHashType=SIGHASH_ALL);
622 bool SignSignature(const CKeyStore& keystore, const CTransaction& txFrom, CTransaction& txTo, unsigned int nIn, int nHashType=SIGHASH_ALL);
623 bool VerifyScript(const CScript& scriptSig, const CScript& scriptPubKey, const CTransaction& txTo, unsigned int nIn, unsigned int flags, int nHashType);
625 // Given two sets of signatures for scriptPubKey, possibly with OP_0 placeholders,
626 // combine them intelligently and return the result.
627 CScript CombineSignatures(const CScript& scriptPubKey, const CTransaction& txTo, unsigned int nIn, const CScript& scriptSig1, const CScript& scriptSig2);