/Users/eugenesiegel/btc/bitcoin/src/rpc/rawtransaction_util.cpp
Line | Count | Source (jump to first uncovered line) |
1 | | // Copyright (c) 2010 Satoshi Nakamoto |
2 | | // Copyright (c) 2009-2022 The Bitcoin Core developers |
3 | | // Distributed under the MIT software license, see the accompanying |
4 | | // file COPYING or http://www.opensource.org/licenses/mit-license.php. |
5 | | |
6 | | #include <rpc/rawtransaction_util.h> |
7 | | |
8 | | #include <coins.h> |
9 | | #include <consensus/amount.h> |
10 | | #include <core_io.h> |
11 | | #include <key_io.h> |
12 | | #include <policy/policy.h> |
13 | | #include <primitives/transaction.h> |
14 | | #include <rpc/request.h> |
15 | | #include <rpc/util.h> |
16 | | #include <script/sign.h> |
17 | | #include <script/signingprovider.h> |
18 | | #include <tinyformat.h> |
19 | | #include <univalue.h> |
20 | | #include <util/rbf.h> |
21 | | #include <util/strencodings.h> |
22 | | #include <util/translation.h> |
23 | | |
24 | | void AddInputs(CMutableTransaction& rawTx, const UniValue& inputs_in, std::optional<bool> rbf) |
25 | 0 | { |
26 | 0 | UniValue inputs; |
27 | 0 | if (inputs_in.isNull()) { |
28 | 0 | inputs = UniValue::VARR; |
29 | 0 | } else { |
30 | 0 | inputs = inputs_in.get_array(); |
31 | 0 | } |
32 | |
|
33 | 0 | for (unsigned int idx = 0; idx < inputs.size(); idx++) { |
34 | 0 | const UniValue& input = inputs[idx]; |
35 | 0 | const UniValue& o = input.get_obj(); |
36 | |
|
37 | 0 | Txid txid = Txid::FromUint256(ParseHashO(o, "txid")); |
38 | |
|
39 | 0 | const UniValue& vout_v = o.find_value("vout"); |
40 | 0 | if (!vout_v.isNum()) |
41 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, missing vout key"); |
42 | 0 | int nOutput = vout_v.getInt<int>(); |
43 | 0 | if (nOutput < 0) |
44 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative"); |
45 | | |
46 | 0 | uint32_t nSequence; |
47 | |
|
48 | 0 | if (rbf.value_or(true)) { |
49 | 0 | nSequence = MAX_BIP125_RBF_SEQUENCE; /* CTxIn::SEQUENCE_FINAL - 2 */ |
50 | 0 | } else if (rawTx.nLockTime) { |
51 | 0 | nSequence = CTxIn::MAX_SEQUENCE_NONFINAL; /* CTxIn::SEQUENCE_FINAL - 1 */ |
52 | 0 | } else { |
53 | 0 | nSequence = CTxIn::SEQUENCE_FINAL; |
54 | 0 | } |
55 | | |
56 | | // set the sequence number if passed in the parameters object |
57 | 0 | const UniValue& sequenceObj = o.find_value("sequence"); |
58 | 0 | if (sequenceObj.isNum()) { |
59 | 0 | int64_t seqNr64 = sequenceObj.getInt<int64_t>(); |
60 | 0 | if (seqNr64 < 0 || seqNr64 > CTxIn::SEQUENCE_FINAL) { |
61 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, sequence number is out of range"); |
62 | 0 | } else { |
63 | 0 | nSequence = (uint32_t)seqNr64; |
64 | 0 | } |
65 | 0 | } |
66 | | |
67 | 0 | CTxIn in(COutPoint(txid, nOutput), CScript(), nSequence); |
68 | |
|
69 | 0 | rawTx.vin.push_back(in); |
70 | 0 | } |
71 | 0 | } |
72 | | |
73 | | UniValue NormalizeOutputs(const UniValue& outputs_in) |
74 | 0 | { |
75 | 0 | if (outputs_in.isNull()) { |
76 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, output argument must be non-null"); |
77 | 0 | } |
78 | | |
79 | 0 | const bool outputs_is_obj = outputs_in.isObject(); |
80 | 0 | UniValue outputs = outputs_is_obj ? outputs_in.get_obj() : outputs_in.get_array(); |
81 | |
|
82 | 0 | if (!outputs_is_obj) { |
83 | | // Translate array of key-value pairs into dict |
84 | 0 | UniValue outputs_dict = UniValue(UniValue::VOBJ); |
85 | 0 | for (size_t i = 0; i < outputs.size(); ++i) { |
86 | 0 | const UniValue& output = outputs[i]; |
87 | 0 | if (!output.isObject()) { |
88 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, key-value pair not an object as expected"); |
89 | 0 | } |
90 | 0 | if (output.size() != 1) { |
91 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, key-value pair must contain exactly one key"); |
92 | 0 | } |
93 | 0 | outputs_dict.pushKVs(output); |
94 | 0 | } |
95 | 0 | outputs = std::move(outputs_dict); |
96 | 0 | } |
97 | 0 | return outputs; |
98 | 0 | } |
99 | | |
100 | | std::vector<std::pair<CTxDestination, CAmount>> ParseOutputs(const UniValue& outputs) |
101 | 0 | { |
102 | | // Duplicate checking |
103 | 0 | std::set<CTxDestination> destinations; |
104 | 0 | std::vector<std::pair<CTxDestination, CAmount>> parsed_outputs; |
105 | 0 | bool has_data{false}; |
106 | 0 | for (const std::string& name_ : outputs.getKeys()) { |
107 | 0 | if (name_ == "data") { |
108 | 0 | if (has_data) { |
109 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, duplicate key: data"); |
110 | 0 | } |
111 | 0 | has_data = true; |
112 | 0 | std::vector<unsigned char> data = ParseHexV(outputs[name_].getValStr(), "Data"); |
113 | 0 | CTxDestination destination{CNoDestination{CScript() << OP_RETURN << data}}; |
114 | 0 | CAmount amount{0}; |
115 | 0 | parsed_outputs.emplace_back(destination, amount); |
116 | 0 | } else { |
117 | 0 | CTxDestination destination{DecodeDestination(name_)}; |
118 | 0 | CAmount amount{AmountFromValue(outputs[name_])}; |
119 | 0 | if (!IsValidDestination(destination)) { |
120 | 0 | throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, std::string("Invalid Bitcoin address: ") + name_); |
121 | 0 | } |
122 | | |
123 | 0 | if (!destinations.insert(destination).second) { |
124 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, std::string("Invalid parameter, duplicated address: ") + name_); |
125 | 0 | } |
126 | 0 | parsed_outputs.emplace_back(destination, amount); |
127 | 0 | } |
128 | 0 | } |
129 | 0 | return parsed_outputs; |
130 | 0 | } |
131 | | |
132 | | void AddOutputs(CMutableTransaction& rawTx, const UniValue& outputs_in) |
133 | 0 | { |
134 | 0 | UniValue outputs(UniValue::VOBJ); |
135 | 0 | outputs = NormalizeOutputs(outputs_in); |
136 | |
|
137 | 0 | std::vector<std::pair<CTxDestination, CAmount>> parsed_outputs = ParseOutputs(outputs); |
138 | 0 | for (const auto& [destination, nAmount] : parsed_outputs) { |
139 | 0 | CScript scriptPubKey = GetScriptForDestination(destination); |
140 | |
|
141 | 0 | CTxOut out(nAmount, scriptPubKey); |
142 | 0 | rawTx.vout.push_back(out); |
143 | 0 | } |
144 | 0 | } |
145 | | |
146 | | CMutableTransaction ConstructTransaction(const UniValue& inputs_in, const UniValue& outputs_in, const UniValue& locktime, std::optional<bool> rbf) |
147 | 0 | { |
148 | 0 | CMutableTransaction rawTx; |
149 | |
|
150 | 0 | if (!locktime.isNull()) { |
151 | 0 | int64_t nLockTime = locktime.getInt<int64_t>(); |
152 | 0 | if (nLockTime < 0 || nLockTime > LOCKTIME_MAX) |
153 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, locktime out of range"); |
154 | 0 | rawTx.nLockTime = nLockTime; |
155 | 0 | } |
156 | | |
157 | 0 | AddInputs(rawTx, inputs_in, rbf); |
158 | 0 | AddOutputs(rawTx, outputs_in); |
159 | |
|
160 | 0 | if (rbf.has_value() && rbf.value() && rawTx.vin.size() > 0 && !SignalsOptInRBF(CTransaction(rawTx))) { |
161 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter combination: Sequence number(s) contradict replaceable option"); |
162 | 0 | } |
163 | | |
164 | 0 | return rawTx; |
165 | 0 | } |
166 | | |
167 | | /** Pushes a JSON object for script verification or signing errors to vErrorsRet. */ |
168 | | static void TxInErrorToJSON(const CTxIn& txin, UniValue& vErrorsRet, const std::string& strMessage) |
169 | 0 | { |
170 | 0 | UniValue entry(UniValue::VOBJ); |
171 | 0 | entry.pushKV("txid", txin.prevout.hash.ToString()); |
172 | 0 | entry.pushKV("vout", (uint64_t)txin.prevout.n); |
173 | 0 | UniValue witness(UniValue::VARR); |
174 | 0 | for (unsigned int i = 0; i < txin.scriptWitness.stack.size(); i++) { |
175 | 0 | witness.push_back(HexStr(txin.scriptWitness.stack[i])); |
176 | 0 | } |
177 | 0 | entry.pushKV("witness", std::move(witness)); |
178 | 0 | entry.pushKV("scriptSig", HexStr(txin.scriptSig)); |
179 | 0 | entry.pushKV("sequence", (uint64_t)txin.nSequence); |
180 | 0 | entry.pushKV("error", strMessage); |
181 | 0 | vErrorsRet.push_back(std::move(entry)); |
182 | 0 | } |
183 | | |
184 | | void ParsePrevouts(const UniValue& prevTxsUnival, FlatSigningProvider* keystore, std::map<COutPoint, Coin>& coins) |
185 | 0 | { |
186 | 0 | if (!prevTxsUnival.isNull()) { |
187 | 0 | const UniValue& prevTxs = prevTxsUnival.get_array(); |
188 | 0 | for (unsigned int idx = 0; idx < prevTxs.size(); ++idx) { |
189 | 0 | const UniValue& p = prevTxs[idx]; |
190 | 0 | if (!p.isObject()) { |
191 | 0 | throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "expected object with {\"txid'\",\"vout\",\"scriptPubKey\"}"); |
192 | 0 | } |
193 | | |
194 | 0 | const UniValue& prevOut = p.get_obj(); |
195 | |
|
196 | 0 | RPCTypeCheckObj(prevOut, |
197 | 0 | { |
198 | 0 | {"txid", UniValueType(UniValue::VSTR)}, |
199 | 0 | {"vout", UniValueType(UniValue::VNUM)}, |
200 | 0 | {"scriptPubKey", UniValueType(UniValue::VSTR)}, |
201 | 0 | }); |
202 | |
|
203 | 0 | Txid txid = Txid::FromUint256(ParseHashO(prevOut, "txid")); |
204 | |
|
205 | 0 | int nOut = prevOut.find_value("vout").getInt<int>(); |
206 | 0 | if (nOut < 0) { |
207 | 0 | throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "vout cannot be negative"); |
208 | 0 | } |
209 | | |
210 | 0 | COutPoint out(txid, nOut); |
211 | 0 | std::vector<unsigned char> pkData(ParseHexO(prevOut, "scriptPubKey")); |
212 | 0 | CScript scriptPubKey(pkData.begin(), pkData.end()); |
213 | |
|
214 | 0 | { |
215 | 0 | auto coin = coins.find(out); |
216 | 0 | if (coin != coins.end() && !coin->second.IsSpent() && coin->second.out.scriptPubKey != scriptPubKey) { |
217 | 0 | std::string err("Previous output scriptPubKey mismatch:\n"); |
218 | 0 | err = err + ScriptToAsmStr(coin->second.out.scriptPubKey) + "\nvs:\n"+ |
219 | 0 | ScriptToAsmStr(scriptPubKey); |
220 | 0 | throw JSONRPCError(RPC_DESERIALIZATION_ERROR, err); |
221 | 0 | } |
222 | 0 | Coin newcoin; |
223 | 0 | newcoin.out.scriptPubKey = scriptPubKey; |
224 | 0 | newcoin.out.nValue = MAX_MONEY; |
225 | 0 | if (prevOut.exists("amount")) { |
226 | 0 | newcoin.out.nValue = AmountFromValue(prevOut.find_value("amount")); |
227 | 0 | } |
228 | 0 | newcoin.nHeight = 1; |
229 | 0 | coins[out] = std::move(newcoin); |
230 | 0 | } |
231 | | |
232 | | // if redeemScript and private keys were given, add redeemScript to the keystore so it can be signed |
233 | 0 | const bool is_p2sh = scriptPubKey.IsPayToScriptHash(); |
234 | 0 | const bool is_p2wsh = scriptPubKey.IsPayToWitnessScriptHash(); |
235 | 0 | if (keystore && (is_p2sh || is_p2wsh)) { |
236 | 0 | RPCTypeCheckObj(prevOut, |
237 | 0 | { |
238 | 0 | {"redeemScript", UniValueType(UniValue::VSTR)}, |
239 | 0 | {"witnessScript", UniValueType(UniValue::VSTR)}, |
240 | 0 | }, true); |
241 | 0 | const UniValue& rs{prevOut.find_value("redeemScript")}; |
242 | 0 | const UniValue& ws{prevOut.find_value("witnessScript")}; |
243 | 0 | if (rs.isNull() && ws.isNull()) { |
244 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "Missing redeemScript/witnessScript"); |
245 | 0 | } |
246 | | |
247 | | // work from witnessScript when possible |
248 | 0 | std::vector<unsigned char> scriptData(!ws.isNull() ? ParseHexV(ws, "witnessScript") : ParseHexV(rs, "redeemScript")); |
249 | 0 | CScript script(scriptData.begin(), scriptData.end()); |
250 | 0 | keystore->scripts.emplace(CScriptID(script), script); |
251 | | // Automatically also add the P2WSH wrapped version of the script (to deal with P2SH-P2WSH). |
252 | | // This is done for redeemScript only for compatibility, it is encouraged to use the explicit witnessScript field instead. |
253 | 0 | CScript witness_output_script{GetScriptForDestination(WitnessV0ScriptHash(script))}; |
254 | 0 | keystore->scripts.emplace(CScriptID(witness_output_script), witness_output_script); |
255 | |
|
256 | 0 | if (!ws.isNull() && !rs.isNull()) { |
257 | | // if both witnessScript and redeemScript are provided, |
258 | | // they should either be the same (for backwards compat), |
259 | | // or the redeemScript should be the encoded form of |
260 | | // the witnessScript (ie, for p2sh-p2wsh) |
261 | 0 | if (ws.get_str() != rs.get_str()) { |
262 | 0 | std::vector<unsigned char> redeemScriptData(ParseHexV(rs, "redeemScript")); |
263 | 0 | CScript redeemScript(redeemScriptData.begin(), redeemScriptData.end()); |
264 | 0 | if (redeemScript != witness_output_script) { |
265 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "redeemScript does not correspond to witnessScript"); |
266 | 0 | } |
267 | 0 | } |
268 | 0 | } |
269 | | |
270 | 0 | if (is_p2sh) { |
271 | 0 | const CTxDestination p2sh{ScriptHash(script)}; |
272 | 0 | const CTxDestination p2sh_p2wsh{ScriptHash(witness_output_script)}; |
273 | 0 | if (scriptPubKey == GetScriptForDestination(p2sh)) { |
274 | | // traditional p2sh; arguably an error if |
275 | | // we got here with rs.IsNull(), because |
276 | | // that means the p2sh script was specified |
277 | | // via witnessScript param, but for now |
278 | | // we'll just quietly accept it |
279 | 0 | } else if (scriptPubKey == GetScriptForDestination(p2sh_p2wsh)) { |
280 | | // p2wsh encoded as p2sh; ideally the witness |
281 | | // script was specified in the witnessScript |
282 | | // param, but also support specifying it via |
283 | | // redeemScript param for backwards compat |
284 | | // (in which case ws.IsNull() == true) |
285 | 0 | } else { |
286 | | // otherwise, can't generate scriptPubKey from |
287 | | // either script, so we got unusable parameters |
288 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "redeemScript/witnessScript does not match scriptPubKey"); |
289 | 0 | } |
290 | 0 | } else if (is_p2wsh) { |
291 | | // plain p2wsh; could throw an error if script |
292 | | // was specified by redeemScript rather than |
293 | | // witnessScript (ie, ws.IsNull() == true), but |
294 | | // accept it for backwards compat |
295 | 0 | const CTxDestination p2wsh{WitnessV0ScriptHash(script)}; |
296 | 0 | if (scriptPubKey != GetScriptForDestination(p2wsh)) { |
297 | 0 | throw JSONRPCError(RPC_INVALID_PARAMETER, "redeemScript/witnessScript does not match scriptPubKey"); |
298 | 0 | } |
299 | 0 | } |
300 | 0 | } |
301 | 0 | } |
302 | 0 | } |
303 | 0 | } |
304 | | |
305 | | void SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType, UniValue& result) |
306 | 0 | { |
307 | 0 | int nHashType = ParseSighashString(hashType); |
308 | | |
309 | | // Script verification errors |
310 | 0 | std::map<int, bilingual_str> input_errors; |
311 | |
|
312 | 0 | bool complete = SignTransaction(mtx, keystore, coins, nHashType, input_errors); |
313 | 0 | SignTransactionResultToJSON(mtx, complete, coins, input_errors, result); |
314 | 0 | } |
315 | | |
316 | | void SignTransactionResultToJSON(CMutableTransaction& mtx, bool complete, const std::map<COutPoint, Coin>& coins, const std::map<int, bilingual_str>& input_errors, UniValue& result) |
317 | 0 | { |
318 | | // Make errors UniValue |
319 | 0 | UniValue vErrors(UniValue::VARR); |
320 | 0 | for (const auto& err_pair : input_errors) { |
321 | 0 | if (err_pair.second.original == "Missing amount") { |
322 | | // This particular error needs to be an exception for some reason |
323 | 0 | throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Missing amount for %s", coins.at(mtx.vin.at(err_pair.first).prevout).out.ToString())); Line | Count | Source | 1172 | 0 | #define strprintf tfm::format |
|
324 | 0 | } |
325 | 0 | TxInErrorToJSON(mtx.vin.at(err_pair.first), vErrors, err_pair.second.original); |
326 | 0 | } |
327 | | |
328 | 0 | result.pushKV("hex", EncodeHexTx(CTransaction(mtx))); |
329 | 0 | result.pushKV("complete", complete); |
330 | 0 | if (!vErrors.empty()) { |
331 | 0 | if (result.exists("errors")) { |
332 | 0 | vErrors.push_backV(result["errors"].getValues()); |
333 | 0 | } |
334 | 0 | result.pushKV("errors", std::move(vErrors)); |
335 | 0 | } |
336 | 0 | } |