src/script.h

   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
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "keystore.h"
  12 #include "bignum.h"
  13 #include "base58.h"
  14
  15 typedef std::vector<uint8_t> valtype;
  16
  17 class CTransaction;
  18 class CBitcoinAddress;
  19
  20 static const unsigned int MAX_SCRIPT_ELEMENT_SIZE = 520; // bytes
  21
  22 // Setting nSequence to this value for every input in a transaction
  23 // disables nLockTime.
  24 static const uint32_t SEQUENCE_FINAL = 0xffffffff;
  25
  26 // Threshold for inverted nSequence: below this value it is interpreted
  27 // as a relative lock-time, otherwise ignored.
  28 //static const uint32_t SEQUENCE_THRESHOLD = 0x80000000;
  29
  30 // If this flag set, CTxIn::nSequence is NOT interpreted as a
  31 // relative lock-time.
  32 static const uint32_t SEQUENCE_LOCKTIME_DISABLE_FLAG = 0x80000000;
  33
  34 // If CTxIn::nSequence encodes a relative lock-time and this flag
  35 // is set, the relative lock-time has units of 512 seconds,
  36 // otherwise it specifies blocks with a granularity of 1.
  37 static const uint32_t SEQUENCE_LOCKTIME_TYPE_FLAG = 0x00400000;
  38
  39 // If CTxIn::nSequence encodes a relative lock-time, this mask is
  40 // applied to extract that lock-time from the sequence field.
  41 static const uint32_t SEQUENCE_LOCKTIME_MASK = 0x0000ffff;
  42
  43 // IsMine() return codes
  44 enum isminetype
  45 {
  46     MINE_NO = 0,
  47     MINE_WATCH_ONLY = 1,
  48     MINE_SPENDABLE = 2,
  49     MINE_ALL = MINE_WATCH_ONLY | MINE_SPENDABLE
  50 };
  51
  52 typedef uint8_t isminefilter;
  53
  54 // Signature hash types/flags
  55 enum
  56 {
  57     SIGHASH_ALL = 1,
  58     SIGHASH_NONE = 2,
  59     SIGHASH_SINGLE = 3,
  60     SIGHASH_ANYONECANPAY = 0x80
  61 };
  62
  63 // Script verification flags
  64 enum
  65 {
  66     SCRIPT_VERIFY_NONE      = 0,
  67     SCRIPT_VERIFY_P2SH      = (1U << 0), // evaluate P2SH (BIP16) subscripts
  68     SCRIPT_VERIFY_STRICTENC = (1U << 1), // enforce strict conformance to DER and SEC2 for signatures and pubkeys
  69     SCRIPT_VERIFY_LOW_S     = (1U << 2), // enforce low S values in signatures (depends on STRICTENC)
  70     SCRIPT_VERIFY_NOCACHE   = (1U << 3), // do not store results in signature cache (but do query it)
  71     SCRIPT_VERIFY_NULLDUMMY = (1U << 4), // verify dummy stack item consumed by CHECKMULTISIG is of zero-length
  72     SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY = (1U << 9),
  73     SCRIPT_VERIFY_CHECKSEQUENCEVERIFY = (1U << 10)
  74 };
  75
  76 // Strict verification:
  77 //
  78 // * force DER encoding;
  79 // * force low S;
  80 // * ensure that CHECKMULTISIG dummy argument is null.
  81 static const unsigned int STRICT_FORMAT_FLAGS = SCRIPT_VERIFY_STRICTENC | SCRIPT_VERIFY_LOW_S | SCRIPT_VERIFY_NULLDUMMY;
  82
  83 // Mandatory script verification flags that all new blocks must comply with for
  84 // them to be valid. (but old blocks may not comply with) Currently just P2SH,
  85 // but in the future other flags may be added, such as a soft-fork to enforce
  86 // strict DER encoding.
  87 //
  88 // Failing one of these tests may trigger a DoS ban - see ConnectInputs() for
  89 // details.
  90 static const unsigned int MANDATORY_SCRIPT_VERIFY_FLAGS = SCRIPT_VERIFY_P2SH;
  91
  92 // Standard script verification flags that standard transactions will comply
  93 // with. However scripts violating these flags may still be present in valid
  94 // blocks and we must accept those blocks.
  95 static const unsigned int STRICT_FLAGS = MANDATORY_SCRIPT_VERIFY_FLAGS | STRICT_FORMAT_FLAGS;
  96
  97 enum txnouttype
  98 {
  99     TX_NONSTANDARD,
 100     // 'standard' transaction types:
 101     TX_PUBKEY,
 102     TX_PUBKEY_DROP,
 103     TX_PUBKEYHASH,
 104     TX_SCRIPTHASH,
 105     TX_MULTISIG,
 106     TX_NULL_DATA
 107 };
 108
 109 const char* GetTxnOutputType(txnouttype t);
 110
 111 // Script opcodes
 112 enum opcodetype : uint8_t
 113 {
 114     // push value
 115     OP_0 = 0x00,
 116     OP_FALSE = OP_0,
 117     OP_PUSHDATA1 = 0x4c,
 118     OP_PUSHDATA2 = 0x4d,
 119     OP_PUSHDATA4 = 0x4e,
 120     OP_1NEGATE = 0x4f,
 121     OP_RESERVED = 0x50,
 122     OP_1 = 0x51,
 123     OP_TRUE=OP_1,
 124     OP_2 = 0x52,
 125     OP_3 = 0x53,
 126     OP_4 = 0x54,
 127     OP_5 = 0x55,
 128     OP_6 = 0x56,
 129     OP_7 = 0x57,
 130     OP_8 = 0x58,
 131     OP_9 = 0x59,
 132     OP_10 = 0x5a,
 133     OP_11 = 0x5b,
 134     OP_12 = 0x5c,
 135     OP_13 = 0x5d,
 136     OP_14 = 0x5e,
 137     OP_15 = 0x5f,
 138     OP_16 = 0x60,
 139
 140     // control
 141     OP_NOP = 0x61,
 142     OP_VER = 0x62,
 143     OP_IF = 0x63,
 144     OP_NOTIF = 0x64,
 145     OP_VERIF = 0x65,
 146     OP_VERNOTIF = 0x66,
 147     OP_ELSE = 0x67,
 148     OP_ENDIF = 0x68,
 149     OP_VERIFY = 0x69,
 150     OP_RETURN = 0x6a,
 151     OP_CHECKLOCKTIMEVERIFY = 0xb1,
 152     OP_CHECKSEQUENCEVERIFY = 0xb2,
 153
 154     // stack ops
 155     OP_TOALTSTACK = 0x6b,
 156     OP_FROMALTSTACK = 0x6c,
 157     OP_2DROP = 0x6d,
 158     OP_2DUP = 0x6e,
 159     OP_3DUP = 0x6f,
 160     OP_2OVER = 0x70,
 161     OP_2ROT = 0x71,
 162     OP_2SWAP = 0x72,
 163     OP_IFDUP = 0x73,
 164     OP_DEPTH = 0x74,
 165     OP_DROP = 0x75,
 166     OP_DUP = 0x76,
 167     OP_NIP = 0x77,
 168     OP_OVER = 0x78,
 169     OP_PICK = 0x79,
 170     OP_ROLL = 0x7a,
 171     OP_ROT = 0x7b,
 172     OP_SWAP = 0x7c,
 173     OP_TUCK = 0x7d,
 174
 175     // splice ops
 176     OP_CAT = 0x7e,
 177     OP_SUBSTR = 0x7f,
 178     OP_LEFT = 0x80,
 179     OP_RIGHT = 0x81,
 180     OP_SIZE = 0x82,
 181
 182     // bit logic
 183     OP_INVERT = 0x83,
 184     OP_AND = 0x84,
 185     OP_OR = 0x85,
 186     OP_XOR = 0x86,
 187     OP_EQUAL = 0x87,
 188     OP_EQUALVERIFY = 0x88,
 189     OP_RESERVED1 = 0x89,
 190     OP_RESERVED2 = 0x8a,
 191
 192     // numeric
 193     OP_1ADD = 0x8b,
 194     OP_1SUB = 0x8c,
 195     OP_2MUL = 0x8d,
 196     OP_2DIV = 0x8e,
 197     OP_NEGATE = 0x8f,
 198     OP_ABS = 0x90,
 199     OP_NOT = 0x91,
 200     OP_0NOTEQUAL = 0x92,
 201
 202     OP_ADD = 0x93,
 203     OP_SUB = 0x94,
 204     OP_MUL = 0x95,
 205     OP_DIV = 0x96,
 206     OP_MOD = 0x97,
 207     OP_LSHIFT = 0x98,
 208     OP_RSHIFT = 0x99,
 209
 210     OP_BOOLAND = 0x9a,
 211     OP_BOOLOR = 0x9b,
 212     OP_NUMEQUAL = 0x9c,
 213     OP_NUMEQUALVERIFY = 0x9d,
 214     OP_NUMNOTEQUAL = 0x9e,
 215     OP_LESSTHAN = 0x9f,
 216     OP_GREATERTHAN = 0xa0,
 217     OP_LESSTHANOREQUAL = 0xa1,
 218     OP_GREATERTHANOREQUAL = 0xa2,
 219     OP_MIN = 0xa3,
 220     OP_MAX = 0xa4,
 221
 222     OP_WITHIN = 0xa5,
 223
 224     // crypto
 225     OP_RIPEMD160 = 0xa6,
 226     OP_SHA1 = 0xa7,
 227     OP_SHA256 = 0xa8,
 228     OP_HASH160 = 0xa9,
 229     OP_HASH256 = 0xaa,
 230     OP_CODESEPARATOR = 0xab,
 231     OP_CHECKSIG = 0xac,
 232     OP_CHECKSIGVERIFY = 0xad,
 233     OP_CHECKMULTISIG = 0xae,
 234     OP_CHECKMULTISIGVERIFY = 0xaf,
 235
 236     // expansion
 237     OP_NOP1 = 0xb0,
 238     OP_NOP4 = 0xb3,
 239     OP_NOP5 = 0xb4,
 240     OP_NOP6 = 0xb5,
 241     OP_NOP7 = 0xb6,
 242     OP_NOP8 = 0xb7,
 243     OP_NOP9 = 0xb8,
 244     OP_NOP10 = 0xb9,
 245
 246     // template matching params
 247     OP_SMALLDATA = 0xf9,
 248     OP_SMALLINTEGER = 0xfa,
 249     OP_PUBKEYS = 0xfb,
 250     OP_INTEGER = 0xfc,
 251     OP_PUBKEYHASH = 0xfd,
 252     OP_PUBKEY = 0xfe,
 253
 254     OP_INVALIDOPCODE = 0xff
 255 };
 256
 257 const char* GetOpName(opcodetype opcode);
 258
 259 inline std::string ValueString(const std::vector<unsigned char>& vch)
 260 {
 261     if (vch.size() <= 4)
 262         return std::to_string(CBigNum(vch).getint32());
 263     else
 264         return HexStr(vch);
 265 }
 266
 267 inline std::string StackString(const std::vector<std::vector<unsigned char> >& vStack)
 268 {
 269     std::string str;
 270     for(const auto& vch : vStack)
 271     {
 272         if (!str.empty())
 273             str += " ";
 274         str += ValueString(vch);
 275     }
 276     return str;
 277 }
 278
 279 // Serialized script, used inside transaction inputs and outputs
 280 class CScript : public std::vector<uint8_t>
 281 {
 282 protected:
 283
 284     CScript& push_int64(int64_t n);
 285     CScript& push_uint64(uint64_t n);
 286
 287 public:
 288     CScript() { }
 289     CScript(const CScript& b) : std::vector<uint8_t>(b.begin(), b.end()) { }
 290     CScript(const_iterator pbegin, const_iterator pend) : std::vector<uint8_t>(pbegin, pend) { }
 291 #ifndef _MSC_VER
 292     CScript(const uint8_t* pbegin, const uint8_t* pend) : std::vector<uint8_t>(pbegin, pend) { }
 293 #endif
 294
 295     CScript& operator+=(const CScript& b);
 296
 297     friend CScript operator+(const CScript& a, const CScript& b)
 298     {
 299         CScript ret = a;
 300         ret += b;
 301         return ret;
 302     }
 303
 304     explicit CScript(int8_t  b) { operator<<(b); }
 305     explicit CScript(int16_t b) { operator<<(b); }
 306     explicit CScript(int32_t b) { operator<<(b); }
 307     explicit CScript(int64_t b) { operator<<(b); }
 308
 309     explicit CScript(uint8_t  b) { operator<<(b); }
 310     explicit CScript(uint16_t b) { operator<<(b); }
 311     explicit CScript(uint32_t b) { operator<<(b); }
 312     explicit CScript(uint64_t b) { operator<<(b); }
 313
 314     explicit CScript(opcodetype b)     { operator<<(b); }
 315     explicit CScript(const uint256& b) { operator<<(b); }
 316     explicit CScript(const CBigNum& b) { operator<<(b); }
 317     explicit CScript(const std::vector<uint8_t>& b) { operator<<(b); }
 318
 319     CScript& operator<<(int8_t  b) { return push_int64(b); }
 320     CScript& operator<<(int16_t b) { return push_int64(b); }
 321     CScript& operator<<(int32_t b) { return push_int64(b); }
 322     CScript& operator<<(int64_t b) { return push_int64(b); }
 323
 324     CScript& operator<<(uint8_t  b) { return push_uint64(b); }
 325     CScript& operator<<(uint16_t b) { return push_uint64(b); }
 326     CScript& operator<<(uint32_t b) { return push_uint64(b); }
 327     CScript& operator<<(uint64_t b) { return push_uint64(b); }
 328
 329     CScript& operator<<(opcodetype opcode);
 330     CScript& operator<<(const uint160& b);
 331     CScript& operator<<(const uint256& b);
 332     CScript& operator<<(const CPubKey& key);
 333     CScript& operator<<(const CBigNum& b);
 334     CScript& operator<<(const std::vector<uint8_t>& b);
 335     CScript& operator<<(const CScript& b);
 336
 337     bool GetOp(iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>& vchRet);
 338     bool GetOp(iterator& pc, opcodetype& opcodeRet);
 339     bool GetOp(const_iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>& vchRet) const;
 340     bool GetOp(const_iterator& pc, opcodetype& opcodeRet) const;
 341     bool GetOp2(const_iterator& pc, opcodetype& opcodeRet, std::vector<uint8_t>* pvchRet) const;
 342
 343     // Encode/decode small integers:
 344     static int DecodeOP_N(opcodetype opcode);
 345     static opcodetype EncodeOP_N(int n);
 346
 347     int FindAndDelete(const CScript& b);
 348     int Find(opcodetype op) const;
 349
 350     // Pre-version-0.6, Bitcoin always counted CHECKMULTISIGs
 351     // as 20 sigops. With pay-to-script-hash, that changed:
 352     // CHECKMULTISIGs serialized in scriptSigs are
 353     // counted more accurately, assuming they are of the form
 354     //  ... OP_N CHECKMULTISIG ...
 355     unsigned int GetSigOpCount(bool fAccurate) const;
 356
 357     // Accurately count sigOps, including sigOps in
 358     // pay-to-script-hash transactions:
 359     unsigned int GetSigOpCount(const CScript& scriptSig) const;
 360
 361     bool IsPayToScriptHash() const;
 362
 363     bool IsPushOnly(const_iterator pc) const;
 364
 365     // Called by CTransaction::IsStandard and P2SH VerifyScript (which makes it consensus-critical).
 366     bool IsPushOnly() const;
 367
 368     // Called by CTransaction::IsStandard.
 369     bool HasCanonicalPushes() const;
 370
 371     void SetDestination(const CTxDestination& address);
 372     void SetAddress(const CBitcoinAddress& dest);
 373     void SetMultisig(int nRequired, const std::vector<CPubKey>& keys);
 374
 375     void PrintHex() const;
 376     std::string ToString(bool fShort=false) const;
 377     void print() const;
 378     CScriptID GetID() const;
 379 };
 380
 381 bool IsCanonicalPubKey(const std::vector<unsigned char> &vchPubKey, unsigned int flags);
 382 bool IsDERSignature(const valtype &vchSig, bool fWithHashType=false, bool fCheckLow=false);
 383 bool IsCanonicalSignature(const std::vector<unsigned char> &vchSig, unsigned int flags);
 384
 385 bool EvalScript(std::vector<std::vector<unsigned char> >& stack, const CScript& script, const CTransaction& txTo, uint32_t nIn, unsigned int flags, int nHashType);
 386 bool Solver(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<std::vector<unsigned char> >& vSolutionsRet);
 387 int ScriptSigArgsExpected(txnouttype t, const std::vector<std::vector<unsigned char> >& vSolutions);
 388 bool IsStandard(const CScript& scriptPubKey, txnouttype& whichType);
 389 isminetype IsMine(const CKeyStore& keystore, const CScript& scriptPubKey);
 390 //isminetype IsMine(const CKeyStore& keystore, const CTxDestination& dest);
 391 isminetype IsMine(const CKeyStore& keystore, const CBitcoinAddress& dest);
 392 void ExtractAffectedKeys(const CKeyStore &keystore, const CScript& scriptPubKey, std::vector<CKeyID> &vKeys);
 393 bool ExtractDestination(const CScript& scriptPubKey, CTxDestination& addressRet);
 394 bool ExtractAddress(const CKeyStore &keystore, const CScript& scriptPubKey, CBitcoinAddress& addressRet);
 395 bool ExtractDestinations(const CScript& scriptPubKey, txnouttype& typeRet, std::vector<CTxDestination>& addressRet, int& nRequiredRet);
 396 bool SignSignature(const CKeyStore& keystore, const CScript& fromPubKey, CTransaction& txTo, uint32_t nIn, int nHashType=SIGHASH_ALL);
 397 bool SignSignature(const CKeyStore& keystore, const CTransaction& txFrom, CTransaction& txTo, uint32_t nIn, int nHashType=SIGHASH_ALL);
 398 bool VerifyScript(const CScript& scriptSig, const CScript& scriptPubKey, const CTransaction& txTo, uint32_t nIn, unsigned int flags, int nHashType);
 399
 400 // Given two sets of signatures for scriptPubKey, possibly with OP_0 placeholders,
 401 // combine them intelligently and return the result.
 402 CScript CombineSignatures(const CScript& scriptPubKey, const CTransaction& txTo, uint32_t nIn, const CScript& scriptSig1, const CScript& scriptSig2);
 403
 404 #endif