Branch data Line data Source code
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 : 124 : UniValue ValueFromAmount(const CAmount amount)
27 : : {
28 : 124 : static_assert(COIN > 1);
29 : 124 : int64_t quotient = amount / COIN;
30 : 124 : int64_t remainder = amount % COIN;
31 [ + + ]: 124 : if (amount < 0) {
32 : 6 : quotient = -quotient;
33 : 6 : remainder = -remainder;
34 : : }
35 : 6 : return UniValue(UniValue::VNUM,
36 : 124 : strprintf("%s%d.%08d", amount < 0 ? "-" : "", quotient, remainder));
37 : : }
38 : :
39 : 268 : std::string FormatScript(const CScript& script)
40 : : {
41 [ + + ]: 268 : std::string ret;
42 [ + + ]: 536 : CScript::const_iterator it = script.begin();
43 : : opcodetype op;
44 [ + + ]: 867 : while (it != script.end()) {
45 : 599 : CScript::const_iterator it2 = it;
46 : 599 : std::vector<unsigned char> vch;
47 [ + - + - ]: 599 : if (script.GetOp(it, op, vch)) {
48 [ + + ]: 599 : if (op == OP_0) {
49 [ + - ]: 63 : ret += "0 ";
50 : 63 : continue;
51 [ + + - + ]: 536 : } else if ((op >= OP_1 && op <= OP_16) || op == OP_1NEGATE) {
52 [ + - ]: 126 : ret += strprintf("%i ", op - OP_1NEGATE - 1);
53 : 63 : continue;
54 [ + + ]: 473 : } else if (op >= OP_NOP && op <= OP_NOP10) {
55 [ + - ]: 178 : std::string str(GetOpName(op));
56 [ + - + - : 178 : if (str.substr(0, 3) == std::string("OP_")) {
+ - ]
57 [ + - + - ]: 534 : ret += str.substr(3, std::string::npos) + " ";
58 : 178 : continue;
59 : : }
60 : 178 : }
61 [ + - ]: 295 : if (vch.size() > 0) {
62 [ + - + - : 885 : ret += strprintf("0x%x 0x%x ", HexStr(std::vector<uint8_t>(it2, it - vch.size())),
+ - + - ]
63 [ + - + - ]: 885 : HexStr(std::vector<uint8_t>(it - vch.size(), it)));
64 : : } else {
65 [ # # # # : 0 : ret += strprintf("0x%x ", HexStr(std::vector<uint8_t>(it2, it)));
# # ]
66 : : }
67 : 295 : continue;
68 : 295 : }
69 [ # # # # : 0 : ret += strprintf("0x%x ", HexStr(std::vector<uint8_t>(it2, script.end())));
# # ]
70 : 0 : break;
71 : 599 : }
72 [ + + + - ]: 268 : return ret.substr(0, ret.empty() ? ret.npos : ret.size() - 1);
73 : 268 : }
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 : 0 : std::string SighashToStr(unsigned char sighash_type)
85 : : {
86 : 0 : const auto& it = mapSigHashTypes.find(sighash_type);
87 [ # # ]: 0 : if (it == mapSigHashTypes.end()) return "";
88 : 0 : 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 : 123 : std::string ScriptToAsmStr(const CScript& script, const bool fAttemptSighashDecode)
99 : : {
100 [ + + ]: 123 : std::string str;
101 : 123 : opcodetype opcode;
102 : 123 : std::vector<unsigned char> vch;
103 [ + + ]: 246 : CScript::const_iterator pc = script.begin();
104 [ + + ]: 396 : while (pc < script.end()) {
105 [ + + ]: 273 : if (!str.empty()) {
106 [ + - ]: 160 : str += " ";
107 : : }
108 [ + - - + ]: 273 : if (!script.GetOp(pc, opcode, vch)) {
109 [ - - ]: 123 : str += "[error]";
110 : : return str;
111 : : }
112 [ + + ]: 273 : if (0 <= opcode && opcode <= OP_PUSHDATA4) {
113 [ + + ]: 194 : if (vch.size() <= static_cast<std::vector<unsigned char>::size_type>(4)) {
114 [ + - + - ]: 9 : 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 [ + + + - ]: 191 : if (fAttemptSighashDecode && !script.IsUnspendable()) {
118 [ + - ]: 146 : 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 [ + - + + ]: 146 : if (CheckSignatureEncoding(vch, SCRIPT_VERIFY_STRICTENC, nullptr)) {
124 : 71 : const unsigned char chSigHashType = vch.back();
125 : 71 : const auto it = mapSigHashTypes.find(chSigHashType);
126 [ + - ]: 71 : if (it != mapSigHashTypes.end()) {
127 [ + - ]: 142 : strSigHashDecode = "[" + it->second + "]";
128 : 71 : vch.pop_back(); // remove the sighash type byte. it will be replaced by the decode.
129 : : }
130 : : }
131 [ + - + - ]: 292 : str += HexStr(vch) + strSigHashDecode;
132 : 146 : } else {
133 [ + - ]: 90 : str += HexStr(vch);
134 : : }
135 : : }
136 : : } else {
137 [ + - ]: 158 : str += GetOpName(opcode);
138 : : }
139 : : }
140 : : return str;
141 : 123 : }
142 : :
143 : 66 : std::string EncodeHexTx(const CTransaction& tx)
144 : : {
145 : 66 : DataStream ssTx;
146 [ + - ]: 66 : ssTx << TX_WITH_WITNESS(tx);
147 [ + - ]: 66 : return HexStr(ssTx);
148 : 66 : }
149 : :
150 : 30 : void ScriptToUniv(const CScript& script, UniValue& out, bool include_hex, bool include_address, const SigningProvider* provider)
151 : : {
152 : 30 : CTxDestination address;
153 : :
154 [ + - + - : 60 : out.pushKV("asm", ScriptToAsmStr(script));
+ - + - ]
155 [ + - ]: 30 : if (include_address) {
156 [ + - + - : 60 : out.pushKV("desc", InferDescriptor(script, provider ? *provider : DUMMY_SIGNING_PROVIDER)->ToString());
+ - + - +
- + - ]
157 : : }
158 [ + - ]: 30 : if (include_hex) {
159 [ + + + - : 90 : out.pushKV("hex", HexStr(script));
+ - + - +
- ]
160 : : }
161 : :
162 : 30 : std::vector<std::vector<unsigned char>> solns;
163 [ + - ]: 30 : const TxoutType type{Solver(script, solns)};
164 : :
165 [ + - + - : 30 : if (include_address && ExtractDestination(script, address) && type != TxoutType::PUBKEY) {
+ + + - ]
166 [ + - + - : 46 : out.pushKV("address", EncodeDestination(address));
+ - + - ]
167 : : }
168 [ + - + - : 60 : out.pushKV("type", GetTxnOutputType(type));
+ - + - ]
169 : 30 : }
170 : :
171 : 28 : void TxToUniv(const CTransaction& tx, const uint256& block_hash, UniValue& entry, bool include_hex, const CTxUndo* txundo, TxVerbosity verbosity)
172 : : {
173 : 28 : CHECK_NONFATAL(verbosity >= TxVerbosity::SHOW_DETAILS);
174 : :
175 [ + - + - : 56 : entry.pushKV("txid", tx.GetHash().GetHex());
+ - ]
176 [ + - + - : 56 : entry.pushKV("hash", tx.GetWitnessHash().GetHex());
+ - ]
177 [ + - + - ]: 56 : entry.pushKV("version", tx.version);
178 [ + - + - ]: 56 : entry.pushKV("size", tx.GetTotalSize());
179 [ + - + - ]: 56 : entry.pushKV("vsize", (GetTransactionWeight(tx) + WITNESS_SCALE_FACTOR - 1) / WITNESS_SCALE_FACTOR);
180 [ + - + - ]: 56 : entry.pushKV("weight", GetTransactionWeight(tx));
181 [ + - + - ]: 56 : entry.pushKV("locktime", (int64_t)tx.nLockTime);
182 : :
183 : 28 : 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 : 28 : const bool have_undo = txundo != nullptr;
188 : 28 : CAmount amt_total_in = 0;
189 : 28 : CAmount amt_total_out = 0;
190 : :
191 [ + + ]: 101 : for (unsigned int i = 0; i < tx.vin.size(); i++) {
192 : 73 : const CTxIn& txin = tx.vin[i];
193 : 73 : UniValue in(UniValue::VOBJ);
194 [ - + ]: 73 : if (tx.IsCoinBase()) {
195 [ # # # # : 0 : in.pushKV("coinbase", HexStr(txin.scriptSig));
# # # # #
# ]
196 : : } else {
197 [ + - + - : 146 : in.pushKV("txid", txin.prevout.hash.GetHex());
+ - + - ]
198 [ + - + - : 146 : in.pushKV("vout", (int64_t)txin.prevout.n);
+ - ]
199 : 73 : UniValue o(UniValue::VOBJ);
200 [ + - + - : 146 : o.pushKV("asm", ScriptToAsmStr(txin.scriptSig, true));
+ - + - ]
201 [ + + + - : 219 : o.pushKV("hex", HexStr(txin.scriptSig));
+ - + - +
- ]
202 [ + - + - ]: 146 : in.pushKV("scriptSig", std::move(o));
203 : 73 : }
204 [ - + ]: 73 : if (!tx.vin[i].scriptWitness.IsNull()) {
205 : 0 : UniValue txinwitness(UniValue::VARR);
206 [ # # ]: 0 : for (const auto& item : tx.vin[i].scriptWitness.stack) {
207 [ # # # # : 0 : txinwitness.push_back(HexStr(item));
# # ]
208 : : }
209 [ # # # # ]: 0 : in.pushKV("txinwitness", std::move(txinwitness));
210 : 0 : }
211 [ - + ]: 73 : if (have_undo) {
212 [ # # ]: 0 : const Coin& prev_coin = txundo->vprevout[i];
213 : 0 : const CTxOut& prev_txout = prev_coin.out;
214 : :
215 : 0 : amt_total_in += prev_txout.nValue;
216 : :
217 [ # # ]: 0 : if (verbosity == TxVerbosity::SHOW_DETAILS_AND_PREVOUT) {
218 : 0 : UniValue o_script_pub_key(UniValue::VOBJ);
219 [ # # ]: 0 : ScriptToUniv(prev_txout.scriptPubKey, /*out=*/o_script_pub_key, /*include_hex=*/true, /*include_address=*/true);
220 : :
221 : 0 : UniValue p(UniValue::VOBJ);
222 [ # # # # : 0 : p.pushKV("generated", bool(prev_coin.fCoinBase));
# # ]
223 [ # # # # : 0 : p.pushKV("height", uint64_t(prev_coin.nHeight));
# # ]
224 [ # # # # : 0 : p.pushKV("value", ValueFromAmount(prev_txout.nValue));
# # ]
225 [ # # # # ]: 0 : p.pushKV("scriptPubKey", std::move(o_script_pub_key));
226 [ # # # # ]: 0 : in.pushKV("prevout", std::move(p));
227 : 0 : }
228 : : }
229 [ + - + - : 146 : in.pushKV("sequence", (int64_t)txin.nSequence);
+ - ]
230 [ + - ]: 73 : vin.push_back(std::move(in));
231 : 73 : }
232 [ + - + - ]: 56 : entry.pushKV("vin", std::move(vin));
233 : :
234 : 28 : UniValue vout(UniValue::VARR);
235 [ + + ]: 58 : for (unsigned int i = 0; i < tx.vout.size(); i++) {
236 : 30 : const CTxOut& txout = tx.vout[i];
237 : :
238 : 30 : UniValue out(UniValue::VOBJ);
239 : :
240 [ + - + - : 60 : out.pushKV("value", ValueFromAmount(txout.nValue));
+ - ]
241 [ + - + - : 60 : out.pushKV("n", (int64_t)i);
+ - ]
242 : :
243 : 30 : UniValue o(UniValue::VOBJ);
244 [ + - ]: 30 : ScriptToUniv(txout.scriptPubKey, /*out=*/o, /*include_hex=*/true, /*include_address=*/true);
245 [ + - + - ]: 60 : out.pushKV("scriptPubKey", std::move(o));
246 [ + - ]: 30 : vout.push_back(std::move(out));
247 : :
248 [ - + ]: 30 : if (have_undo) {
249 : 0 : amt_total_out += txout.nValue;
250 : : }
251 : 30 : }
252 [ + - + - ]: 56 : entry.pushKV("vout", std::move(vout));
253 : :
254 [ - + ]: 28 : if (have_undo) {
255 : 0 : const CAmount fee = amt_total_in - amt_total_out;
256 [ # # ]: 0 : CHECK_NONFATAL(MoneyRange(fee));
257 [ # # # # : 0 : entry.pushKV("fee", ValueFromAmount(fee));
# # ]
258 : : }
259 : :
260 [ - + ]: 28 : if (!block_hash.IsNull()) {
261 [ # # # # : 0 : entry.pushKV("blockhash", block_hash.GetHex());
# # # # ]
262 : : }
263 : :
264 [ + + ]: 28 : if (include_hex) {
265 [ + - + - : 52 : entry.pushKV("hex", EncodeHexTx(tx)); // The hex-encoded transaction. Used the name "hex" to be consistent with the verbose output of "getrawtransaction".
+ - + - ]
266 : : }
267 : 28 : }
|