Branch data Line data Source code
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 : 20 : void AddInputs(CMutableTransaction& rawTx, const UniValue& inputs_in, std::optional<bool> rbf)
25 : : {
26 [ - + ]: 20 : UniValue inputs;
27 [ - + ]: 20 : if (inputs_in.isNull()) {
28 : 0 : inputs = UniValue::VARR;
29 : : } else {
30 [ + - + - ]: 20 : inputs = inputs_in.get_array();
31 : : }
32 : :
33 [ + + ]: 20 : for (unsigned int idx = 0; idx < inputs.size(); idx++) {
34 [ + - ]: 17 : const UniValue& input = inputs[idx];
35 [ + + ]: 17 : const UniValue& o = input.get_obj();
36 : :
37 [ - + ]: 1 : 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 : : nSequence = MAX_BIP125_RBF_SEQUENCE; /* CTxIn::SEQUENCE_FINAL - 2 */
50 [ # # ]: 0 : } else if (rawTx.nLockTime) {
51 : : nSequence = CTxIn::MAX_SEQUENCE_NONFINAL; /* CTxIn::SEQUENCE_FINAL - 1 */
52 : : } else {
53 : 0 : nSequence = CTxIn::SEQUENCE_FINAL;
54 : : }
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 : : } else {
63 : 0 : nSequence = (uint32_t)seqNr64;
64 : : }
65 : : }
66 : :
67 [ # # ]: 0 : CTxIn in(COutPoint(txid, nOutput), CScript(), nSequence);
68 : :
69 [ # # ]: 0 : rawTx.vin.push_back(in);
70 : 0 : }
71 : 20 : }
72 : :
73 : 3 : UniValue NormalizeOutputs(const UniValue& outputs_in)
74 : : {
75 [ - + ]: 3 : if (outputs_in.isNull()) {
76 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, output argument must be non-null");
77 : : }
78 : :
79 : 3 : const bool outputs_is_obj = outputs_in.isObject();
80 [ - + ]: 3 : UniValue outputs = outputs_is_obj ? outputs_in.get_obj() : outputs_in.get_array();
81 : :
82 [ + - ]: 3 : if (!outputs_is_obj) {
83 : : // Translate array of key-value pairs into dict
84 : 3 : UniValue outputs_dict = UniValue(UniValue::VOBJ);
85 [ + + ]: 3 : for (size_t i = 0; i < outputs.size(); ++i) {
86 [ + - ]: 1 : const UniValue& output = outputs[i];
87 [ + - ]: 1 : if (!output.isObject()) {
88 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, key-value pair not an object as expected");
89 : : }
90 [ # # ]: 0 : if (output.size() != 1) {
91 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, key-value pair must contain exactly one key");
92 : : }
93 [ # # # # ]: 0 : outputs_dict.pushKVs(output);
94 : : }
95 : 2 : outputs = std::move(outputs_dict);
96 : 3 : }
97 : 2 : return outputs;
98 : 1 : }
99 : :
100 : 2 : std::vector<std::pair<CTxDestination, CAmount>> ParseOutputs(const UniValue& outputs)
101 : : {
102 : : // Duplicate checking
103 [ + - ]: 2 : std::set<CTxDestination> destinations;
104 : 2 : std::vector<std::pair<CTxDestination, CAmount>> parsed_outputs;
105 : 2 : bool has_data{false};
106 [ + - - + ]: 2 : 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 : : }
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 : : }
122 : :
123 [ # # # # ]: 0 : if (!destinations.insert(destination).second) {
124 [ # # # # : 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, std::string("Invalid parameter, duplicated address: ") + name_);
# # ]
125 : : }
126 [ # # ]: 0 : parsed_outputs.emplace_back(destination, amount);
127 : 0 : }
128 : : }
129 : 2 : return parsed_outputs;
130 : 2 : }
131 : :
132 : 3 : void AddOutputs(CMutableTransaction& rawTx, const UniValue& outputs_in)
133 : : {
134 : 3 : UniValue outputs(UniValue::VOBJ);
135 [ + + ]: 3 : outputs = NormalizeOutputs(outputs_in);
136 : :
137 [ + - ]: 2 : std::vector<std::pair<CTxDestination, CAmount>> parsed_outputs = ParseOutputs(outputs);
138 [ - - - + ]: 2 : 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 : 3 : }
145 : :
146 : 25 : CMutableTransaction ConstructTransaction(const UniValue& inputs_in, const UniValue& outputs_in, const UniValue& locktime, std::optional<bool> rbf)
147 : : {
148 : 25 : CMutableTransaction rawTx;
149 : :
150 [ + + ]: 25 : if (!locktime.isNull()) {
151 [ + + ]: 6 : int64_t nLockTime = locktime.getInt<int64_t>();
152 [ + + ]: 4 : if (nLockTime < 0 || nLockTime > LOCKTIME_MAX)
153 [ + - + - ]: 6 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, locktime out of range");
154 : 1 : rawTx.nLockTime = nLockTime;
155 : : }
156 : :
157 [ + + ]: 20 : AddInputs(rawTx, inputs_in, rbf);
158 [ + + ]: 3 : AddOutputs(rawTx, outputs_in);
159 : :
160 [ - + - - : 2 : 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 : : }
163 : :
164 : 2 : return rawTx;
165 : 23 : }
166 : :
167 : : /** Pushes a JSON object for script verification or signing errors to vErrorsRet. */
168 : 11649 : static void TxInErrorToJSON(const CTxIn& txin, UniValue& vErrorsRet, const std::string& strMessage)
169 : : {
170 : 11649 : UniValue entry(UniValue::VOBJ);
171 [ + - + - : 23298 : entry.pushKV("txid", txin.prevout.hash.ToString());
+ - + - ]
172 [ + - + - : 23298 : entry.pushKV("vout", (uint64_t)txin.prevout.n);
+ - ]
173 : 11649 : UniValue witness(UniValue::VARR);
174 [ + + ]: 18951 : for (unsigned int i = 0; i < txin.scriptWitness.stack.size(); i++) {
175 [ + - + - : 7302 : witness.push_back(HexStr(txin.scriptWitness.stack[i]));
+ - ]
176 : : }
177 [ + - + - ]: 23298 : entry.pushKV("witness", std::move(witness));
178 [ + + + - : 34947 : entry.pushKV("scriptSig", HexStr(txin.scriptSig));
+ - + - +
- ]
179 [ + - + - : 23298 : entry.pushKV("sequence", (uint64_t)txin.nSequence);
+ - ]
180 [ + - + - : 23298 : entry.pushKV("error", strMessage);
+ - ]
181 [ + - ]: 11649 : vErrorsRet.push_back(std::move(entry));
182 : 11649 : }
183 : :
184 : 253 : void ParsePrevouts(const UniValue& prevTxsUnival, FlatSigningProvider* keystore, std::map<COutPoint, Coin>& coins)
185 : : {
186 [ + + ]: 253 : if (!prevTxsUnival.isNull()) {
187 : 7 : const UniValue& prevTxs = prevTxsUnival.get_array();
188 [ + + ]: 7 : for (unsigned int idx = 0; idx < prevTxs.size(); ++idx) {
189 : 5 : const UniValue& p = prevTxs[idx];
190 [ + - ]: 5 : if (!p.isObject()) {
191 [ + - + - ]: 10 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "expected object with {\"txid'\",\"vout\",\"scriptPubKey\"}");
192 : : }
193 : :
194 : 0 : const UniValue& prevOut = p.get_obj();
195 : :
196 [ # # # # : 0 : RPCTypeCheckObj(prevOut,
# # ]
197 : : {
198 [ # # ]: 0 : {"txid", UniValueType(UniValue::VSTR)},
199 [ # # ]: 0 : {"vout", UniValueType(UniValue::VNUM)},
200 [ # # ]: 0 : {"scriptPubKey", UniValueType(UniValue::VSTR)},
201 : : });
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 : : }
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 : : }
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 : : {
238 [ # # ]: 0 : {"redeemScript", UniValueType(UniValue::VSTR)},
239 [ # # ]: 0 : {"witnessScript", UniValueType(UniValue::VSTR)},
240 : : }, 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 : : }
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 : : }
267 : 0 : }
268 : : }
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 : : } 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 : : }
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 : : }
299 : 0 : }
300 : 0 : }
301 : 0 : }
302 : : }
303 [ - - - - : 248 : }
- - - - -
- - - - -
- - - - ]
304 : :
305 : 248 : void SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType, UniValue& result)
306 : : {
307 : 248 : std::optional<int> nHashType = ParseSighashString(hashType);
308 [ + - ]: 247 : if (!nHashType) {
309 : 247 : nHashType = SIGHASH_DEFAULT;
310 : : }
311 : :
312 : : // Script verification errors
313 [ + - ]: 247 : std::map<int, bilingual_str> input_errors;
314 : :
315 [ + - ]: 247 : bool complete = SignTransaction(mtx, keystore, coins, *nHashType, input_errors);
316 [ + - ]: 247 : SignTransactionResultToJSON(mtx, complete, coins, input_errors, result);
317 : 247 : }
318 : :
319 : 247 : void SignTransactionResultToJSON(CMutableTransaction& mtx, bool complete, const std::map<COutPoint, Coin>& coins, const std::map<int, bilingual_str>& input_errors, UniValue& result)
320 : : {
321 : : // Make errors UniValue
322 : 247 : UniValue vErrors(UniValue::VARR);
323 [ + + ]: 11896 : for (const auto& err_pair : input_errors) {
324 [ - + ]: 11649 : if (err_pair.second.original == "Missing amount") {
325 : : // This particular error needs to be an exception for some reason
326 [ # # # # : 0 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Missing amount for %s", coins.at(mtx.vin.at(err_pair.first).prevout).out.ToString()));
# # # # #
# ]
327 : : }
328 [ + - + - ]: 11649 : TxInErrorToJSON(mtx.vin.at(err_pair.first), vErrors, err_pair.second.original);
329 : : }
330 : :
331 [ + - + - : 494 : result.pushKV("hex", EncodeHexTx(CTransaction(mtx)));
+ - + - +
- ]
332 [ + - + - : 494 : result.pushKV("complete", complete);
+ - ]
333 [ + + ]: 247 : if (!vErrors.empty()) {
334 [ + - - + ]: 338 : if (result.exists("errors")) {
335 [ # # # # : 0 : vErrors.push_backV(result["errors"].getValues());
# # # # ]
336 : : }
337 [ + - + - ]: 338 : result.pushKV("errors", std::move(vErrors));
338 : : }
339 : 247 : }
|
