1  // Copyright (c) 2009-2022 The Bitcoin Core developers
  2  // Distributed under the MIT software license, see the accompanying
  3  // file COPYING or http://www.opensource.org/licenses/mit-license.php.
  4  
  5  #include <core_io.h>
  6  
  7  #include <common/system.h>
  8  #include <consensus/amount.h>
  9  #include <consensus/consensus.h>
 10  #include <consensus/validation.h>
 11  #include <key_io.h>
 12  #include <script/descriptor.h>
 13  #include <script/script.h>
 14  #include <script/solver.h>
 15  #include <serialize.h>
 16  #include <streams.h>
 17  #include <undo.h>
 18  #include <univalue.h>
 19  #include <util/check.h>
 20  #include <util/strencodings.h>
 21  
 22  #include <map>
 23  #include <string>
 24  #include <vector>
 25  
 26  UniValue ValueFromAmount(const CAmount amount)
 27  {
 28      static_assert(COIN > 1);
 29      int64_t quotient = amount / COIN;
 30      int64_t remainder = amount % COIN;
 31      if (amount < 0) {
 32          quotient = -quotient;
 33          remainder = -remainder;
 34      }
 35      return UniValue(UniValue::VNUM,
 36              strprintf("%s%d.%08d", amount < 0 ? "-" : "", quotient, remainder));
 37  }
 38  
 39  std::string FormatScript(const CScript& script)
 40  {
 41      std::string ret;
 42      CScript::const_iterator it = script.begin();
 43      opcodetype op;
 44      while (it != script.end()) {
 45          CScript::const_iterator it2 = it;
 46          std::vector<unsigned char> vch;
 47          if (script.GetOp(it, op, vch)) {
 48              if (op == OP_0) {
 49                  ret += "0 ";
 50                  continue;
 51              } else if ((op >= OP_1 && op <= OP_16) || op == OP_1NEGATE) {
 52                  ret += strprintf("%i ", op - OP_1NEGATE - 1);
 53                  continue;
 54              } else if (op >= OP_NOP && op <= OP_NOP10) {
 55                  std::string str(GetOpName(op));
 56                  if (str.substr(0, 3) == std::string("OP_")) {
 57                      ret += str.substr(3, std::string::npos) + " ";
 58                      continue;
 59                  }
 60              }
 61              if (vch.size() > 0) {
 62                  ret += strprintf("0x%x 0x%x ", HexStr(std::vector<uint8_t>(it2, it - vch.size())),
 63                                                 HexStr(std::vector<uint8_t>(it - vch.size(), it)));
 64              } else {
 65                  ret += strprintf("0x%x ", HexStr(std::vector<uint8_t>(it2, it)));
 66              }
 67              continue;
 68          }
 69          ret += strprintf("0x%x ", HexStr(std::vector<uint8_t>(it2, script.end())));
 70          break;
 71      }
 72      return ret.substr(0, ret.empty() ? ret.npos : ret.size() - 1);
 73  }
 74  
 75  const std::map<unsigned char, std::string> mapSigHashTypes = {
 76      {static_cast<unsigned char>(SIGHASH_ALL), std::string("ALL")},
 77      {static_cast<unsigned char>(SIGHASH_ALL|SIGHASH_ANYONECANPAY), std::string("ALL|ANYONECANPAY")},
 78      {static_cast<unsigned char>(SIGHASH_NONE), std::string("NONE")},
 79      {static_cast<unsigned char>(SIGHASH_NONE|SIGHASH_ANYONECANPAY), std::string("NONE|ANYONECANPAY")},
 80      {static_cast<unsigned char>(SIGHASH_SINGLE), std::string("SINGLE")},
 81      {static_cast<unsigned char>(SIGHASH_SINGLE|SIGHASH_ANYONECANPAY), std::string("SINGLE|ANYONECANPAY")},
 82  };
 83  
 84  std::string SighashToStr(unsigned char sighash_type)
 85  {
 86      const auto& it = mapSigHashTypes.find(sighash_type);
 87      if (it == mapSigHashTypes.end()) return "";
 88      return it->second;
 89  }
 90  
 91  /**
 92   * Create the assembly string representation of a CScript object.
 93   * @param[in] script    CScript object to convert into the asm string representation.
 94   * @param[in] fAttemptSighashDecode    Whether to attempt to decode sighash types on data within the script that matches the format
 95   *                                     of a signature. Only pass true for scripts you believe could contain signatures. For example,
 96   *                                     pass false, or omit the this argument (defaults to false), for scriptPubKeys.
 97   */
 98  std::string ScriptToAsmStr(const CScript& script, const bool fAttemptSighashDecode)
 99  {
100      std::string str;
101      opcodetype opcode;
102      std::vector<unsigned char> vch;
103      CScript::const_iterator pc = script.begin();
104      while (pc < script.end()) {
105          if (!str.empty()) {
106              str += " ";
107          }
108          if (!script.GetOp(pc, opcode, vch)) {
109              str += "[error]";
110              return str;
111          }
112          if (0 <= opcode && opcode <= OP_PUSHDATA4) {
113              if (vch.size() <= static_cast<std::vector<unsigned char>::size_type>(4)) {
114                  str += strprintf("%d", CScriptNum(vch, false).getint());
115              } else {
116                  // the IsUnspendable check makes sure not to try to decode OP_RETURN data that may match the format of a signature
117                  if (fAttemptSighashDecode && !script.IsUnspendable()) {
118                      std::string strSigHashDecode;
119                      // goal: only attempt to decode a defined sighash type from data that looks like a signature within a scriptSig.
120                      // this won't decode correctly formatted public keys in Pubkey or Multisig scripts due to
121                      // the restrictions on the pubkey formats (see IsCompressedOrUncompressedPubKey) being incongruous with the
122                      // checks in CheckSignatureEncoding.
123                      if (CheckSignatureEncoding(vch, SCRIPT_VERIFY_STRICTENC, nullptr)) {
124                          const unsigned char chSigHashType = vch.back();
125                          const auto it = mapSigHashTypes.find(chSigHashType);
126                          if (it != mapSigHashTypes.end()) {
127                              strSigHashDecode = "[" + it->second + "]";
128                              vch.pop_back(); // remove the sighash type byte. it will be replaced by the decode.
129                          }
130                      }
131                      str += HexStr(vch) + strSigHashDecode;
132                  } else {
133                      str += HexStr(vch);
134                  }
135              }
136          } else {
137              str += GetOpName(opcode);
138          }
139      }
140      return str;
141  }
142  
143  std::string EncodeHexTx(const CTransaction& tx)
144  {
145      DataStream ssTx;
146      ssTx << TX_WITH_WITNESS(tx);
147      return HexStr(ssTx);
148  }
149  
150  void ScriptToUniv(const CScript& script, UniValue& out, bool include_hex, bool include_address, const SigningProvider* provider)
151  {
152      CTxDestination address;
153  
154      out.pushKV("asm", ScriptToAsmStr(script));
155      if (include_address) {
156          out.pushKV("desc", InferDescriptor(script, provider ? *provider : DUMMY_SIGNING_PROVIDER)->ToString());
157      }
158      if (include_hex) {
159          out.pushKV("hex", HexStr(script));
160      }
161  
162      std::vector<std::vector<unsigned char>> solns;
163      const TxoutType type{Solver(script, solns)};
164  
165      if (include_address && ExtractDestination(script, address) && type != TxoutType::PUBKEY) {
166          out.pushKV("address", EncodeDestination(address));
167      }
168      out.pushKV("type", GetTxnOutputType(type));
169  }
170  
171  void TxToUniv(const CTransaction& tx, const uint256& block_hash, UniValue& entry, bool include_hex, const CTxUndo* txundo, TxVerbosity verbosity)
172  {
173      CHECK_NONFATAL(verbosity >= TxVerbosity::SHOW_DETAILS);
174  
175      entry.pushKV("txid", tx.GetHash().GetHex());
176      entry.pushKV("hash", tx.GetWitnessHash().GetHex());
177      entry.pushKV("version", tx.version);
178      entry.pushKV("size", tx.GetTotalSize());
179      entry.pushKV("vsize", (GetTransactionWeight(tx) + WITNESS_SCALE_FACTOR - 1) / WITNESS_SCALE_FACTOR);
180      entry.pushKV("weight", GetTransactionWeight(tx));
181      entry.pushKV("locktime", (int64_t)tx.nLockTime);
182  
183      UniValue vin{UniValue::VARR};
184  
185      // If available, use Undo data to calculate the fee. Note that txundo == nullptr
186      // for coinbase transactions and for transactions where undo data is unavailable.
187      const bool have_undo = txundo != nullptr;
188      CAmount amt_total_in = 0;
189      CAmount amt_total_out = 0;
190  
191      for (unsigned int i = 0; i < tx.vin.size(); i++) {
192          const CTxIn& txin = tx.vin[i];
193          UniValue in(UniValue::VOBJ);
194          if (tx.IsCoinBase()) {
195              in.pushKV("coinbase", HexStr(txin.scriptSig));
196          } else {
197              in.pushKV("txid", txin.prevout.hash.GetHex());
198              in.pushKV("vout", (int64_t)txin.prevout.n);
199              UniValue o(UniValue::VOBJ);
200              o.pushKV("asm", ScriptToAsmStr(txin.scriptSig, true));
201              o.pushKV("hex", HexStr(txin.scriptSig));
202              in.pushKV("scriptSig", std::move(o));
203          }
204          if (!tx.vin[i].scriptWitness.IsNull()) {
205              UniValue txinwitness(UniValue::VARR);
206              for (const auto& item : tx.vin[i].scriptWitness.stack) {
207                  txinwitness.push_back(HexStr(item));
208              }
209              in.pushKV("txinwitness", std::move(txinwitness));
210          }
211          if (have_undo) {
212              const Coin& prev_coin = txundo->vprevout[i];
213              const CTxOut& prev_txout = prev_coin.out;
214  
215              amt_total_in += prev_txout.nValue;
216  
217              if (verbosity == TxVerbosity::SHOW_DETAILS_AND_PREVOUT) {
218                  UniValue o_script_pub_key(UniValue::VOBJ);
219                  ScriptToUniv(prev_txout.scriptPubKey, /*out=*/o_script_pub_key, /*include_hex=*/true, /*include_address=*/true);
220  
221                  UniValue p(UniValue::VOBJ);
222                  p.pushKV("generated", bool(prev_coin.fCoinBase));
223                  p.pushKV("height", uint64_t(prev_coin.nHeight));
224                  p.pushKV("value", ValueFromAmount(prev_txout.nValue));
225                  p.pushKV("scriptPubKey", std::move(o_script_pub_key));
226                  in.pushKV("prevout", std::move(p));
227              }
228          }
229          in.pushKV("sequence", (int64_t)txin.nSequence);
230          vin.push_back(std::move(in));
231      }
232      entry.pushKV("vin", std::move(vin));
233  
234      UniValue vout(UniValue::VARR);
235      for (unsigned int i = 0; i < tx.vout.size(); i++) {
236          const CTxOut& txout = tx.vout[i];
237  
238          UniValue out(UniValue::VOBJ);
239  
240          out.pushKV("value", ValueFromAmount(txout.nValue));
241          out.pushKV("n", (int64_t)i);
242  
243          UniValue o(UniValue::VOBJ);
244          ScriptToUniv(txout.scriptPubKey, /*out=*/o, /*include_hex=*/true, /*include_address=*/true);
245          out.pushKV("scriptPubKey", std::move(o));
246          vout.push_back(std::move(out));
247  
248          if (have_undo) {
249              amt_total_out += txout.nValue;
250          }
251      }
252      entry.pushKV("vout", std::move(vout));
253  
254      if (have_undo) {
255          const CAmount fee = amt_total_in - amt_total_out;
256          CHECK_NONFATAL(MoneyRange(fee));
257          entry.pushKV("fee", ValueFromAmount(fee));
258      }
259  
260      if (!block_hash.IsNull()) {
261          entry.pushKV("blockhash", block_hash.GetHex());
262      }
263  
264      if (include_hex) {
265          entry.pushKV("hex", EncodeHexTx(tx)); // The hex-encoded transaction. Used the name "hex" to be consistent with the verbose output of "getrawtransaction".
266      }
267  }