Branch data Line data Source code
1 : : // Copyright (c) 2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present 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 <base58.h>
7 : : #include <chain.h>
8 : : #include <coins.h>
9 : : #include <consensus/amount.h>
10 : : #include <consensus/validation.h>
11 : : #include <core_io.h>
12 : : #include <index/txindex.h>
13 : : #include <key_io.h>
14 : : #include <node/blockstorage.h>
15 : : #include <node/coin.h>
16 : : #include <node/context.h>
17 : : #include <node/psbt.h>
18 : : #include <node/transaction.h>
19 : : #include <node/types.h>
20 : : #include <policy/packages.h>
21 : : #include <policy/policy.h>
22 : : #include <policy/rbf.h>
23 : : #include <primitives/transaction.h>
24 : : #include <psbt.h>
25 : : #include <random.h>
26 : : #include <rpc/blockchain.h>
27 : : #include <rpc/rawtransaction_util.h>
28 : : #include <rpc/server.h>
29 : : #include <rpc/server_util.h>
30 : : #include <rpc/util.h>
31 : : #include <script/script.h>
32 : : #include <script/sign.h>
33 : : #include <script/signingprovider.h>
34 : : #include <script/solver.h>
35 : : #include <uint256.h>
36 : : #include <undo.h>
37 : : #include <util/bip32.h>
38 : : #include <util/check.h>
39 : : #include <util/strencodings.h>
40 : : #include <util/string.h>
41 : : #include <util/vector.h>
42 : : #include <validation.h>
43 : : #include <validationinterface.h>
44 : :
45 : : #include <cstdint>
46 : : #include <numeric>
47 : :
48 : : #include <univalue.h>
49 : :
50 : : using node::AnalyzePSBT;
51 : : using node::FindCoins;
52 : : using node::GetTransaction;
53 : : using node::NodeContext;
54 : : using node::PSBTAnalysis;
55 : :
56 : : static constexpr decltype(CTransaction::version) DEFAULT_RAWTX_VERSION{CTransaction::CURRENT_VERSION};
57 : :
58 : 0 : static void TxToJSON(const CTransaction& tx, const uint256 hashBlock, UniValue& entry,
59 : : Chainstate& active_chainstate, const CTxUndo* txundo = nullptr,
60 : : TxVerbosity verbosity = TxVerbosity::SHOW_DETAILS)
61 : : {
62 : 0 : CHECK_NONFATAL(verbosity >= TxVerbosity::SHOW_DETAILS);
63 : : // Call into TxToUniv() in bitcoin-common to decode the transaction hex.
64 : : //
65 : : // Blockchain contextual information (confirmations and blocktime) is not
66 : : // available to code in bitcoin-common, so we query them here and push the
67 : : // data into the returned UniValue.
68 [ # # ]: 0 : TxToUniv(tx, /*block_hash=*/uint256(), entry, /*include_hex=*/true, txundo, verbosity);
69 : :
70 [ # # ]: 0 : if (!hashBlock.IsNull()) {
71 : 0 : LOCK(cs_main);
72 : :
73 [ # # # # : 0 : entry.pushKV("blockhash", hashBlock.GetHex());
# # # # ]
74 [ # # ]: 0 : const CBlockIndex* pindex = active_chainstate.m_blockman.LookupBlockIndex(hashBlock);
75 [ # # ]: 0 : if (pindex) {
76 [ # # ]: 0 : if (active_chainstate.m_chain.Contains(pindex)) {
77 [ # # # # : 0 : entry.pushKV("confirmations", 1 + active_chainstate.m_chain.Height() - pindex->nHeight);
# # # # ]
78 [ # # # # : 0 : entry.pushKV("time", pindex->GetBlockTime());
# # ]
79 [ # # # # : 0 : entry.pushKV("blocktime", pindex->GetBlockTime());
# # ]
80 : : }
81 : : else
82 [ # # # # : 0 : entry.pushKV("confirmations", 0);
# # ]
83 : : }
84 : 0 : }
85 : 0 : }
86 : :
87 : 170 : static std::vector<RPCArg> CreateTxDoc()
88 : : {
89 : 170 : return {
90 [ + - + - ]: 340 : {"inputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The inputs",
91 : : {
92 [ + - + - ]: 340 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
93 : : {
94 [ + - + - ]: 340 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
95 [ + - + - ]: 340 : {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
96 [ + - + - : 510 : {"sequence", RPCArg::Type::NUM, RPCArg::DefaultHint{"depends on the value of the 'replaceable' and 'locktime' arguments"}, "The sequence number"},
+ - ]
97 : : },
98 : : },
99 : : },
100 : : },
101 [ + - + - ]: 340 : {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
102 : : "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
103 : : "At least one output of either type must be specified.\n"
104 : : "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
105 : : " accepted as second parameter.",
106 : : {
107 [ + - + - ]: 340 : {"", RPCArg::Type::OBJ_USER_KEYS, RPCArg::Optional::OMITTED, "",
108 : : {
109 [ + - + - ]: 340 : {"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in " + CURRENCY_UNIT},
110 : : },
111 : : },
112 [ + - + - ]: 340 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
113 : : {
114 [ + - + - ]: 340 : {"data", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A key-value pair. The key must be \"data\", the value is hex-encoded data that becomes a part of an OP_RETURN output"},
115 : : },
116 : : },
117 : : },
118 [ + - ]: 170 : RPCArgOptions{.skip_type_check = true}},
119 [ + - + - : 510 : {"locktime", RPCArg::Type::NUM, RPCArg::Default{0}, "Raw locktime. Non-0 value also locktime-activates inputs"},
+ - ]
120 [ + - + - : 510 : {"replaceable", RPCArg::Type::BOOL, RPCArg::Default{true}, "Marks this transaction as BIP125-replaceable.\n"
+ - ]
121 : : "Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible."},
122 [ + - + - : 510 : {"version", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_RAWTX_VERSION}, "Transaction version"},
+ - ]
123 [ + - + - : 4420 : };
+ - + - +
- + - + +
+ + + + +
+ + + + +
- - - - -
- - - - -
- - ]
124 [ + - + - : 4250 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - ]
125 : :
126 : : // Update PSBT with information from the mempool, the UTXO set, the txindex, and the provided descriptors.
127 : : // Optionally, sign the inputs that we can using information from the descriptors.
128 : 0 : PartiallySignedTransaction ProcessPSBT(const std::string& psbt_string, const std::any& context, const HidingSigningProvider& provider, std::optional<int> sighash_type, bool finalize)
129 : : {
130 : : // Unserialize the transactions
131 : 0 : PartiallySignedTransaction psbtx;
132 [ # # ]: 0 : std::string error;
133 [ # # # # ]: 0 : if (!DecodeBase64PSBT(psbtx, psbt_string, error)) {
134 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
135 : : }
136 : :
137 [ # # # # ]: 0 : if (g_txindex) g_txindex->BlockUntilSyncedToCurrentChain();
138 [ # # ]: 0 : const NodeContext& node = EnsureAnyNodeContext(context);
139 : :
140 : : // If we can't find the corresponding full transaction for all of our inputs,
141 : : // this will be used to find just the utxos for the segwit inputs for which
142 : : // the full transaction isn't found
143 : 0 : std::map<COutPoint, Coin> coins;
144 : :
145 : : // Fetch previous transactions:
146 : : // First, look in the txindex and the mempool
147 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.tx->vin.size(); ++i) {
148 [ # # ]: 0 : PSBTInput& psbt_input = psbtx.inputs.at(i);
149 [ # # ]: 0 : const CTxIn& tx_in = psbtx.tx->vin.at(i);
150 : :
151 : : // The `non_witness_utxo` is the whole previous transaction
152 [ # # ]: 0 : if (psbt_input.non_witness_utxo) continue;
153 : :
154 : 0 : CTransactionRef tx;
155 : :
156 : : // Look in the txindex
157 [ # # ]: 0 : if (g_txindex) {
158 : 0 : uint256 block_hash;
159 [ # # ]: 0 : g_txindex->FindTx(tx_in.prevout.hash, block_hash, tx);
160 : : }
161 : : // If we still don't have it look in the mempool
162 [ # # ]: 0 : if (!tx) {
163 [ # # # # ]: 0 : tx = node.mempool->get(tx_in.prevout.hash);
164 : : }
165 [ # # ]: 0 : if (tx) {
166 : 0 : psbt_input.non_witness_utxo = tx;
167 : : } else {
168 [ # # ]: 0 : coins[tx_in.prevout]; // Create empty map entry keyed by prevout
169 : : }
170 : 0 : }
171 : :
172 : : // If we still haven't found all of the inputs, look for the missing ones in the utxo set
173 [ # # ]: 0 : if (!coins.empty()) {
174 [ # # ]: 0 : FindCoins(node, coins);
175 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.tx->vin.size(); ++i) {
176 [ # # ]: 0 : PSBTInput& input = psbtx.inputs.at(i);
177 : :
178 : : // If there are still missing utxos, add them if they were found in the utxo set
179 [ # # ]: 0 : if (!input.non_witness_utxo) {
180 [ # # ]: 0 : const CTxIn& tx_in = psbtx.tx->vin.at(i);
181 [ # # ]: 0 : const Coin& coin = coins.at(tx_in.prevout);
182 [ # # # # : 0 : if (!coin.out.IsNull() && IsSegWitOutput(provider, coin.out.scriptPubKey)) {
# # ]
183 : 0 : input.witness_utxo = coin.out;
184 : : }
185 : : }
186 : : }
187 : : }
188 : :
189 [ # # ]: 0 : const PrecomputedTransactionData& txdata = PrecomputePSBTData(psbtx);
190 : :
191 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.tx->vin.size(); ++i) {
192 [ # # # # : 0 : if (PSBTInputSigned(psbtx.inputs.at(i))) {
# # ]
193 : 0 : continue;
194 : : }
195 : :
196 : : // Update script/keypath information using descriptor data.
197 : : // Note that SignPSBTInput does a lot more than just constructing ECDSA signatures.
198 : : // We only actually care about those if our signing provider doesn't hide private
199 : : // information, as is the case with `descriptorprocesspsbt`
200 : : // Only error for mismatching sighash types as it is critical that the sighash to sign with matches the PSBT's
201 [ # # # # ]: 0 : if (SignPSBTInput(provider, psbtx, /*index=*/i, &txdata, sighash_type, /*out_sigdata=*/nullptr, finalize) == common::PSBTError::SIGHASH_MISMATCH) {
202 [ # # ]: 0 : throw JSONRPCPSBTError(common::PSBTError::SIGHASH_MISMATCH);
203 : : }
204 : : }
205 : :
206 : : // Update script/keypath information using descriptor data.
207 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.tx->vout.size(); ++i) {
208 [ # # ]: 0 : UpdatePSBTOutput(provider, psbtx, i);
209 : : }
210 : :
211 [ # # ]: 0 : RemoveUnnecessaryTransactions(psbtx);
212 : :
213 : 0 : return psbtx;
214 : 0 : }
215 : :
216 : 82 : static RPCMethod getrawtransaction()
217 : : {
218 : 82 : return RPCMethod{
219 : 82 : "getrawtransaction",
220 : :
221 [ + - ]: 164 : "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
222 : : "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
223 : : "If a blockhash argument is passed, it will return the transaction if\n"
224 : : "the specified block is available and the transaction is in that block.\n\n"
225 : : "Hint: Use gettransaction for wallet transactions.\n\n"
226 : :
227 : : "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
228 : : "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
229 : : "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
230 : : {
231 [ + - + - ]: 164 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
232 [ + - + - : 246 : {"verbosity|verbose", RPCArg::Type::NUM, RPCArg::Default{0}, "0 for hex-encoded data, 1 for a JSON object, and 2 for JSON object with fee and prevout",
+ - ]
233 [ + - ]: 164 : RPCArgOptions{.skip_type_check = true}},
234 [ + - + - ]: 164 : {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "The block in which to look for the transaction"},
235 : : },
236 : : {
237 [ + - ]: 82 : RPCResult{"if verbosity is not set or set to 0",
238 [ + - + - ]: 164 : RPCResult::Type::STR, "data", "The serialized transaction as a hex-encoded string for 'txid'"
239 : 82 : },
240 [ + - ]: 164 : RPCResult{"if verbosity is set to 1",
241 [ + - + - ]: 164 : RPCResult::Type::OBJ, "", "",
242 [ + - + - : 1148 : Cat<std::vector<RPCResult>>(
+ + - - ]
243 : : {
244 [ + - + - ]: 164 : {RPCResult::Type::BOOL, "in_active_chain", /*optional=*/true, "Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
245 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "the block hash"},
246 [ + - + - ]: 164 : {RPCResult::Type::NUM, "confirmations", /*optional=*/true, "The confirmations"},
247 [ + - + - ]: 164 : {RPCResult::Type::NUM_TIME, "blocktime", /*optional=*/true, "The block time expressed in " + UNIX_EPOCH_TIME},
248 [ + - + - ]: 164 : {RPCResult::Type::NUM, "time", /*optional=*/true, "Same as \"blocktime\""},
249 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded data for 'txid'"},
250 : : },
251 : 164 : TxDoc({.txid_field_doc="The transaction id (same as provided)"})),
252 : : },
253 [ + - ]: 164 : RPCResult{"for verbosity = 2",
254 [ + - + - ]: 164 : RPCResult::Type::OBJ, "", "",
255 : : {
256 [ + - + - ]: 164 : {RPCResult::Type::ELISION, "", "Same output as verbosity = 1"},
257 [ + - + - ]: 164 : {RPCResult::Type::NUM, "fee", /*optional=*/true, "transaction fee in " + CURRENCY_UNIT + ", omitted if block undo data is not available"},
258 [ + - + - ]: 164 : {RPCResult::Type::ARR, "vin", "",
259 : : {
260 [ + - + - ]: 164 : {RPCResult::Type::OBJ, "", "utxo being spent",
261 : : {
262 [ + - + - ]: 164 : {RPCResult::Type::ELISION, "", "Same output as verbosity = 1"},
263 [ + - + - ]: 164 : {RPCResult::Type::OBJ, "prevout", /*optional=*/true, "The previous output, omitted if block undo data is not available",
264 : : {
265 [ + - + - ]: 164 : {RPCResult::Type::BOOL, "generated", "Coinbase or not"},
266 [ + - + - ]: 164 : {RPCResult::Type::NUM, "height", "The height of the prevout"},
267 [ + - + - ]: 164 : {RPCResult::Type::STR_AMOUNT, "value", "The value in " + CURRENCY_UNIT},
268 [ + - + - : 164 : {RPCResult::Type::OBJ, "scriptPubKey", "", ScriptPubKeyDoc()},
+ - ]
269 : : }},
270 : : }},
271 : : }},
272 [ + - + - : 1968 : }},
+ - + - +
+ + + + +
+ + - - -
- - - -
- ]
273 : : },
274 : 82 : RPCExamples{
275 [ + - + - : 164 : HelpExampleCli("getrawtransaction", "\"mytxid\"")
+ - ]
276 [ + - + - : 328 : + HelpExampleCli("getrawtransaction", "\"mytxid\" 1")
+ - + - ]
277 [ + - + - : 328 : + HelpExampleRpc("getrawtransaction", "\"mytxid\", 1")
+ - + - ]
278 [ + - + - : 328 : + HelpExampleCli("getrawtransaction", "\"mytxid\" 0 \"myblockhash\"")
+ - + - ]
279 [ + - + - : 328 : + HelpExampleCli("getrawtransaction", "\"mytxid\" 1 \"myblockhash\"")
+ - + - ]
280 [ + - + - : 328 : + HelpExampleCli("getrawtransaction", "\"mytxid\" 2 \"myblockhash\"")
+ - ]
281 [ + - ]: 82 : },
282 : 82 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
283 : : {
284 : 1 : const NodeContext& node = EnsureAnyNodeContext(request.context);
285 : 1 : ChainstateManager& chainman = EnsureChainman(node);
286 : :
287 [ - - ]: 1 : auto txid{Txid::FromUint256(ParseHashV(request.params[0], "parameter 1"))};
288 : 0 : const CBlockIndex* blockindex = nullptr;
289 : :
290 [ # # ]: 0 : if (txid.ToUint256() == chainman.GetParams().GenesisBlock().hashMerkleRoot) {
291 : : // Special exception for the genesis block coinbase transaction
292 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "The genesis block coinbase is not considered an ordinary transaction and cannot be retrieved");
293 : : }
294 : :
295 : 0 : int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/0, /*allow_bool=*/true)};
296 : :
297 [ # # ]: 0 : if (!request.params[2].isNull()) {
298 : 0 : LOCK(cs_main);
299 : :
300 [ # # # # ]: 0 : uint256 blockhash = ParseHashV(request.params[2], "parameter 3");
301 [ # # ]: 0 : blockindex = chainman.m_blockman.LookupBlockIndex(blockhash);
302 [ # # ]: 0 : if (!blockindex) {
303 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block hash not found");
304 : : }
305 : 0 : }
306 : :
307 : 0 : bool f_txindex_ready = false;
308 [ # # # # ]: 0 : if (g_txindex && !blockindex) {
309 : 0 : f_txindex_ready = g_txindex->BlockUntilSyncedToCurrentChain();
310 : : }
311 : :
312 : 0 : uint256 hash_block;
313 : 0 : const CTransactionRef tx = GetTransaction(blockindex, node.mempool.get(), txid, chainman.m_blockman, hash_block);
314 [ # # ]: 0 : if (!tx) {
315 [ # # ]: 0 : std::string errmsg;
316 [ # # ]: 0 : if (blockindex) {
317 [ # # # # ]: 0 : const bool block_has_data = WITH_LOCK(::cs_main, return blockindex->nStatus & BLOCK_HAVE_DATA);
318 [ # # ]: 0 : if (!block_has_data) {
319 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Block not available");
320 : : }
321 [ # # ]: 0 : errmsg = "No such transaction found in the provided block";
322 [ # # ]: 0 : } else if (!g_txindex) {
323 [ # # ]: 0 : errmsg = "No such mempool transaction. Use -txindex or provide a block hash to enable blockchain transaction queries";
324 [ # # ]: 0 : } else if (!f_txindex_ready) {
325 [ # # ]: 0 : errmsg = "No such mempool transaction. Blockchain transactions are still in the process of being indexed";
326 : : } else {
327 [ # # ]: 0 : errmsg = "No such mempool or blockchain transaction";
328 : : }
329 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, errmsg + ". Use gettransaction for wallet transactions.");
330 : 0 : }
331 : :
332 [ # # ]: 0 : if (verbosity <= 0) {
333 [ # # # # ]: 0 : return EncodeHexTx(*tx);
334 : : }
335 : :
336 : 0 : UniValue result(UniValue::VOBJ);
337 [ # # ]: 0 : if (blockindex) {
338 [ # # ]: 0 : LOCK(cs_main);
339 [ # # # # : 0 : result.pushKV("in_active_chain", chainman.ActiveChain().Contains(blockindex));
# # # # #
# ]
340 : 0 : }
341 : : // If request is verbosity >= 1 but no blockhash was given, then look up the blockindex
342 [ # # # # ]: 0 : if (request.params[2].isNull()) {
343 [ # # ]: 0 : LOCK(cs_main);
344 [ # # # # ]: 0 : blockindex = chainman.m_blockman.LookupBlockIndex(hash_block); // May be nullptr for mempool transactions
345 : 0 : }
346 [ # # ]: 0 : if (verbosity == 1) {
347 [ # # # # ]: 0 : TxToJSON(*tx, hash_block, result, chainman.ActiveChainstate());
348 : 0 : return result;
349 : : }
350 : :
351 : 0 : CBlockUndo blockUndo;
352 : 0 : CBlock block;
353 : :
354 [ # # # # : 0 : if (tx->IsCoinBase() || !blockindex || WITH_LOCK(::cs_main, return !(blockindex->nStatus & BLOCK_HAVE_MASK))) {
# # # # #
# ]
355 [ # # # # ]: 0 : TxToJSON(*tx, hash_block, result, chainman.ActiveChainstate());
356 : 0 : return result;
357 : : }
358 [ # # # # ]: 0 : if (!chainman.m_blockman.ReadBlockUndo(blockUndo, *blockindex)) {
359 [ # # # # ]: 0 : throw JSONRPCError(RPC_INTERNAL_ERROR, "Undo data expected but can't be read. This could be due to disk corruption or a conflict with a pruning event.");
360 : : }
361 [ # # # # ]: 0 : if (!chainman.m_blockman.ReadBlock(block, *blockindex)) {
362 [ # # # # ]: 0 : throw JSONRPCError(RPC_INTERNAL_ERROR, "Block data expected but can't be read. This could be due to disk corruption or a conflict with a pruning event.");
363 : : }
364 : :
365 : 0 : CTxUndo* undoTX {nullptr};
366 [ # # # # : 0 : auto it = std::find_if(block.vtx.begin(), block.vtx.end(), [tx](CTransactionRef t){ return *t == *tx; });
# # # # #
# # # # #
# # # # ]
367 [ # # ]: 0 : if (it != block.vtx.end()) {
368 : : // -1 as blockundo does not have coinbase tx
369 [ # # ]: 0 : undoTX = &blockUndo.vtxundo.at(it - block.vtx.begin() - 1);
370 : : }
371 [ # # # # ]: 0 : TxToJSON(*tx, hash_block, result, chainman.ActiveChainstate(), undoTX, TxVerbosity::SHOW_DETAILS_AND_PREVOUT);
372 : 0 : return result;
373 : 0 : },
374 [ + - + - : 1066 : };
+ - + - +
+ + + - -
- - ]
375 [ + - + - : 3608 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - -
- - - - -
- - - - -
- ]
376 : :
377 : 90 : static RPCMethod createrawtransaction()
378 : : {
379 : 90 : return RPCMethod{
380 : 90 : "createrawtransaction",
381 [ + - ]: 180 : "Create a transaction spending the given inputs and creating new outputs.\n"
382 : : "Outputs can be addresses or data.\n"
383 : : "Returns hex-encoded raw transaction.\n"
384 : : "Note that the transaction's inputs are not signed, and\n"
385 : : "it is not stored in the wallet or transmitted to the network.\n",
386 [ + - ]: 180 : CreateTxDoc(),
387 [ + - ]: 180 : RPCResult{
388 [ + - + - ]: 180 : RPCResult::Type::STR_HEX, "transaction", "hex string of the transaction"
389 [ + - ]: 180 : },
390 : 90 : RPCExamples{
391 [ + - + - : 180 : HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
+ - ]
392 [ + - + - : 360 : + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
+ - + - ]
393 [ + - + - : 360 : + HelpExampleRpc("createrawtransaction", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"address\\\":0.01}]\"")
+ - + - ]
394 [ + - + - : 360 : + HelpExampleRpc("createrawtransaction", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
+ - + - ]
395 [ + - ]: 90 : },
396 : 90 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
397 : : {
398 : 7 : std::optional<bool> rbf;
399 [ - + ]: 7 : if (!request.params[3].isNull()) {
400 : 0 : rbf = request.params[3].get_bool();
401 : : }
402 : 7 : CMutableTransaction rawTx = ConstructTransaction(request.params[0], request.params[1], request.params[2], rbf, self.Arg<uint32_t>("version"));
403 : :
404 [ + - + - : 12 : return EncodeHexTx(CTransaction(rawTx));
+ - ]
405 : 4 : },
406 [ + - ]: 180 : };
407 : : }
408 : :
409 : 86 : static RPCMethod decoderawtransaction()
410 : : {
411 : 86 : return RPCMethod{"decoderawtransaction",
412 [ + - ]: 172 : "Return a JSON object representing the serialized, hex-encoded transaction.",
413 : : {
414 [ + - + - ]: 172 : {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction hex string"},
415 [ + - + - : 258 : {"iswitness", RPCArg::Type::BOOL, RPCArg::DefaultHint{"depends on heuristic tests"}, "Whether the transaction hex is a serialized witness transaction.\n"
+ - ]
416 : : "If iswitness is not present, heuristic tests will be used in decoding.\n"
417 : : "If true, only witness deserialization will be tried.\n"
418 : : "If false, only non-witness deserialization will be tried.\n"
419 : : "This boolean should reflect whether the transaction has inputs\n"
420 : : "(e.g. fully valid, or on-chain transactions), if known by the caller."
421 : : },
422 : : },
423 [ + - ]: 172 : RPCResult{
424 [ + - + - ]: 172 : RPCResult::Type::OBJ, "", "",
425 : 172 : TxDoc(),
426 [ + - ]: 172 : },
427 : 86 : RPCExamples{
428 [ + - + - : 172 : HelpExampleCli("decoderawtransaction", "\"hexstring\"")
+ - ]
429 [ + - + - : 344 : + HelpExampleRpc("decoderawtransaction", "\"hexstring\"")
+ - + - ]
430 [ + - ]: 86 : },
431 : 86 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
432 : : {
433 : 4 : CMutableTransaction mtx;
434 : :
435 [ + - + + : 4 : bool try_witness = request.params[1].isNull() ? true : request.params[1].get_bool();
+ - + - ]
436 [ + - + + : 4 : bool try_no_witness = request.params[1].isNull() ? true : !request.params[1].get_bool();
+ - + - ]
437 : :
438 [ + - + - : 4 : if (!DecodeHexTx(mtx, request.params[0].get_str(), try_no_witness, try_witness)) {
+ - + + ]
439 [ + - + - ]: 4 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed");
440 : : }
441 : :
442 : 2 : UniValue result(UniValue::VOBJ);
443 [ + - + - ]: 4 : TxToUniv(CTransaction(std::move(mtx)), /*block_hash=*/uint256(), /*entry=*/result, /*include_hex=*/false);
444 : :
445 : 2 : return result;
446 : 2 : },
447 [ + - + - : 516 : };
+ + - - ]
448 [ + - + - : 430 : }
+ - + - -
- ]
449 : :
450 : 80 : static RPCMethod decodescript()
451 : : {
452 : 80 : return RPCMethod{
453 : 80 : "decodescript",
454 [ + - ]: 160 : "Decode a hex-encoded script.\n",
455 : : {
456 [ + - + - ]: 160 : {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hex-encoded script"},
457 : : },
458 [ + - ]: 160 : RPCResult{
459 [ + - + - ]: 160 : RPCResult::Type::OBJ, "", "",
460 : : {
461 [ + - + - ]: 160 : {RPCResult::Type::STR, "asm", "Disassembly of the script"},
462 [ + - + - ]: 160 : {RPCResult::Type::STR, "desc", "Inferred descriptor for the script"},
463 [ + - + - : 160 : {RPCResult::Type::STR, "type", "The output type (e.g. " + GetAllOutputTypes() + ")"},
+ - ]
464 [ + - + - ]: 160 : {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
465 [ + - ]: 160 : {RPCResult::Type::STR, "p2sh", /*optional=*/true,
466 [ + - ]: 160 : "address of P2SH script wrapping this redeem script (not returned for types that should not be wrapped)"},
467 [ + - ]: 160 : {RPCResult::Type::OBJ, "segwit", /*optional=*/true,
468 [ + - ]: 160 : "Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped)",
469 : : {
470 [ + - + - ]: 160 : {RPCResult::Type::STR, "asm", "Disassembly of the output script"},
471 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "hex", "The raw output script bytes, hex-encoded"},
472 [ + - + - ]: 160 : {RPCResult::Type::STR, "type", "The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash)"},
473 [ + - + - ]: 160 : {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
474 [ + - + - ]: 160 : {RPCResult::Type::STR, "desc", "Inferred descriptor for the script"},
475 [ + - + - ]: 160 : {RPCResult::Type::STR, "p2sh-segwit", "address of the P2SH script wrapping this witness redeem script"},
476 : : }},
477 : : },
478 [ + - + - : 2160 : },
+ - + + +
+ - - -
- ]
479 : 80 : RPCExamples{
480 [ + - + - : 160 : HelpExampleCli("decodescript", "\"hexstring\"")
+ - ]
481 [ + - + - : 320 : + HelpExampleRpc("decodescript", "\"hexstring\"")
+ - + - ]
482 [ + - ]: 80 : },
483 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
484 : : {
485 : 0 : UniValue r(UniValue::VOBJ);
486 : 0 : CScript script;
487 [ # # # # : 0 : if (request.params[0].get_str().size() > 0){
# # # # ]
488 [ # # # # ]: 0 : std::vector<unsigned char> scriptData(ParseHexV(request.params[0], "argument"));
489 : 0 : script = CScript(scriptData.begin(), scriptData.end());
490 : 0 : } else {
491 : : // Empty scripts are valid
492 : : }
493 [ # # ]: 0 : ScriptToUniv(script, /*out=*/r, /*include_hex=*/false, /*include_address=*/true);
494 : :
495 : 0 : std::vector<std::vector<unsigned char>> solutions_data;
496 [ # # ]: 0 : const TxoutType which_type{Solver(script, solutions_data)};
497 : :
498 : 0 : const bool can_wrap{[&] {
499 [ # # ]: 0 : switch (which_type) {
500 : : case TxoutType::MULTISIG:
501 : : case TxoutType::NONSTANDARD:
502 : : case TxoutType::PUBKEY:
503 : : case TxoutType::PUBKEYHASH:
504 : : case TxoutType::WITNESS_V0_KEYHASH:
505 : : case TxoutType::WITNESS_V0_SCRIPTHASH:
506 : : // Can be wrapped if the checks below pass
507 : : break;
508 : : case TxoutType::NULL_DATA:
509 : : case TxoutType::SCRIPTHASH:
510 : : case TxoutType::WITNESS_UNKNOWN:
511 : : case TxoutType::WITNESS_V1_TAPROOT:
512 : : case TxoutType::ANCHOR:
513 : : // Should not be wrapped
514 : : return false;
515 : : } // no default case, so the compiler can warn about missing cases
516 [ # # # # ]: 0 : if (!script.HasValidOps() || script.IsUnspendable()) {
517 : : return false;
518 : : }
519 [ # # # # ]: 0 : for (CScript::const_iterator it{script.begin()}; it != script.end();) {
520 : 0 : opcodetype op;
521 : 0 : CHECK_NONFATAL(script.GetOp(it, op));
522 [ # # # # : 0 : if (op == OP_CHECKSIGADD || IsOpSuccess(op)) {
# # ]
523 : : return false;
524 : : }
525 : : }
526 : : return true;
527 [ # # ]: 0 : }()};
528 : :
529 [ # # ]: 0 : if (can_wrap) {
530 [ # # # # : 0 : r.pushKV("p2sh", EncodeDestination(ScriptHash(script)));
# # # # #
# ]
531 : : // P2SH and witness programs cannot be wrapped in P2WSH, if this script
532 : : // is a witness program, don't return addresses for a segwit programs.
533 : 0 : const bool can_wrap_P2WSH{[&] {
534 [ # # # # ]: 0 : switch (which_type) {
535 : 0 : case TxoutType::MULTISIG:
536 : 0 : case TxoutType::PUBKEY:
537 : : // Uncompressed pubkeys cannot be used with segwit checksigs.
538 : : // If the script contains an uncompressed pubkey, skip encoding of a segwit program.
539 [ # # ]: 0 : for (const auto& solution : solutions_data) {
540 [ # # # # : 0 : if ((solution.size() != 1) && !CPubKey(solution).IsCompressed()) {
# # ]
541 : : return false;
542 : : }
543 : : }
544 : : return true;
545 : : case TxoutType::NONSTANDARD:
546 : : case TxoutType::PUBKEYHASH:
547 : : // Can be P2WSH wrapped
548 : : return true;
549 : 0 : case TxoutType::NULL_DATA:
550 : 0 : case TxoutType::SCRIPTHASH:
551 : 0 : case TxoutType::WITNESS_UNKNOWN:
552 : 0 : case TxoutType::WITNESS_V0_KEYHASH:
553 : 0 : case TxoutType::WITNESS_V0_SCRIPTHASH:
554 : 0 : case TxoutType::WITNESS_V1_TAPROOT:
555 : 0 : case TxoutType::ANCHOR:
556 : : // Should not be wrapped
557 : 0 : return false;
558 : : } // no default case, so the compiler can warn about missing cases
559 [ # # ]: 0 : NONFATAL_UNREACHABLE();
560 [ # # ]: 0 : }()};
561 [ # # ]: 0 : if (can_wrap_P2WSH) {
562 : 0 : UniValue sr(UniValue::VOBJ);
563 : 0 : CScript segwitScr;
564 : 0 : FlatSigningProvider provider;
565 [ # # ]: 0 : if (which_type == TxoutType::PUBKEY) {
566 [ # # # # ]: 0 : segwitScr = GetScriptForDestination(WitnessV0KeyHash(Hash160(solutions_data[0])));
567 [ # # ]: 0 : } else if (which_type == TxoutType::PUBKEYHASH) {
568 [ # # # # ]: 0 : segwitScr = GetScriptForDestination(WitnessV0KeyHash(uint160{solutions_data[0]}));
569 : : } else {
570 : : // Scripts that are not fit for P2WPKH are encoded as P2WSH.
571 [ # # # # ]: 0 : provider.scripts[CScriptID(script)] = script;
572 [ # # # # ]: 0 : segwitScr = GetScriptForDestination(WitnessV0ScriptHash(script));
573 : : }
574 [ # # ]: 0 : ScriptToUniv(segwitScr, /*out=*/sr, /*include_hex=*/true, /*include_address=*/true, /*provider=*/&provider);
575 [ # # # # : 0 : sr.pushKV("p2sh-segwit", EncodeDestination(ScriptHash(segwitScr)));
# # # # #
# ]
576 [ # # # # ]: 0 : r.pushKV("segwit", std::move(sr));
577 : 0 : }
578 : : }
579 : :
580 : 0 : return r;
581 : 0 : },
582 [ + - + - : 400 : };
+ + - - ]
583 [ + - + - : 2080 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- ]
584 : :
585 : 80 : static RPCMethod combinerawtransaction()
586 : : {
587 : 80 : return RPCMethod{
588 : 80 : "combinerawtransaction",
589 [ + - ]: 160 : "Combine multiple partially signed transactions into one transaction.\n"
590 : : "The combined transaction may be another partially signed transaction or a \n"
591 : : "fully signed transaction.",
592 : : {
593 [ + - + - ]: 160 : {"txs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The hex strings of partially signed transactions",
594 : : {
595 [ + - + - ]: 160 : {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "A hex-encoded raw transaction"},
596 : : },
597 : : },
598 : : },
599 [ + - ]: 160 : RPCResult{
600 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The hex-encoded raw transaction with signature(s)"
601 [ + - ]: 160 : },
602 : 80 : RPCExamples{
603 [ + - + - : 160 : HelpExampleCli("combinerawtransaction", R"('["myhex1", "myhex2", "myhex3"]')")
+ - ]
604 [ + - ]: 80 : },
605 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
606 : : {
607 : :
608 : 0 : UniValue txs = request.params[0].get_array();
609 [ # # # # ]: 0 : std::vector<CMutableTransaction> txVariants(txs.size());
610 : :
611 [ # # # # ]: 0 : for (unsigned int idx = 0; idx < txs.size(); idx++) {
612 [ # # # # : 0 : if (!DecodeHexTx(txVariants[idx], txs[idx].get_str())) {
# # # # ]
613 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed for tx %d. Make sure the tx has at least one input.", idx));
614 : : }
615 : : }
616 : :
617 [ # # ]: 0 : if (txVariants.empty()) {
618 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Missing transactions");
619 : : }
620 : :
621 : : // mergedTx will end up with all the signatures; it
622 : : // starts as a clone of the rawtx:
623 [ # # ]: 0 : CMutableTransaction mergedTx(txVariants[0]);
624 : :
625 : : // Fetch previous transactions (inputs):
626 [ # # # # ]: 0 : CCoinsViewCache view{&CoinsViewEmpty::Get()};
627 : 0 : {
628 [ # # ]: 0 : NodeContext& node = EnsureAnyNodeContext(request.context);
629 [ # # ]: 0 : const CTxMemPool& mempool = EnsureMemPool(node);
630 [ # # ]: 0 : ChainstateManager& chainman = EnsureChainman(node);
631 [ # # # # ]: 0 : LOCK2(cs_main, mempool.cs);
632 [ # # # # ]: 0 : CCoinsViewCache &viewChain = chainman.ActiveChainstate().CoinsTip();
633 [ # # ]: 0 : CCoinsViewMemPool viewMempool(&viewChain, mempool);
634 : 0 : view.SetBackend(viewMempool); // temporarily switch cache backend to db+mempool view
635 : :
636 [ # # ]: 0 : for (const CTxIn& txin : mergedTx.vin) {
637 [ # # ]: 0 : view.AccessCoin(txin.prevout); // Load entries from viewChain into view; can fail.
638 : : }
639 : :
640 [ # # ]: 0 : view.SetBackend(CoinsViewEmpty::Get()); // switch back to avoid locking mempool for too long
641 [ # # # # ]: 0 : }
642 : :
643 : : // Use CTransaction for the constant parts of the
644 : : // transaction to avoid rehashing.
645 [ # # ]: 0 : const CTransaction txConst(mergedTx);
646 : : // Sign what we can:
647 [ # # # # ]: 0 : for (unsigned int i = 0; i < mergedTx.vin.size(); i++) {
648 [ # # ]: 0 : CTxIn& txin = mergedTx.vin[i];
649 [ # # ]: 0 : const Coin& coin = view.AccessCoin(txin.prevout);
650 [ # # ]: 0 : if (coin.IsSpent()) {
651 [ # # # # ]: 0 : throw JSONRPCError(RPC_VERIFY_ERROR, "Input not found or already spent");
652 : : }
653 : 0 : SignatureData sigdata;
654 : :
655 : : // ... and merge in other signatures:
656 [ # # ]: 0 : for (const CMutableTransaction& txv : txVariants) {
657 [ # # # # ]: 0 : if (txv.vin.size() > i) {
658 [ # # # # ]: 0 : sigdata.MergeSignatureData(DataFromTransaction(txv, i, coin.out));
659 : : }
660 : : }
661 [ # # # # ]: 0 : ProduceSignature(DUMMY_SIGNING_PROVIDER, MutableTransactionSignatureCreator(mergedTx, i, coin.out.nValue, 1), coin.out.scriptPubKey, sigdata);
662 : :
663 [ # # ]: 0 : UpdateInput(txin, sigdata);
664 : 0 : }
665 : :
666 [ # # # # : 0 : return EncodeHexTx(CTransaction(mergedTx));
# # ]
667 : 0 : },
668 [ + - + - : 640 : };
+ - + + +
+ - - -
- ]
669 [ + - + - ]: 320 : }
670 : :
671 : 82 : static RPCMethod signrawtransactionwithkey()
672 : : {
673 : 82 : return RPCMethod{
674 : 82 : "signrawtransactionwithkey",
675 [ + - ]: 164 : "Sign inputs for raw transaction (serialized, hex-encoded).\n"
676 : : "The second argument is an array of base58-encoded private\n"
677 : : "keys that will be the only keys used to sign the transaction.\n"
678 : : "The third optional argument (may be null) is an array of previous transaction outputs that\n"
679 : : "this transaction depends on but may not yet be in the block chain.\n",
680 : : {
681 [ + - + - ]: 164 : {"hexstring", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction hex string"},
682 [ + - + - ]: 164 : {"privkeys", RPCArg::Type::ARR, RPCArg::Optional::NO, "The base58-encoded private keys for signing",
683 : : {
684 [ + - + - ]: 164 : {"privatekey", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "private key in base58-encoding"},
685 : : },
686 : : },
687 [ + - + - ]: 164 : {"prevtxs", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "The previous dependent transaction outputs",
688 : : {
689 [ + - + - ]: 164 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
690 : : {
691 [ + - + - ]: 164 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
692 [ + - + - ]: 164 : {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
693 [ + - + - ]: 164 : {"scriptPubKey", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "output script"},
694 [ + - + - ]: 164 : {"redeemScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2SH) redeem script"},
695 [ + - + - ]: 164 : {"witnessScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2WSH or P2SH-P2WSH) witness script"},
696 [ + - + - ]: 164 : {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::OMITTED, "(required for Segwit inputs) the amount spent"},
697 : : },
698 : : },
699 : : },
700 : : },
701 [ + - + - : 246 : {"sighashtype", RPCArg::Type::STR, RPCArg::Default{"DEFAULT for Taproot, ALL otherwise"}, "The signature hash type. Must be one of:\n"
+ - ]
702 : : " \"DEFAULT\"\n"
703 : : " \"ALL\"\n"
704 : : " \"NONE\"\n"
705 : : " \"SINGLE\"\n"
706 : : " \"ALL|ANYONECANPAY\"\n"
707 : : " \"NONE|ANYONECANPAY\"\n"
708 : : " \"SINGLE|ANYONECANPAY\"\n"
709 : : },
710 : : },
711 [ + - ]: 164 : RPCResult{
712 [ + - + - ]: 164 : RPCResult::Type::OBJ, "", "",
713 : : {
714 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "hex", "The hex-encoded raw transaction with signature(s)"},
715 [ + - + - ]: 164 : {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
716 [ + - + - ]: 164 : {RPCResult::Type::ARR, "errors", /*optional=*/true, "Script verification errors (if there are any)",
717 : : {
718 [ + - + - ]: 164 : {RPCResult::Type::OBJ, "", "",
719 : : {
720 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "txid", "The hash of the referenced, previous transaction"},
721 [ + - + - ]: 164 : {RPCResult::Type::NUM, "vout", "The index of the output to spent and used as input"},
722 [ + - + - ]: 164 : {RPCResult::Type::ARR, "witness", "",
723 : : {
724 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "witness", ""},
725 : : }},
726 [ + - + - ]: 164 : {RPCResult::Type::STR_HEX, "scriptSig", "The hex-encoded signature script"},
727 [ + - + - ]: 164 : {RPCResult::Type::NUM, "sequence", "Script sequence number"},
728 [ + - + - ]: 164 : {RPCResult::Type::STR, "error", "Verification or signing error related to the input"},
729 : : }},
730 : : }},
731 : : }
732 [ + - + - : 2214 : },
+ - + - +
- + + + +
+ + + + -
- - - - -
- - ]
733 : 82 : RPCExamples{
734 [ + - + - : 164 : HelpExampleCli("signrawtransactionwithkey", "\"myhex\" \"[\\\"key1\\\",\\\"key2\\\"]\"")
+ - ]
735 [ + - + - : 328 : + HelpExampleRpc("signrawtransactionwithkey", "\"myhex\", \"[\\\"key1\\\",\\\"key2\\\"]\"")
+ - + - ]
736 [ + - ]: 82 : },
737 : 82 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
738 : : {
739 : 2 : CMutableTransaction mtx;
740 [ + - + - : 2 : if (!DecodeHexTx(mtx, request.params[0].get_str())) {
+ - - + ]
741 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
742 : : }
743 : :
744 : 2 : FlatSigningProvider keystore;
745 [ + - + - ]: 2 : const UniValue& keys = request.params[1].get_array();
746 [ - + + + ]: 4 : for (unsigned int idx = 0; idx < keys.size(); ++idx) {
747 [ + - + - ]: 2 : UniValue k = keys[idx];
748 [ + - + - ]: 2 : CKey key = DecodeSecret(k.get_str());
749 [ - + ]: 2 : if (!key.IsValid()) {
750 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key");
751 : : }
752 : :
753 [ + - ]: 2 : CPubKey pubkey = key.GetPubKey();
754 [ + - ]: 2 : CKeyID key_id = pubkey.GetID();
755 [ + - ]: 2 : keystore.pubkeys.emplace(key_id, pubkey);
756 [ + - ]: 2 : keystore.keys.emplace(key_id, key);
757 : 2 : }
758 : :
759 : : // Fetch previous transactions (inputs):
760 : 2 : std::map<COutPoint, Coin> coins;
761 [ + + ]: 4 : for (const CTxIn& txin : mtx.vin) {
762 [ + - ]: 2 : coins[txin.prevout]; // Create empty map entry keyed by prevout.
763 : : }
764 [ + - ]: 2 : NodeContext& node = EnsureAnyNodeContext(request.context);
765 [ + - ]: 2 : FindCoins(node, coins);
766 : :
767 : : // Parse the prevtxs array
768 [ + - + - ]: 2 : ParsePrevouts(request.params[2], &keystore, coins);
769 : :
770 : 2 : UniValue result(UniValue::VOBJ);
771 [ + - + - ]: 2 : SignTransaction(mtx, &keystore, coins, request.params[3], result);
772 : 2 : return result;
773 : 4 : },
774 [ + - + - : 1804 : };
+ - + - +
- + + + +
+ + + + -
- - - - -
- - ]
775 [ + - + - : 3772 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - -
- ]
776 : :
777 : 80 : const RPCResult& DecodePSBTInputs()
778 : : {
779 : 80 : static const RPCResult decodepsbt_inputs{
780 [ + - + - ]: 80 : RPCResult::Type::ARR, "inputs", "",
781 : : {
782 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
783 : : {
784 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "non_witness_utxo", /*optional=*/true, "Decoded network transaction for non-witness UTXOs",
785 : 80 : TxDoc({.elision_description="The layout is the same as the output of decoderawtransaction."})
786 : : },
787 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "witness_utxo", /*optional=*/true, "Transaction output for witness UTXOs",
788 : : {
789 [ + - + - ]: 80 : {RPCResult::Type::NUM, "amount", "The value in " + CURRENCY_UNIT},
790 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "scriptPubKey", "",
791 : : {
792 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the output script"},
793 [ + - + - ]: 80 : {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
794 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw output script bytes, hex-encoded"},
795 [ + - + - ]: 80 : {RPCResult::Type::STR, "type", "The type, eg 'pubkeyhash'"},
796 [ + - + - ]: 80 : {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
797 : : }},
798 : : }},
799 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "partial_signatures", /*optional=*/true, "",
800 : : {
801 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The public key and signature that corresponds to it."},
802 : : }},
803 [ + - + - ]: 80 : {RPCResult::Type::STR, "sighash", /*optional=*/true, "The sighash type to be used"},
804 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "redeem_script", /*optional=*/true, "",
805 : : {
806 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the redeem script"},
807 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw redeem script bytes, hex-encoded"},
808 [ + - + - ]: 80 : {RPCResult::Type::STR, "type", "The type, eg 'pubkeyhash'"},
809 : : }},
810 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "witness_script", /*optional=*/true, "",
811 : : {
812 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the witness script"},
813 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw witness script bytes, hex-encoded"},
814 [ + - + - ]: 80 : {RPCResult::Type::STR, "type", "The type, eg 'pubkeyhash'"},
815 : : }},
816 [ + - + - ]: 80 : {RPCResult::Type::ARR, "bip32_derivs", /*optional=*/true, "",
817 : : {
818 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
819 : : {
820 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The public key with the derivation path as the value."},
821 [ + - + - ]: 80 : {RPCResult::Type::STR, "master_fingerprint", "The fingerprint of the master key"},
822 [ + - + - ]: 80 : {RPCResult::Type::STR, "path", "The path"},
823 : : }},
824 : : }},
825 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "final_scriptSig", /*optional=*/true, "",
826 : : {
827 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the final signature script"},
828 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw final signature script bytes, hex-encoded"},
829 : : }},
830 [ + - + - ]: 80 : {RPCResult::Type::ARR, "final_scriptwitness", /*optional=*/true, "",
831 : : {
832 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "", "hex-encoded witness data (if any)"},
833 : : }},
834 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "ripemd160_preimages", /*optional=*/ true, "",
835 : : {
836 [ + - + - ]: 80 : {RPCResult::Type::STR, "hash", "The hash and preimage that corresponds to it."},
837 : : }},
838 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "sha256_preimages", /*optional=*/ true, "",
839 : : {
840 [ + - + - ]: 80 : {RPCResult::Type::STR, "hash", "The hash and preimage that corresponds to it."},
841 : : }},
842 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "hash160_preimages", /*optional=*/ true, "",
843 : : {
844 [ + - + - ]: 80 : {RPCResult::Type::STR, "hash", "The hash and preimage that corresponds to it."},
845 : : }},
846 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "hash256_preimages", /*optional=*/ true, "",
847 : : {
848 [ + - + - ]: 80 : {RPCResult::Type::STR, "hash", "The hash and preimage that corresponds to it."},
849 : : }},
850 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "taproot_key_path_sig", /*optional=*/ true, "hex-encoded signature for the Taproot key path spend"},
851 [ + - + - ]: 80 : {RPCResult::Type::ARR, "taproot_script_path_sigs", /*optional=*/ true, "",
852 : : {
853 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "signature", /*optional=*/ true, "The signature for the pubkey and leaf hash combination",
854 : : {
855 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The x-only pubkey for this signature"},
856 [ + - + - ]: 80 : {RPCResult::Type::STR, "leaf_hash", "The leaf hash for this signature"},
857 [ + - + - ]: 80 : {RPCResult::Type::STR, "sig", "The signature itself"},
858 : : }},
859 : : }},
860 [ + - + - ]: 80 : {RPCResult::Type::ARR, "taproot_scripts", /*optional=*/ true, "",
861 : : {
862 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
863 : : {
864 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "script", "A leaf script"},
865 [ + - + - ]: 80 : {RPCResult::Type::NUM, "leaf_ver", "The version number for the leaf script"},
866 [ + - + - ]: 80 : {RPCResult::Type::ARR, "control_blocks", "The control blocks for this script",
867 : : {
868 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "control_block", "A hex-encoded control block for this script"},
869 : : }},
870 : : }},
871 : : }},
872 [ + - + - ]: 80 : {RPCResult::Type::ARR, "taproot_bip32_derivs", /*optional=*/ true, "",
873 : : {
874 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
875 : : {
876 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The x-only public key this path corresponds to"},
877 [ + - + - ]: 80 : {RPCResult::Type::STR, "master_fingerprint", "The fingerprint of the master key"},
878 [ + - + - ]: 80 : {RPCResult::Type::STR, "path", "The path"},
879 [ + - + - ]: 80 : {RPCResult::Type::ARR, "leaf_hashes", "The hashes of the leaves this pubkey appears in",
880 : : {
881 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hash", "The hash of a leaf this pubkey appears in"},
882 : : }},
883 : : }},
884 : : }},
885 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "taproot_internal_key", /*optional=*/ true, "The hex-encoded Taproot x-only internal key"},
886 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "taproot_merkle_root", /*optional=*/ true, "The hex-encoded Taproot merkle root"},
887 [ + - + - ]: 80 : {RPCResult::Type::ARR, "musig2_participant_pubkeys", /*optional=*/true, "",
888 : : {
889 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
890 : : {
891 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "aggregate_pubkey", "The compressed aggregate public key for which the participants create."},
892 [ + - + - ]: 80 : {RPCResult::Type::ARR, "participant_pubkeys", "",
893 : : {
894 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "pubkey", "The compressed public keys that are aggregated for aggregate_pubkey."},
895 : : }},
896 : : }},
897 : : }},
898 [ + - + - ]: 80 : {RPCResult::Type::ARR, "musig2_pubnonces", /*optional=*/true, "",
899 : : {
900 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
901 : : {
902 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "participant_pubkey", "The compressed public key of the participant that created this pubnonce."},
903 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "aggregate_pubkey", "The compressed aggregate public key for which this pubnonce is for."},
904 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "leaf_hash", /*optional=*/true, "The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
905 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "pubnonce", "The public nonce itself."},
906 : : }},
907 : : }},
908 [ + - + - ]: 80 : {RPCResult::Type::ARR, "musig2_partial_sigs", /*optional=*/true, "",
909 : : {
910 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
911 : : {
912 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "participant_pubkey", "The compressed public key of the participant that created this partial signature."},
913 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "aggregate_pubkey", "The compressed aggregate public key for which this partial signature is for."},
914 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "leaf_hash", /*optional=*/true, "The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
915 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "partial_sig", "The partial signature itself."},
916 : : }},
917 : : }},
918 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "unknown", /*optional=*/ true, "The unknown input fields",
919 : : {
920 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},
921 : : }},
922 [ + - + - ]: 80 : {RPCResult::Type::ARR, "proprietary", /*optional=*/true, "The input proprietary map",
923 : : {
924 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
925 : : {
926 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "identifier", "The hex string for the proprietary identifier"},
927 [ + - + - ]: 80 : {RPCResult::Type::NUM, "subtype", "The number for the subtype"},
928 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "key", "The hex for the key"},
929 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "value", "The hex for the value"},
930 : : }},
931 : : }},
932 : : }},
933 : : }
934 [ + + + - : 8240 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - -
- ]
935 : 80 : return decodepsbt_inputs;
936 [ + - + - : 6800 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - -
- ]
937 : :
938 : 80 : const RPCResult& DecodePSBTOutputs()
939 : : {
940 : 80 : static const RPCResult decodepsbt_outputs{
941 [ + - + - ]: 80 : RPCResult::Type::ARR, "outputs", "",
942 : : {
943 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
944 : : {
945 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "redeem_script", /*optional=*/true, "",
946 : : {
947 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the redeem script"},
948 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw redeem script bytes, hex-encoded"},
949 [ + - + - ]: 80 : {RPCResult::Type::STR, "type", "The type, eg 'pubkeyhash'"},
950 : : }},
951 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "witness_script", /*optional=*/true, "",
952 : : {
953 [ + - + - ]: 80 : {RPCResult::Type::STR, "asm", "Disassembly of the witness script"},
954 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hex", "The raw witness script bytes, hex-encoded"},
955 [ + - + - ]: 80 : {RPCResult::Type::STR, "type", "The type, eg 'pubkeyhash'"},
956 : : }},
957 [ + - + - ]: 80 : {RPCResult::Type::ARR, "bip32_derivs", /*optional=*/true, "",
958 : : {
959 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
960 : : {
961 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The public key this path corresponds to"},
962 [ + - + - ]: 80 : {RPCResult::Type::STR, "master_fingerprint", "The fingerprint of the master key"},
963 [ + - + - ]: 80 : {RPCResult::Type::STR, "path", "The path"},
964 : : }},
965 : : }},
966 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "taproot_internal_key", /*optional=*/ true, "The hex-encoded Taproot x-only internal key"},
967 [ + - + - ]: 80 : {RPCResult::Type::ARR, "taproot_tree", /*optional=*/ true, "The tuples that make up the Taproot tree, in depth first search order",
968 : : {
969 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "tuple", /*optional=*/ true, "A single leaf script in the taproot tree",
970 : : {
971 [ + - + - ]: 80 : {RPCResult::Type::NUM, "depth", "The depth of this element in the tree"},
972 [ + - + - ]: 80 : {RPCResult::Type::NUM, "leaf_ver", "The version of this leaf"},
973 [ + - + - ]: 80 : {RPCResult::Type::STR, "script", "The hex-encoded script itself"},
974 : : }},
975 : : }},
976 [ + - + - ]: 80 : {RPCResult::Type::ARR, "taproot_bip32_derivs", /*optional=*/ true, "",
977 : : {
978 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
979 : : {
980 [ + - + - ]: 80 : {RPCResult::Type::STR, "pubkey", "The x-only public key this path corresponds to"},
981 [ + - + - ]: 80 : {RPCResult::Type::STR, "master_fingerprint", "The fingerprint of the master key"},
982 [ + - + - ]: 80 : {RPCResult::Type::STR, "path", "The path"},
983 [ + - + - ]: 80 : {RPCResult::Type::ARR, "leaf_hashes", "The hashes of the leaves this pubkey appears in",
984 : : {
985 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "hash", "The hash of a leaf this pubkey appears in"},
986 : : }},
987 : : }},
988 : : }},
989 [ + - + - ]: 80 : {RPCResult::Type::ARR, "musig2_participant_pubkeys", /*optional=*/true, "",
990 : : {
991 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
992 : : {
993 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "aggregate_pubkey", "The compressed aggregate public key for which the participants create."},
994 [ + - + - ]: 80 : {RPCResult::Type::ARR, "participant_pubkeys", "",
995 : : {
996 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "pubkey", "The compressed public keys that are aggregated for aggregate_pubkey."},
997 : : }},
998 : : }},
999 : : }},
1000 [ + - + - ]: 80 : {RPCResult::Type::OBJ_DYN, "unknown", /*optional=*/true, "The unknown output fields",
1001 : : {
1002 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},
1003 : : }},
1004 [ + - + - ]: 80 : {RPCResult::Type::ARR, "proprietary", /*optional=*/true, "The output proprietary map",
1005 : : {
1006 [ + - + - ]: 80 : {RPCResult::Type::OBJ, "", "",
1007 : : {
1008 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "identifier", "The hex string for the proprietary identifier"},
1009 [ + - + - ]: 80 : {RPCResult::Type::NUM, "subtype", "The number for the subtype"},
1010 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "key", "The hex for the key"},
1011 [ + - + - ]: 80 : {RPCResult::Type::STR_HEX, "value", "The hex for the value"},
1012 : : }},
1013 : : }},
1014 : : }},
1015 : : }
1016 [ + + + - : 4000 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
+ + + + +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - ]
1017 : 80 : return decodepsbt_outputs;
1018 [ + - + - : 3200 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- - - - -
- - - - -
- - - - -
- - ]
1019 : :
1020 : 80 : static RPCMethod decodepsbt()
1021 : : {
1022 : 80 : return RPCMethod{
1023 : 80 : "decodepsbt",
1024 [ + - ]: 160 : "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
1025 : : {
1026 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "The PSBT base64 string"},
1027 : : },
1028 [ + - ]: 160 : RPCResult{
1029 [ + - + - ]: 160 : RPCResult::Type::OBJ, "", "",
1030 : : {
1031 [ + - + - ]: 160 : {RPCResult::Type::OBJ, "tx", "The decoded network-serialized unsigned transaction.",
1032 : 160 : TxDoc({.elision_description="The layout is the same as the output of decoderawtransaction."})
1033 : : },
1034 [ + - + - ]: 160 : {RPCResult::Type::ARR, "global_xpubs", "",
1035 : : {
1036 [ + - + - ]: 160 : {RPCResult::Type::OBJ, "", "",
1037 : : {
1038 [ + - + - ]: 160 : {RPCResult::Type::STR, "xpub", "The extended public key this path corresponds to"},
1039 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "master_fingerprint", "The fingerprint of the master key"},
1040 [ + - + - ]: 160 : {RPCResult::Type::STR, "path", "The path"},
1041 : : }},
1042 : : }},
1043 [ + - + - ]: 160 : {RPCResult::Type::NUM, "psbt_version", "The PSBT version number. Not to be confused with the unsigned transaction version"},
1044 [ + - + - ]: 160 : {RPCResult::Type::ARR, "proprietary", "The global proprietary map",
1045 : : {
1046 [ + - + - ]: 160 : {RPCResult::Type::OBJ, "", "",
1047 : : {
1048 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "identifier", "The hex string for the proprietary identifier"},
1049 [ + - + - ]: 160 : {RPCResult::Type::NUM, "subtype", "The number for the subtype"},
1050 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "key", "The hex for the key"},
1051 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "value", "The hex for the value"},
1052 : : }},
1053 : : }},
1054 [ + - + - ]: 160 : {RPCResult::Type::OBJ_DYN, "unknown", "The unknown global fields",
1055 : : {
1056 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "key", "(key-value pair) An unknown key-value pair"},
1057 : : }},
1058 : : DecodePSBTInputs(),
1059 : : DecodePSBTOutputs(),
1060 [ + - + - ]: 160 : {RPCResult::Type::STR_AMOUNT, "fee", /*optional=*/true, "The transaction fee paid if all UTXOs slots in the PSBT have been filled."},
1061 : : }
1062 [ + - + - : 3200 : },
+ - + - +
- + - + -
+ + + + +
+ + + + +
+ + - - -
- - - - -
- - - - ]
1063 : 80 : RPCExamples{
1064 [ + - + - : 160 : HelpExampleCli("decodepsbt", "\"psbt\"")
+ - ]
1065 [ + - ]: 80 : },
1066 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1067 : : {
1068 : : // Unserialize the transactions
1069 : 0 : PartiallySignedTransaction psbtx;
1070 [ # # ]: 0 : std::string error;
1071 [ # # # # : 0 : if (!DecodeBase64PSBT(psbtx, request.params[0].get_str(), error)) {
# # # # ]
1072 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
1073 : : }
1074 : :
1075 : 0 : UniValue result(UniValue::VOBJ);
1076 : :
1077 : : // Add the decoded tx
1078 : 0 : UniValue tx_univ(UniValue::VOBJ);
1079 [ # # # # ]: 0 : TxToUniv(CTransaction(*psbtx.tx), /*block_hash=*/uint256(), /*entry=*/tx_univ, /*include_hex=*/false);
1080 [ # # # # ]: 0 : result.pushKV("tx", std::move(tx_univ));
1081 : :
1082 : : // Add the global xpubs
1083 : 0 : UniValue global_xpubs(UniValue::VARR);
1084 [ # # # # ]: 0 : for (std::pair<KeyOriginInfo, std::set<CExtPubKey>> xpub_pair : psbtx.m_xpubs) {
1085 [ # # ]: 0 : for (auto& xpub : xpub_pair.second) {
1086 : 0 : std::vector<unsigned char> ser_xpub;
1087 [ # # ]: 0 : ser_xpub.assign(BIP32_EXTKEY_WITH_VERSION_SIZE, 0);
1088 [ # # ]: 0 : xpub.EncodeWithVersion(ser_xpub.data());
1089 : :
1090 : 0 : UniValue keypath(UniValue::VOBJ);
1091 [ # # # # : 0 : keypath.pushKV("xpub", EncodeBase58Check(ser_xpub));
# # # # #
# ]
1092 [ # # # # : 0 : keypath.pushKV("master_fingerprint", HexStr(std::span<unsigned char>(xpub_pair.first.fingerprint, xpub_pair.first.fingerprint + 4)));
# # # # ]
1093 [ # # # # : 0 : keypath.pushKV("path", WriteHDKeypath(xpub_pair.first.path));
# # # # ]
1094 [ # # ]: 0 : global_xpubs.push_back(std::move(keypath));
1095 : 0 : }
1096 : 0 : }
1097 [ # # # # ]: 0 : result.pushKV("global_xpubs", std::move(global_xpubs));
1098 : :
1099 : : // PSBT version
1100 [ # # # # : 0 : result.pushKV("psbt_version", psbtx.GetVersion());
# # # # ]
1101 : :
1102 : : // Proprietary
1103 : 0 : UniValue proprietary(UniValue::VARR);
1104 [ # # ]: 0 : for (const auto& entry : psbtx.m_proprietary) {
1105 : 0 : UniValue this_prop(UniValue::VOBJ);
1106 [ # # # # : 0 : this_prop.pushKV("identifier", HexStr(entry.identifier));
# # # # #
# ]
1107 [ # # # # : 0 : this_prop.pushKV("subtype", entry.subtype);
# # ]
1108 [ # # # # : 0 : this_prop.pushKV("key", HexStr(entry.key));
# # # # #
# ]
1109 [ # # # # : 0 : this_prop.pushKV("value", HexStr(entry.value));
# # # # #
# ]
1110 [ # # ]: 0 : proprietary.push_back(std::move(this_prop));
1111 : 0 : }
1112 [ # # # # ]: 0 : result.pushKV("proprietary", std::move(proprietary));
1113 : :
1114 : : // Unknown data
1115 : 0 : UniValue unknowns(UniValue::VOBJ);
1116 [ # # # # ]: 0 : for (auto entry : psbtx.unknown) {
1117 [ # # # # : 0 : unknowns.pushKV(HexStr(entry.first), HexStr(entry.second));
# # # # #
# ]
1118 : 0 : }
1119 [ # # # # ]: 0 : result.pushKV("unknown", std::move(unknowns));
1120 : :
1121 : : // inputs
1122 : 0 : CAmount total_in = 0;
1123 : 0 : bool have_all_utxos = true;
1124 : 0 : UniValue inputs(UniValue::VARR);
1125 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.inputs.size(); ++i) {
1126 : 0 : const PSBTInput& input = psbtx.inputs[i];
1127 : 0 : UniValue in(UniValue::VOBJ);
1128 : : // UTXOs
1129 : 0 : bool have_a_utxo = false;
1130 : 0 : CTxOut txout;
1131 [ # # ]: 0 : if (!input.witness_utxo.IsNull()) {
1132 : 0 : txout = input.witness_utxo;
1133 : :
1134 : 0 : UniValue o(UniValue::VOBJ);
1135 [ # # ]: 0 : ScriptToUniv(txout.scriptPubKey, /*out=*/o, /*include_hex=*/true, /*include_address=*/true);
1136 : :
1137 : 0 : UniValue out(UniValue::VOBJ);
1138 [ # # # # : 0 : out.pushKV("amount", ValueFromAmount(txout.nValue));
# # ]
1139 [ # # # # ]: 0 : out.pushKV("scriptPubKey", std::move(o));
1140 : :
1141 [ # # # # ]: 0 : in.pushKV("witness_utxo", std::move(out));
1142 : :
1143 : 0 : have_a_utxo = true;
1144 : 0 : }
1145 [ # # ]: 0 : if (input.non_witness_utxo) {
1146 : 0 : txout = input.non_witness_utxo->vout[psbtx.tx->vin[i].prevout.n];
1147 : :
1148 : 0 : UniValue non_wit(UniValue::VOBJ);
1149 [ # # ]: 0 : TxToUniv(*input.non_witness_utxo, /*block_hash=*/uint256(), /*entry=*/non_wit, /*include_hex=*/false);
1150 [ # # # # ]: 0 : in.pushKV("non_witness_utxo", std::move(non_wit));
1151 : :
1152 : 0 : have_a_utxo = true;
1153 : 0 : }
1154 [ # # ]: 0 : if (have_a_utxo) {
1155 [ # # # # ]: 0 : if (MoneyRange(txout.nValue) && MoneyRange(total_in + txout.nValue)) {
1156 : : total_in += txout.nValue;
1157 : : } else {
1158 : : // Hack to just not show fee later
1159 : : have_all_utxos = false;
1160 : : }
1161 : : } else {
1162 : : have_all_utxos = false;
1163 : : }
1164 : :
1165 : : // Partial sigs
1166 [ # # ]: 0 : if (!input.partial_sigs.empty()) {
1167 : 0 : UniValue partial_sigs(UniValue::VOBJ);
1168 [ # # ]: 0 : for (const auto& sig : input.partial_sigs) {
1169 [ # # # # : 0 : partial_sigs.pushKV(HexStr(sig.second.first), HexStr(sig.second.second));
# # # # #
# ]
1170 : : }
1171 [ # # # # ]: 0 : in.pushKV("partial_signatures", std::move(partial_sigs));
1172 : 0 : }
1173 : :
1174 : : // Sighash
1175 [ # # ]: 0 : if (input.sighash_type != std::nullopt) {
1176 [ # # # # : 0 : in.pushKV("sighash", SighashToStr((unsigned char)*input.sighash_type));
# # # # ]
1177 : : }
1178 : :
1179 : : // Redeem script and witness script
1180 [ # # # # ]: 0 : if (!input.redeem_script.empty()) {
1181 : 0 : UniValue r(UniValue::VOBJ);
1182 [ # # ]: 0 : ScriptToUniv(input.redeem_script, /*out=*/r);
1183 [ # # # # ]: 0 : in.pushKV("redeem_script", std::move(r));
1184 : 0 : }
1185 [ # # # # ]: 0 : if (!input.witness_script.empty()) {
1186 : 0 : UniValue r(UniValue::VOBJ);
1187 [ # # ]: 0 : ScriptToUniv(input.witness_script, /*out=*/r);
1188 [ # # # # ]: 0 : in.pushKV("witness_script", std::move(r));
1189 : 0 : }
1190 : :
1191 : : // keypaths
1192 [ # # ]: 0 : if (!input.hd_keypaths.empty()) {
1193 : 0 : UniValue keypaths(UniValue::VARR);
1194 [ # # # # ]: 0 : for (auto entry : input.hd_keypaths) {
1195 : 0 : UniValue keypath(UniValue::VOBJ);
1196 [ # # # # : 0 : keypath.pushKV("pubkey", HexStr(entry.first));
# # # # ]
1197 : :
1198 [ # # # # : 0 : keypath.pushKV("master_fingerprint", strprintf("%08x", ReadBE32(entry.second.fingerprint)));
# # # # ]
1199 [ # # # # : 0 : keypath.pushKV("path", WriteHDKeypath(entry.second.path));
# # # # ]
1200 [ # # ]: 0 : keypaths.push_back(std::move(keypath));
1201 : 0 : }
1202 [ # # # # ]: 0 : in.pushKV("bip32_derivs", std::move(keypaths));
1203 : 0 : }
1204 : :
1205 : : // Final scriptSig and scriptwitness
1206 [ # # # # ]: 0 : if (!input.final_script_sig.empty()) {
1207 : 0 : UniValue scriptsig(UniValue::VOBJ);
1208 [ # # # # : 0 : scriptsig.pushKV("asm", ScriptToAsmStr(input.final_script_sig, true));
# # # # ]
1209 [ # # # # : 0 : scriptsig.pushKV("hex", HexStr(input.final_script_sig));
# # # # #
# ]
1210 [ # # # # ]: 0 : in.pushKV("final_scriptSig", std::move(scriptsig));
1211 : 0 : }
1212 [ # # ]: 0 : if (!input.final_script_witness.IsNull()) {
1213 : 0 : UniValue txinwitness(UniValue::VARR);
1214 [ # # ]: 0 : for (const auto& item : input.final_script_witness.stack) {
1215 [ # # # # : 0 : txinwitness.push_back(HexStr(item));
# # # # ]
1216 : : }
1217 [ # # # # ]: 0 : in.pushKV("final_scriptwitness", std::move(txinwitness));
1218 : 0 : }
1219 : :
1220 : : // Ripemd160 hash preimages
1221 [ # # ]: 0 : if (!input.ripemd160_preimages.empty()) {
1222 : 0 : UniValue ripemd160_preimages(UniValue::VOBJ);
1223 [ # # # # ]: 0 : for (const auto& [hash, preimage] : input.ripemd160_preimages) {
1224 [ # # # # : 0 : ripemd160_preimages.pushKV(HexStr(hash), HexStr(preimage));
# # # # #
# ]
1225 : : }
1226 [ # # # # ]: 0 : in.pushKV("ripemd160_preimages", std::move(ripemd160_preimages));
1227 : 0 : }
1228 : :
1229 : : // Sha256 hash preimages
1230 [ # # ]: 0 : if (!input.sha256_preimages.empty()) {
1231 : 0 : UniValue sha256_preimages(UniValue::VOBJ);
1232 [ # # # # ]: 0 : for (const auto& [hash, preimage] : input.sha256_preimages) {
1233 [ # # # # : 0 : sha256_preimages.pushKV(HexStr(hash), HexStr(preimage));
# # # # #
# ]
1234 : : }
1235 [ # # # # ]: 0 : in.pushKV("sha256_preimages", std::move(sha256_preimages));
1236 : 0 : }
1237 : :
1238 : : // Hash160 hash preimages
1239 [ # # ]: 0 : if (!input.hash160_preimages.empty()) {
1240 : 0 : UniValue hash160_preimages(UniValue::VOBJ);
1241 [ # # # # ]: 0 : for (const auto& [hash, preimage] : input.hash160_preimages) {
1242 [ # # # # : 0 : hash160_preimages.pushKV(HexStr(hash), HexStr(preimage));
# # # # #
# ]
1243 : : }
1244 [ # # # # ]: 0 : in.pushKV("hash160_preimages", std::move(hash160_preimages));
1245 : 0 : }
1246 : :
1247 : : // Hash256 hash preimages
1248 [ # # ]: 0 : if (!input.hash256_preimages.empty()) {
1249 : 0 : UniValue hash256_preimages(UniValue::VOBJ);
1250 [ # # # # ]: 0 : for (const auto& [hash, preimage] : input.hash256_preimages) {
1251 [ # # # # : 0 : hash256_preimages.pushKV(HexStr(hash), HexStr(preimage));
# # # # #
# ]
1252 : : }
1253 [ # # # # ]: 0 : in.pushKV("hash256_preimages", std::move(hash256_preimages));
1254 : 0 : }
1255 : :
1256 : : // Taproot key path signature
1257 [ # # ]: 0 : if (!input.m_tap_key_sig.empty()) {
1258 [ # # # # : 0 : in.pushKV("taproot_key_path_sig", HexStr(input.m_tap_key_sig));
# # # # #
# ]
1259 : : }
1260 : :
1261 : : // Taproot script path signatures
1262 [ # # ]: 0 : if (!input.m_tap_script_sigs.empty()) {
1263 : 0 : UniValue script_sigs(UniValue::VARR);
1264 [ # # ]: 0 : for (const auto& [pubkey_leaf, sig] : input.m_tap_script_sigs) {
1265 : 0 : const auto& [xonly, leaf_hash] = pubkey_leaf;
1266 : 0 : UniValue sigobj(UniValue::VOBJ);
1267 [ # # # # : 0 : sigobj.pushKV("pubkey", HexStr(xonly));
# # # # ]
1268 [ # # # # : 0 : sigobj.pushKV("leaf_hash", HexStr(leaf_hash));
# # # # ]
1269 [ # # # # : 0 : sigobj.pushKV("sig", HexStr(sig));
# # # # #
# ]
1270 [ # # ]: 0 : script_sigs.push_back(std::move(sigobj));
1271 : 0 : }
1272 [ # # # # ]: 0 : in.pushKV("taproot_script_path_sigs", std::move(script_sigs));
1273 : 0 : }
1274 : :
1275 : : // Taproot leaf scripts
1276 [ # # ]: 0 : if (!input.m_tap_scripts.empty()) {
1277 : 0 : UniValue tap_scripts(UniValue::VARR);
1278 [ # # ]: 0 : for (const auto& [leaf, control_blocks] : input.m_tap_scripts) {
1279 : 0 : const auto& [script, leaf_ver] = leaf;
1280 : 0 : UniValue script_info(UniValue::VOBJ);
1281 [ # # # # : 0 : script_info.pushKV("script", HexStr(script));
# # # # #
# ]
1282 [ # # # # : 0 : script_info.pushKV("leaf_ver", leaf_ver);
# # ]
1283 : 0 : UniValue control_blocks_univ(UniValue::VARR);
1284 [ # # ]: 0 : for (const auto& control_block : control_blocks) {
1285 [ # # # # : 0 : control_blocks_univ.push_back(HexStr(control_block));
# # # # ]
1286 : : }
1287 [ # # # # ]: 0 : script_info.pushKV("control_blocks", std::move(control_blocks_univ));
1288 [ # # ]: 0 : tap_scripts.push_back(std::move(script_info));
1289 : 0 : }
1290 [ # # # # ]: 0 : in.pushKV("taproot_scripts", std::move(tap_scripts));
1291 : 0 : }
1292 : :
1293 : : // Taproot bip32 keypaths
1294 [ # # ]: 0 : if (!input.m_tap_bip32_paths.empty()) {
1295 : 0 : UniValue keypaths(UniValue::VARR);
1296 [ # # ]: 0 : for (const auto& [xonly, leaf_origin] : input.m_tap_bip32_paths) {
1297 : 0 : const auto& [leaf_hashes, origin] = leaf_origin;
1298 : 0 : UniValue path_obj(UniValue::VOBJ);
1299 [ # # # # : 0 : path_obj.pushKV("pubkey", HexStr(xonly));
# # # # ]
1300 [ # # # # : 0 : path_obj.pushKV("master_fingerprint", strprintf("%08x", ReadBE32(origin.fingerprint)));
# # # # ]
1301 [ # # # # : 0 : path_obj.pushKV("path", WriteHDKeypath(origin.path));
# # # # ]
1302 : 0 : UniValue leaf_hashes_arr(UniValue::VARR);
1303 [ # # ]: 0 : for (const auto& leaf_hash : leaf_hashes) {
1304 [ # # # # : 0 : leaf_hashes_arr.push_back(HexStr(leaf_hash));
# # ]
1305 : : }
1306 [ # # # # ]: 0 : path_obj.pushKV("leaf_hashes", std::move(leaf_hashes_arr));
1307 [ # # ]: 0 : keypaths.push_back(std::move(path_obj));
1308 : 0 : }
1309 [ # # # # ]: 0 : in.pushKV("taproot_bip32_derivs", std::move(keypaths));
1310 : 0 : }
1311 : :
1312 : : // Taproot internal key
1313 [ # # ]: 0 : if (!input.m_tap_internal_key.IsNull()) {
1314 [ # # # # : 0 : in.pushKV("taproot_internal_key", HexStr(input.m_tap_internal_key));
# # # # ]
1315 : : }
1316 : :
1317 : : // Write taproot merkle root
1318 [ # # ]: 0 : if (!input.m_tap_merkle_root.IsNull()) {
1319 [ # # # # : 0 : in.pushKV("taproot_merkle_root", HexStr(input.m_tap_merkle_root));
# # # # ]
1320 : : }
1321 : :
1322 : : // Write MuSig2 fields
1323 [ # # ]: 0 : if (!input.m_musig2_participants.empty()) {
1324 : 0 : UniValue musig_pubkeys(UniValue::VARR);
1325 [ # # ]: 0 : for (const auto& [agg, parts] : input.m_musig2_participants) {
1326 : 0 : UniValue musig_part(UniValue::VOBJ);
1327 [ # # # # : 0 : musig_part.pushKV("aggregate_pubkey", HexStr(agg));
# # # # ]
1328 : 0 : UniValue part_pubkeys(UniValue::VARR);
1329 [ # # ]: 0 : for (const auto& pub : parts) {
1330 [ # # # # : 0 : part_pubkeys.push_back(HexStr(pub));
# # ]
1331 : : }
1332 [ # # # # : 0 : musig_part.pushKV("participant_pubkeys", part_pubkeys);
# # ]
1333 [ # # # # ]: 0 : musig_pubkeys.push_back(musig_part);
1334 : 0 : }
1335 [ # # # # : 0 : in.pushKV("musig2_participant_pubkeys", musig_pubkeys);
# # ]
1336 : 0 : }
1337 [ # # ]: 0 : if (!input.m_musig2_pubnonces.empty()) {
1338 : 0 : UniValue musig_pubnonces(UniValue::VARR);
1339 [ # # ]: 0 : for (const auto& [agg_lh, part_pubnonce] : input.m_musig2_pubnonces) {
1340 : 0 : const auto& [agg, lh] = agg_lh;
1341 [ # # ]: 0 : for (const auto& [part, pubnonce] : part_pubnonce) {
1342 : 0 : UniValue info(UniValue::VOBJ);
1343 [ # # # # : 0 : info.pushKV("participant_pubkey", HexStr(part));
# # # # ]
1344 [ # # # # : 0 : info.pushKV("aggregate_pubkey", HexStr(agg));
# # # # ]
1345 [ # # # # : 0 : if (!lh.IsNull()) info.pushKV("leaf_hash", HexStr(lh));
# # # # #
# ]
1346 [ # # # # : 0 : info.pushKV("pubnonce", HexStr(pubnonce));
# # # # #
# ]
1347 [ # # # # ]: 0 : musig_pubnonces.push_back(info);
1348 : 0 : }
1349 : : }
1350 [ # # # # : 0 : in.pushKV("musig2_pubnonces", musig_pubnonces);
# # ]
1351 : 0 : }
1352 [ # # ]: 0 : if (!input.m_musig2_partial_sigs.empty()) {
1353 : 0 : UniValue musig_partial_sigs(UniValue::VARR);
1354 [ # # ]: 0 : for (const auto& [agg_lh, part_psig] : input.m_musig2_partial_sigs) {
1355 : 0 : const auto& [agg, lh] = agg_lh;
1356 [ # # ]: 0 : for (const auto& [part, psig] : part_psig) {
1357 : 0 : UniValue info(UniValue::VOBJ);
1358 [ # # # # : 0 : info.pushKV("participant_pubkey", HexStr(part));
# # # # ]
1359 [ # # # # : 0 : info.pushKV("aggregate_pubkey", HexStr(agg));
# # # # ]
1360 [ # # # # : 0 : if (!lh.IsNull()) info.pushKV("leaf_hash", HexStr(lh));
# # # # #
# ]
1361 [ # # # # : 0 : info.pushKV("partial_sig", HexStr(psig));
# # # # ]
1362 [ # # # # ]: 0 : musig_partial_sigs.push_back(info);
1363 : 0 : }
1364 : : }
1365 [ # # # # : 0 : in.pushKV("musig2_partial_sigs", musig_partial_sigs);
# # ]
1366 : 0 : }
1367 : :
1368 : : // Proprietary
1369 [ # # ]: 0 : if (!input.m_proprietary.empty()) {
1370 : 0 : UniValue proprietary(UniValue::VARR);
1371 [ # # ]: 0 : for (const auto& entry : input.m_proprietary) {
1372 : 0 : UniValue this_prop(UniValue::VOBJ);
1373 [ # # # # : 0 : this_prop.pushKV("identifier", HexStr(entry.identifier));
# # # # #
# ]
1374 [ # # # # : 0 : this_prop.pushKV("subtype", entry.subtype);
# # ]
1375 [ # # # # : 0 : this_prop.pushKV("key", HexStr(entry.key));
# # # # #
# ]
1376 [ # # # # : 0 : this_prop.pushKV("value", HexStr(entry.value));
# # # # #
# ]
1377 [ # # ]: 0 : proprietary.push_back(std::move(this_prop));
1378 : 0 : }
1379 [ # # # # ]: 0 : in.pushKV("proprietary", std::move(proprietary));
1380 : 0 : }
1381 : :
1382 : : // Unknown data
1383 [ # # ]: 0 : if (input.unknown.size() > 0) {
1384 : 0 : UniValue unknowns(UniValue::VOBJ);
1385 [ # # # # ]: 0 : for (auto entry : input.unknown) {
1386 [ # # # # : 0 : unknowns.pushKV(HexStr(entry.first), HexStr(entry.second));
# # # # #
# ]
1387 : 0 : }
1388 [ # # # # ]: 0 : in.pushKV("unknown", std::move(unknowns));
1389 : 0 : }
1390 : :
1391 [ # # ]: 0 : inputs.push_back(std::move(in));
1392 : 0 : }
1393 [ # # # # ]: 0 : result.pushKV("inputs", std::move(inputs));
1394 : :
1395 : : // outputs
1396 : 0 : CAmount output_value = 0;
1397 : 0 : UniValue outputs(UniValue::VARR);
1398 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbtx.outputs.size(); ++i) {
1399 : 0 : const PSBTOutput& output = psbtx.outputs[i];
1400 : 0 : UniValue out(UniValue::VOBJ);
1401 : : // Redeem script and witness script
1402 [ # # # # ]: 0 : if (!output.redeem_script.empty()) {
1403 : 0 : UniValue r(UniValue::VOBJ);
1404 [ # # ]: 0 : ScriptToUniv(output.redeem_script, /*out=*/r);
1405 [ # # # # ]: 0 : out.pushKV("redeem_script", std::move(r));
1406 : 0 : }
1407 [ # # # # ]: 0 : if (!output.witness_script.empty()) {
1408 : 0 : UniValue r(UniValue::VOBJ);
1409 [ # # ]: 0 : ScriptToUniv(output.witness_script, /*out=*/r);
1410 [ # # # # ]: 0 : out.pushKV("witness_script", std::move(r));
1411 : 0 : }
1412 : :
1413 : : // keypaths
1414 [ # # ]: 0 : if (!output.hd_keypaths.empty()) {
1415 : 0 : UniValue keypaths(UniValue::VARR);
1416 [ # # # # ]: 0 : for (auto entry : output.hd_keypaths) {
1417 : 0 : UniValue keypath(UniValue::VOBJ);
1418 [ # # # # : 0 : keypath.pushKV("pubkey", HexStr(entry.first));
# # # # ]
1419 [ # # # # : 0 : keypath.pushKV("master_fingerprint", strprintf("%08x", ReadBE32(entry.second.fingerprint)));
# # # # ]
1420 [ # # # # : 0 : keypath.pushKV("path", WriteHDKeypath(entry.second.path));
# # # # ]
1421 [ # # ]: 0 : keypaths.push_back(std::move(keypath));
1422 : 0 : }
1423 [ # # # # ]: 0 : out.pushKV("bip32_derivs", std::move(keypaths));
1424 : 0 : }
1425 : :
1426 : : // Taproot internal key
1427 [ # # ]: 0 : if (!output.m_tap_internal_key.IsNull()) {
1428 [ # # # # : 0 : out.pushKV("taproot_internal_key", HexStr(output.m_tap_internal_key));
# # # # ]
1429 : : }
1430 : :
1431 : : // Taproot tree
1432 [ # # ]: 0 : if (!output.m_tap_tree.empty()) {
1433 : 0 : UniValue tree(UniValue::VARR);
1434 [ # # ]: 0 : for (const auto& [depth, leaf_ver, script] : output.m_tap_tree) {
1435 : 0 : UniValue elem(UniValue::VOBJ);
1436 [ # # # # : 0 : elem.pushKV("depth", depth);
# # ]
1437 [ # # # # : 0 : elem.pushKV("leaf_ver", leaf_ver);
# # ]
1438 [ # # # # : 0 : elem.pushKV("script", HexStr(script));
# # # # #
# ]
1439 [ # # ]: 0 : tree.push_back(std::move(elem));
1440 : 0 : }
1441 [ # # # # ]: 0 : out.pushKV("taproot_tree", std::move(tree));
1442 : 0 : }
1443 : :
1444 : : // Taproot bip32 keypaths
1445 [ # # ]: 0 : if (!output.m_tap_bip32_paths.empty()) {
1446 : 0 : UniValue keypaths(UniValue::VARR);
1447 [ # # ]: 0 : for (const auto& [xonly, leaf_origin] : output.m_tap_bip32_paths) {
1448 : 0 : const auto& [leaf_hashes, origin] = leaf_origin;
1449 : 0 : UniValue path_obj(UniValue::VOBJ);
1450 [ # # # # : 0 : path_obj.pushKV("pubkey", HexStr(xonly));
# # # # ]
1451 [ # # # # : 0 : path_obj.pushKV("master_fingerprint", strprintf("%08x", ReadBE32(origin.fingerprint)));
# # # # ]
1452 [ # # # # : 0 : path_obj.pushKV("path", WriteHDKeypath(origin.path));
# # # # ]
1453 : 0 : UniValue leaf_hashes_arr(UniValue::VARR);
1454 [ # # ]: 0 : for (const auto& leaf_hash : leaf_hashes) {
1455 [ # # # # : 0 : leaf_hashes_arr.push_back(HexStr(leaf_hash));
# # ]
1456 : : }
1457 [ # # # # ]: 0 : path_obj.pushKV("leaf_hashes", std::move(leaf_hashes_arr));
1458 [ # # ]: 0 : keypaths.push_back(std::move(path_obj));
1459 : 0 : }
1460 [ # # # # ]: 0 : out.pushKV("taproot_bip32_derivs", std::move(keypaths));
1461 : 0 : }
1462 : :
1463 : : // Write MuSig2 fields
1464 [ # # ]: 0 : if (!output.m_musig2_participants.empty()) {
1465 : 0 : UniValue musig_pubkeys(UniValue::VARR);
1466 [ # # ]: 0 : for (const auto& [agg, parts] : output.m_musig2_participants) {
1467 : 0 : UniValue musig_part(UniValue::VOBJ);
1468 [ # # # # : 0 : musig_part.pushKV("aggregate_pubkey", HexStr(agg));
# # # # ]
1469 : 0 : UniValue part_pubkeys(UniValue::VARR);
1470 [ # # ]: 0 : for (const auto& pub : parts) {
1471 [ # # # # : 0 : part_pubkeys.push_back(HexStr(pub));
# # ]
1472 : : }
1473 [ # # # # : 0 : musig_part.pushKV("participant_pubkeys", part_pubkeys);
# # ]
1474 [ # # # # ]: 0 : musig_pubkeys.push_back(musig_part);
1475 : 0 : }
1476 [ # # # # : 0 : out.pushKV("musig2_participant_pubkeys", musig_pubkeys);
# # ]
1477 : 0 : }
1478 : :
1479 : : // Proprietary
1480 [ # # ]: 0 : if (!output.m_proprietary.empty()) {
1481 : 0 : UniValue proprietary(UniValue::VARR);
1482 [ # # ]: 0 : for (const auto& entry : output.m_proprietary) {
1483 : 0 : UniValue this_prop(UniValue::VOBJ);
1484 [ # # # # : 0 : this_prop.pushKV("identifier", HexStr(entry.identifier));
# # # # #
# ]
1485 [ # # # # : 0 : this_prop.pushKV("subtype", entry.subtype);
# # ]
1486 [ # # # # : 0 : this_prop.pushKV("key", HexStr(entry.key));
# # # # #
# ]
1487 [ # # # # : 0 : this_prop.pushKV("value", HexStr(entry.value));
# # # # #
# ]
1488 [ # # ]: 0 : proprietary.push_back(std::move(this_prop));
1489 : 0 : }
1490 [ # # # # ]: 0 : out.pushKV("proprietary", std::move(proprietary));
1491 : 0 : }
1492 : :
1493 : : // Unknown data
1494 [ # # ]: 0 : if (output.unknown.size() > 0) {
1495 : 0 : UniValue unknowns(UniValue::VOBJ);
1496 [ # # # # ]: 0 : for (auto entry : output.unknown) {
1497 [ # # # # : 0 : unknowns.pushKV(HexStr(entry.first), HexStr(entry.second));
# # # # #
# ]
1498 : 0 : }
1499 [ # # # # ]: 0 : out.pushKV("unknown", std::move(unknowns));
1500 : 0 : }
1501 : :
1502 [ # # ]: 0 : outputs.push_back(std::move(out));
1503 : :
1504 : : // Fee calculation
1505 [ # # # # ]: 0 : if (MoneyRange(psbtx.tx->vout[i].nValue) && MoneyRange(output_value + psbtx.tx->vout[i].nValue)) {
1506 : : output_value += psbtx.tx->vout[i].nValue;
1507 : : } else {
1508 : : // Hack to just not show fee later
1509 : : have_all_utxos = false;
1510 : : }
1511 : 0 : }
1512 [ # # # # ]: 0 : result.pushKV("outputs", std::move(outputs));
1513 [ # # ]: 0 : if (have_all_utxos) {
1514 [ # # # # : 0 : result.pushKV("fee", ValueFromAmount(total_in - output_value));
# # ]
1515 : : }
1516 : :
1517 : 0 : return result;
1518 : 0 : },
1519 [ + - + - : 400 : };
+ + - - ]
1520 [ + - + - : 2720 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - -
- - - -
- ]
1521 : :
1522 : 80 : static RPCMethod combinepsbt()
1523 : : {
1524 : 80 : return RPCMethod{
1525 : 80 : "combinepsbt",
1526 [ + - ]: 160 : "Combine multiple partially signed Bitcoin transactions into one transaction.\n"
1527 : : "Implements the Combiner role.\n",
1528 : : {
1529 [ + - + - ]: 160 : {"txs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The base64 strings of partially signed transactions",
1530 : : {
1531 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "A base64 string of a PSBT"},
1532 : : },
1533 : : },
1534 : : },
1535 [ + - ]: 160 : RPCResult{
1536 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The base64-encoded partially signed transaction"
1537 [ + - ]: 160 : },
1538 : 80 : RPCExamples{
1539 [ + - + - : 160 : HelpExampleCli("combinepsbt", R"('["mybase64_1", "mybase64_2", "mybase64_3"]')")
+ - ]
1540 [ + - ]: 80 : },
1541 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1542 : : {
1543 : : // Unserialize the transactions
1544 : 0 : std::vector<PartiallySignedTransaction> psbtxs;
1545 [ # # # # : 0 : UniValue txs = request.params[0].get_array();
# # ]
1546 [ # # # # ]: 0 : if (txs.empty()) {
1547 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Parameter 'txs' cannot be empty");
1548 : : }
1549 [ # # # # ]: 0 : for (unsigned int i = 0; i < txs.size(); ++i) {
1550 : 0 : PartiallySignedTransaction psbtx;
1551 [ # # ]: 0 : std::string error;
1552 [ # # # # : 0 : if (!DecodeBase64PSBT(psbtx, txs[i].get_str(), error)) {
# # # # ]
1553 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
1554 : : }
1555 [ # # ]: 0 : psbtxs.push_back(psbtx);
1556 : 0 : }
1557 : :
1558 : 0 : PartiallySignedTransaction merged_psbt;
1559 [ # # # # ]: 0 : if (!CombinePSBTs(merged_psbt, psbtxs)) {
1560 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "PSBTs not compatible (different transactions)");
1561 : : }
1562 : :
1563 : 0 : DataStream ssTx{};
1564 [ # # ]: 0 : ssTx << merged_psbt;
1565 [ # # # # : 0 : return EncodeBase64(ssTx);
# # ]
1566 : 0 : },
1567 [ + - + - : 640 : };
+ - + + +
+ - - -
- ]
1568 [ + - + - ]: 320 : }
1569 : :
1570 : 80 : static RPCMethod finalizepsbt()
1571 : : {
1572 : 80 : return RPCMethod{"finalizepsbt",
1573 [ + - ]: 160 : "Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a\n"
1574 : : "network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be\n"
1575 : : "created which has the final_scriptSig and final_scriptwitness fields filled for inputs that are complete.\n"
1576 : : "Implements the Finalizer and Extractor roles.\n",
1577 : : {
1578 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "A base64 string of a PSBT"},
1579 [ + - + - : 240 : {"extract", RPCArg::Type::BOOL, RPCArg::Default{true}, "If true and the transaction is complete,\n"
+ - ]
1580 : : " extract and return the complete transaction in normal network serialization instead of the PSBT."},
1581 : : },
1582 [ + - ]: 160 : RPCResult{
1583 [ + - + - ]: 160 : RPCResult::Type::OBJ, "", "",
1584 : : {
1585 [ + - + - ]: 160 : {RPCResult::Type::STR, "psbt", /*optional=*/true, "The base64-encoded partially signed transaction if not extracted"},
1586 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "The hex-encoded network transaction if extracted"},
1587 [ + - + - ]: 160 : {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
1588 : : }
1589 [ + - + - : 640 : },
+ + - - ]
1590 : 80 : RPCExamples{
1591 [ + - + - : 160 : HelpExampleCli("finalizepsbt", "\"psbt\"")
+ - ]
1592 [ + - ]: 80 : },
1593 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1594 : : {
1595 : : // Unserialize the transactions
1596 : 0 : PartiallySignedTransaction psbtx;
1597 [ # # ]: 0 : std::string error;
1598 [ # # # # : 0 : if (!DecodeBase64PSBT(psbtx, request.params[0].get_str(), error)) {
# # # # ]
1599 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
1600 : : }
1601 : :
1602 [ # # # # : 0 : bool extract = request.params[1].isNull() || (!request.params[1].isNull() && request.params[1].get_bool());
# # # # #
# # # #
# ]
1603 : :
1604 [ # # ]: 0 : CMutableTransaction mtx;
1605 [ # # ]: 0 : bool complete = FinalizeAndExtractPSBT(psbtx, mtx);
1606 : :
1607 : 0 : UniValue result(UniValue::VOBJ);
1608 : 0 : DataStream ssTx{};
1609 [ # # ]: 0 : std::string result_str;
1610 : :
1611 [ # # # # ]: 0 : if (complete && extract) {
1612 [ # # ]: 0 : ssTx << TX_WITH_WITNESS(mtx);
1613 [ # # # # ]: 0 : result_str = HexStr(ssTx);
1614 [ # # # # : 0 : result.pushKV("hex", result_str);
# # ]
1615 : : } else {
1616 [ # # ]: 0 : ssTx << psbtx;
1617 [ # # # # ]: 0 : result_str = EncodeBase64(ssTx.str());
1618 [ # # # # : 0 : result.pushKV("psbt", result_str);
# # ]
1619 : : }
1620 [ # # # # : 0 : result.pushKV("complete", complete);
# # ]
1621 : :
1622 : 0 : return result;
1623 : 0 : },
1624 [ + - + - : 480 : };
+ + - - ]
1625 [ + - + - : 800 : }
+ - + - +
- - - -
- ]
1626 : :
1627 : 80 : static RPCMethod createpsbt()
1628 : : {
1629 : 80 : return RPCMethod{
1630 : 80 : "createpsbt",
1631 [ + - ]: 160 : "Creates a transaction in the Partially Signed Transaction format.\n"
1632 : : "Implements the Creator role.\n"
1633 : : "Note that the transaction's inputs are not signed, and\n"
1634 : : "it is not stored in the wallet or transmitted to the network.\n",
1635 [ + - ]: 160 : CreateTxDoc(),
1636 [ + - ]: 160 : RPCResult{
1637 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The resulting raw transaction (base64-encoded string)"
1638 [ + - ]: 160 : },
1639 : 80 : RPCExamples{
1640 [ + - + - : 160 : HelpExampleCli("createpsbt", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
+ - ]
1641 [ + - ]: 80 : },
1642 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1643 : : {
1644 : :
1645 : 0 : std::optional<bool> rbf;
1646 [ # # ]: 0 : if (!request.params[3].isNull()) {
1647 : 0 : rbf = request.params[3].get_bool();
1648 : : }
1649 : 0 : CMutableTransaction rawTx = ConstructTransaction(request.params[0], request.params[1], request.params[2], rbf, self.Arg<uint32_t>("version"));
1650 : :
1651 : : // Make a blank psbt
1652 : 0 : PartiallySignedTransaction psbtx;
1653 [ # # ]: 0 : psbtx.tx = rawTx;
1654 [ # # # # ]: 0 : for (unsigned int i = 0; i < rawTx.vin.size(); ++i) {
1655 [ # # ]: 0 : psbtx.inputs.emplace_back();
1656 : : }
1657 [ # # # # ]: 0 : for (unsigned int i = 0; i < rawTx.vout.size(); ++i) {
1658 [ # # ]: 0 : psbtx.outputs.emplace_back();
1659 : : }
1660 : :
1661 : : // Serialize the PSBT
1662 : 0 : DataStream ssTx{};
1663 [ # # ]: 0 : ssTx << psbtx;
1664 : :
1665 [ # # # # : 0 : return EncodeBase64(ssTx);
# # ]
1666 : 0 : },
1667 [ + - ]: 160 : };
1668 : : }
1669 : :
1670 : 80 : static RPCMethod converttopsbt()
1671 : : {
1672 : 80 : return RPCMethod{
1673 : 80 : "converttopsbt",
1674 [ + - ]: 160 : "Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction\n"
1675 : : "createpsbt and walletcreatefundedpsbt should be used for new applications.\n",
1676 : : {
1677 [ + - + - ]: 160 : {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex string of a raw transaction"},
1678 [ + - + - : 240 : {"permitsigdata", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, any signatures in the input will be discarded and conversion\n"
+ - ]
1679 : : " will continue. If false, RPC will fail if any signatures are present."},
1680 [ + - + - : 240 : {"iswitness", RPCArg::Type::BOOL, RPCArg::DefaultHint{"depends on heuristic tests"}, "Whether the transaction hex is a serialized witness transaction.\n"
+ - ]
1681 : : "If iswitness is not present, heuristic tests will be used in decoding.\n"
1682 : : "If true, only witness deserialization will be tried.\n"
1683 : : "If false, only non-witness deserialization will be tried.\n"
1684 : : "This boolean should reflect whether the transaction has inputs\n"
1685 : : "(e.g. fully valid, or on-chain transactions), if known by the caller."
1686 : : },
1687 : : },
1688 [ + - ]: 160 : RPCResult{
1689 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The resulting raw transaction (base64-encoded string)"
1690 [ + - ]: 160 : },
1691 : 80 : RPCExamples{
1692 : : "\nCreate a transaction\n"
1693 [ + - + - : 160 : + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
+ - + - ]
1694 : 80 : "\nConvert the transaction to a PSBT\n"
1695 [ + - + - : 320 : + HelpExampleCli("converttopsbt", "\"rawtransaction\"")
+ - + - ]
1696 [ + - ]: 80 : },
1697 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1698 : : {
1699 : : // parse hex string from parameter
1700 : 0 : CMutableTransaction tx;
1701 [ # # # # : 0 : bool permitsigdata = request.params[1].isNull() ? false : request.params[1].get_bool();
# # # # ]
1702 [ # # # # ]: 0 : bool witness_specified = !request.params[2].isNull();
1703 [ # # # # : 0 : bool iswitness = witness_specified ? request.params[2].get_bool() : false;
# # ]
1704 : 0 : const bool try_witness = witness_specified ? iswitness : true;
1705 : 0 : const bool try_no_witness = witness_specified ? !iswitness : true;
1706 [ # # # # : 0 : if (!DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
# # # # ]
1707 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed");
1708 : : }
1709 : :
1710 : : // Remove all scriptSigs and scriptWitnesses from inputs
1711 [ # # ]: 0 : for (CTxIn& input : tx.vin) {
1712 [ # # # # : 0 : if ((!input.scriptSig.empty() || !input.scriptWitness.IsNull()) && !permitsigdata) {
# # # # ]
1713 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Inputs must not have scriptSigs and scriptWitnesses");
1714 : : }
1715 : 0 : input.scriptSig.clear();
1716 : 0 : input.scriptWitness.SetNull();
1717 : : }
1718 : :
1719 : : // Make a blank psbt
1720 : 0 : PartiallySignedTransaction psbtx;
1721 [ # # ]: 0 : psbtx.tx = tx;
1722 [ # # # # ]: 0 : for (unsigned int i = 0; i < tx.vin.size(); ++i) {
1723 [ # # ]: 0 : psbtx.inputs.emplace_back();
1724 : : }
1725 [ # # # # ]: 0 : for (unsigned int i = 0; i < tx.vout.size(); ++i) {
1726 [ # # ]: 0 : psbtx.outputs.emplace_back();
1727 : : }
1728 : :
1729 : : // Serialize the PSBT
1730 : 0 : DataStream ssTx{};
1731 [ # # ]: 0 : ssTx << psbtx;
1732 : :
1733 [ # # # # : 0 : return EncodeBase64(ssTx);
# # ]
1734 : 0 : },
1735 [ + - + - : 560 : };
+ + - - ]
1736 [ + - + - : 480 : }
+ - - - ]
1737 : :
1738 : 80 : static RPCMethod utxoupdatepsbt()
1739 : : {
1740 : 80 : return RPCMethod{
1741 : 80 : "utxoupdatepsbt",
1742 [ + - ]: 160 : "Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.\n",
1743 : : {
1744 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "A base64 string of a PSBT"},
1745 [ + - + - ]: 160 : {"descriptors", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "An array of either strings or objects", {
1746 [ + - + - ]: 160 : {"", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "An output descriptor"},
1747 [ + - + - ]: 160 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "An object with an output descriptor and extra information", {
1748 [ + - + - ]: 160 : {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
1749 [ + - + - : 240 : {"range", RPCArg::Type::RANGE, RPCArg::Default{1000}, "Up to what index HD chains should be explored (either end or [begin,end])"},
+ - ]
1750 : : }},
1751 : : }},
1752 : : },
1753 [ + - ]: 160 : RPCResult {
1754 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The base64-encoded partially signed transaction with inputs updated"
1755 [ + - ]: 160 : },
1756 : 80 : RPCExamples {
1757 [ + - + - : 160 : HelpExampleCli("utxoupdatepsbt", "\"psbt\"")
+ - ]
1758 [ + - ]: 80 : },
1759 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1760 : : {
1761 : : // Parse descriptors, if any.
1762 : 0 : FlatSigningProvider provider;
1763 [ # # # # ]: 0 : if (!request.params[1].isNull()) {
1764 [ # # # # : 0 : auto descs = request.params[1].get_array();
# # ]
1765 [ # # # # ]: 0 : for (size_t i = 0; i < descs.size(); ++i) {
1766 [ # # # # ]: 0 : EvalDescriptorStringOrObject(descs[i], provider);
1767 : : }
1768 : 0 : }
1769 : :
1770 : : // We don't actually need private keys further on; hide them as a precaution.
1771 : 0 : const PartiallySignedTransaction& psbtx = ProcessPSBT(
1772 : 0 : request.params[0].get_str(),
1773 : 0 : request.context,
1774 [ # # ]: 0 : HidingSigningProvider(&provider, /*hide_secret=*/true, /*hide_origin=*/false),
1775 : : /*sighash_type=*/std::nullopt,
1776 [ # # # # : 0 : /*finalize=*/false);
# # # # ]
1777 : :
1778 : 0 : DataStream ssTx{};
1779 [ # # ]: 0 : ssTx << psbtx;
1780 [ # # # # : 0 : return EncodeBase64(ssTx);
# # ]
1781 : 0 : },
1782 [ + - + - : 1120 : };
+ - + - +
+ + + + +
- - - - -
- ]
1783 [ + - + - : 960 : }
+ - + - +
- + - - -
- - - - ]
1784 : :
1785 : 80 : static RPCMethod joinpsbts()
1786 : : {
1787 : 80 : return RPCMethod{
1788 : 80 : "joinpsbts",
1789 [ + - ]: 160 : "Joins multiple distinct PSBTs with different inputs and outputs into one PSBT with inputs and outputs from all of the PSBTs\n"
1790 : : "No input in any of the PSBTs can be in more than one of the PSBTs.\n",
1791 : : {
1792 [ + - + - ]: 160 : {"txs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The base64 strings of partially signed transactions",
1793 : : {
1794 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "A base64 string of a PSBT"}
1795 : : }}
1796 : : },
1797 [ + - ]: 160 : RPCResult {
1798 [ + - + - ]: 160 : RPCResult::Type::STR, "", "The base64-encoded partially signed transaction"
1799 [ + - ]: 160 : },
1800 : 80 : RPCExamples {
1801 [ + - + - : 160 : HelpExampleCli("joinpsbts", "\"psbt\"")
+ - ]
1802 [ + - ]: 80 : },
1803 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1804 : : {
1805 : : // Unserialize the transactions
1806 : 0 : std::vector<PartiallySignedTransaction> psbtxs;
1807 [ # # # # : 0 : UniValue txs = request.params[0].get_array();
# # ]
1808 : :
1809 [ # # # # ]: 0 : if (txs.size() <= 1) {
1810 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "At least two PSBTs are required to join PSBTs.");
1811 : : }
1812 : :
1813 : : uint32_t best_version = 1;
1814 : : uint32_t best_locktime = 0xffffffff;
1815 [ # # # # ]: 0 : for (unsigned int i = 0; i < txs.size(); ++i) {
1816 : 0 : PartiallySignedTransaction psbtx;
1817 [ # # ]: 0 : std::string error;
1818 [ # # # # : 0 : if (!DecodeBase64PSBT(psbtx, txs[i].get_str(), error)) {
# # # # ]
1819 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
1820 : : }
1821 [ # # ]: 0 : psbtxs.push_back(psbtx);
1822 : : // Choose the highest version number
1823 [ # # ]: 0 : if (psbtx.tx->version > best_version) {
1824 : 0 : best_version = psbtx.tx->version;
1825 : : }
1826 : : // Choose the lowest lock time
1827 [ # # ]: 0 : if (psbtx.tx->nLockTime < best_locktime) {
1828 : 0 : best_locktime = psbtx.tx->nLockTime;
1829 : : }
1830 : 0 : }
1831 : :
1832 : : // Create a blank psbt where everything will be added
1833 : 0 : PartiallySignedTransaction merged_psbt;
1834 [ # # ]: 0 : merged_psbt.tx = CMutableTransaction();
1835 : 0 : merged_psbt.tx->version = best_version;
1836 : 0 : merged_psbt.tx->nLockTime = best_locktime;
1837 : :
1838 : : // Merge
1839 [ # # ]: 0 : for (auto& psbt : psbtxs) {
1840 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbt.tx->vin.size(); ++i) {
1841 [ # # # # ]: 0 : if (!merged_psbt.AddInput(psbt.tx->vin[i], psbt.inputs[i])) {
1842 [ # # # # : 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Input %s:%d exists in multiple PSBTs", psbt.tx->vin[i].prevout.hash.ToString(), psbt.tx->vin[i].prevout.n));
# # ]
1843 : : }
1844 : : }
1845 [ # # # # ]: 0 : for (unsigned int i = 0; i < psbt.tx->vout.size(); ++i) {
1846 [ # # ]: 0 : merged_psbt.AddOutput(psbt.tx->vout[i], psbt.outputs[i]);
1847 : : }
1848 [ # # ]: 0 : for (auto& xpub_pair : psbt.m_xpubs) {
1849 [ # # ]: 0 : if (!merged_psbt.m_xpubs.contains(xpub_pair.first)) {
1850 [ # # # # ]: 0 : merged_psbt.m_xpubs[xpub_pair.first] = xpub_pair.second;
1851 : : } else {
1852 [ # # # # ]: 0 : merged_psbt.m_xpubs[xpub_pair.first].insert(xpub_pair.second.begin(), xpub_pair.second.end());
1853 : : }
1854 : : }
1855 [ # # ]: 0 : merged_psbt.unknown.insert(psbt.unknown.begin(), psbt.unknown.end());
1856 : : }
1857 : :
1858 : : // Generate list of shuffled indices for shuffling inputs and outputs of the merged PSBT
1859 [ # # # # ]: 0 : std::vector<int> input_indices(merged_psbt.inputs.size());
1860 : 0 : std::iota(input_indices.begin(), input_indices.end(), 0);
1861 [ # # # # ]: 0 : std::vector<int> output_indices(merged_psbt.outputs.size());
1862 : 0 : std::iota(output_indices.begin(), output_indices.end(), 0);
1863 : :
1864 : : // Shuffle input and output indices lists
1865 : 0 : std::shuffle(input_indices.begin(), input_indices.end(), FastRandomContext());
1866 : 0 : std::shuffle(output_indices.begin(), output_indices.end(), FastRandomContext());
1867 : :
1868 : 0 : PartiallySignedTransaction shuffled_psbt;
1869 [ # # ]: 0 : shuffled_psbt.tx = CMutableTransaction();
1870 : 0 : shuffled_psbt.tx->version = merged_psbt.tx->version;
1871 : 0 : shuffled_psbt.tx->nLockTime = merged_psbt.tx->nLockTime;
1872 [ # # ]: 0 : for (int i : input_indices) {
1873 [ # # ]: 0 : shuffled_psbt.AddInput(merged_psbt.tx->vin[i], merged_psbt.inputs[i]);
1874 : : }
1875 [ # # ]: 0 : for (int i : output_indices) {
1876 [ # # ]: 0 : shuffled_psbt.AddOutput(merged_psbt.tx->vout[i], merged_psbt.outputs[i]);
1877 : : }
1878 [ # # ]: 0 : shuffled_psbt.unknown.insert(merged_psbt.unknown.begin(), merged_psbt.unknown.end());
1879 : :
1880 : 0 : DataStream ssTx{};
1881 [ # # ]: 0 : ssTx << shuffled_psbt;
1882 [ # # # # : 0 : return EncodeBase64(ssTx);
# # ]
1883 : 0 : },
1884 [ + - + - : 640 : };
+ - + + +
+ - - -
- ]
1885 [ + - + - ]: 320 : }
1886 : :
1887 : 80 : static RPCMethod analyzepsbt()
1888 : : {
1889 : 80 : return RPCMethod{
1890 : 80 : "analyzepsbt",
1891 [ + - ]: 160 : "Analyzes and provides information about the current status of a PSBT and its inputs\n",
1892 : : {
1893 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "A base64 string of a PSBT"}
1894 : : },
1895 [ + - ]: 160 : RPCResult {
1896 [ + - + - ]: 160 : RPCResult::Type::OBJ, "", "",
1897 : : {
1898 [ + - + - ]: 160 : {RPCResult::Type::ARR, "inputs", /*optional=*/true, "",
1899 : : {
1900 [ + - + - ]: 160 : {RPCResult::Type::OBJ, "", "",
1901 : : {
1902 [ + - + - ]: 160 : {RPCResult::Type::BOOL, "has_utxo", "Whether a UTXO is provided"},
1903 [ + - + - ]: 160 : {RPCResult::Type::BOOL, "is_final", "Whether the input is finalized"},
1904 [ + - + - ]: 160 : {RPCResult::Type::OBJ, "missing", /*optional=*/true, "Things that are missing that are required to complete this input",
1905 : : {
1906 [ + - + - ]: 160 : {RPCResult::Type::ARR, "pubkeys", /*optional=*/true, "",
1907 : : {
1908 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "keyid", "Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing"},
1909 : : }},
1910 [ + - + - ]: 160 : {RPCResult::Type::ARR, "signatures", /*optional=*/true, "",
1911 : : {
1912 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "keyid", "Public key ID, hash160 of the public key, of a public key whose signature is missing"},
1913 : : }},
1914 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "redeemscript", /*optional=*/true, "Hash160 of the redeem script that is missing"},
1915 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "witnessscript", /*optional=*/true, "SHA256 of the witness script that is missing"},
1916 : : }},
1917 [ + - + - ]: 160 : {RPCResult::Type::STR, "next", /*optional=*/true, "Role of the next person that this input needs to go to"},
1918 : : }},
1919 : : }},
1920 [ + - + - ]: 160 : {RPCResult::Type::NUM, "estimated_vsize", /*optional=*/true, "Estimated vsize of the final signed transaction"},
1921 [ + - + - ]: 160 : {RPCResult::Type::STR_AMOUNT, "estimated_feerate", /*optional=*/true, "Estimated feerate of the final signed transaction in " + CURRENCY_UNIT + "/kvB. Shown only if all UTXO slots in the PSBT have been filled"},
1922 [ + - + - ]: 160 : {RPCResult::Type::STR_AMOUNT, "fee", /*optional=*/true, "The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled"},
1923 [ + - + - ]: 160 : {RPCResult::Type::STR, "next", "Role of the next person that this psbt needs to go to"},
1924 [ + - + - ]: 160 : {RPCResult::Type::STR, "error", /*optional=*/true, "Error message (if there is one)"},
1925 : : }
1926 [ + - + - : 3280 : },
+ - + - +
- + - + -
+ + + + +
+ + + + +
+ + - - -
- - - - -
- - - - ]
1927 : 80 : RPCExamples {
1928 [ + - + - : 160 : HelpExampleCli("analyzepsbt", "\"psbt\"")
+ - ]
1929 [ + - ]: 80 : },
1930 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1931 : : {
1932 : : // Unserialize the transaction
1933 : 0 : PartiallySignedTransaction psbtx;
1934 [ # # ]: 0 : std::string error;
1935 [ # # # # : 0 : if (!DecodeBase64PSBT(psbtx, request.params[0].get_str(), error)) {
# # # # ]
1936 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", error));
1937 : : }
1938 : :
1939 [ # # # # ]: 0 : PSBTAnalysis psbta = AnalyzePSBT(psbtx);
1940 : :
1941 : 0 : UniValue result(UniValue::VOBJ);
1942 : 0 : UniValue inputs_result(UniValue::VARR);
1943 [ # # ]: 0 : for (const auto& input : psbta.inputs) {
1944 : 0 : UniValue input_univ(UniValue::VOBJ);
1945 : 0 : UniValue missing(UniValue::VOBJ);
1946 : :
1947 [ # # # # : 0 : input_univ.pushKV("has_utxo", input.has_utxo);
# # ]
1948 [ # # # # : 0 : input_univ.pushKV("is_final", input.is_final);
# # ]
1949 [ # # # # : 0 : input_univ.pushKV("next", PSBTRoleName(input.next));
# # # # ]
1950 : :
1951 [ # # ]: 0 : if (!input.missing_pubkeys.empty()) {
1952 : 0 : UniValue missing_pubkeys_univ(UniValue::VARR);
1953 [ # # ]: 0 : for (const CKeyID& pubkey : input.missing_pubkeys) {
1954 [ # # # # : 0 : missing_pubkeys_univ.push_back(HexStr(pubkey));
# # ]
1955 : : }
1956 [ # # # # ]: 0 : missing.pushKV("pubkeys", std::move(missing_pubkeys_univ));
1957 : 0 : }
1958 [ # # ]: 0 : if (!input.missing_redeem_script.IsNull()) {
1959 [ # # # # : 0 : missing.pushKV("redeemscript", HexStr(input.missing_redeem_script));
# # # # ]
1960 : : }
1961 [ # # ]: 0 : if (!input.missing_witness_script.IsNull()) {
1962 [ # # # # : 0 : missing.pushKV("witnessscript", HexStr(input.missing_witness_script));
# # # # ]
1963 : : }
1964 [ # # ]: 0 : if (!input.missing_sigs.empty()) {
1965 : 0 : UniValue missing_sigs_univ(UniValue::VARR);
1966 [ # # ]: 0 : for (const CKeyID& pubkey : input.missing_sigs) {
1967 [ # # # # : 0 : missing_sigs_univ.push_back(HexStr(pubkey));
# # ]
1968 : : }
1969 [ # # # # ]: 0 : missing.pushKV("signatures", std::move(missing_sigs_univ));
1970 : 0 : }
1971 [ # # # # ]: 0 : if (!missing.getKeys().empty()) {
1972 [ # # # # ]: 0 : input_univ.pushKV("missing", std::move(missing));
1973 : : }
1974 [ # # ]: 0 : inputs_result.push_back(std::move(input_univ));
1975 : 0 : }
1976 [ # # # # : 0 : if (!inputs_result.empty()) result.pushKV("inputs", std::move(inputs_result));
# # # # ]
1977 : :
1978 [ # # ]: 0 : if (psbta.estimated_vsize != std::nullopt) {
1979 [ # # # # : 0 : result.pushKV("estimated_vsize", *psbta.estimated_vsize);
# # ]
1980 : : }
1981 [ # # ]: 0 : if (psbta.estimated_feerate != std::nullopt) {
1982 [ # # # # : 0 : result.pushKV("estimated_feerate", ValueFromAmount(psbta.estimated_feerate->GetFeePerK()));
# # ]
1983 : : }
1984 [ # # ]: 0 : if (psbta.fee != std::nullopt) {
1985 [ # # # # : 0 : result.pushKV("fee", ValueFromAmount(*psbta.fee));
# # ]
1986 : : }
1987 [ # # # # : 0 : result.pushKV("next", PSBTRoleName(psbta.next));
# # # # ]
1988 [ # # ]: 0 : if (!psbta.error.empty()) {
1989 [ # # # # : 0 : result.pushKV("error", psbta.error);
# # ]
1990 : : }
1991 : :
1992 : 0 : return result;
1993 : 0 : },
1994 [ + - + - : 400 : };
+ + - - ]
1995 [ + - + - : 2880 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - ]
1996 : :
1997 : 80 : RPCMethod descriptorprocesspsbt()
1998 : : {
1999 : 80 : return RPCMethod{
2000 : 80 : "descriptorprocesspsbt",
2001 [ + - ]: 160 : "Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool. \n"
2002 : : "Then, sign the inputs we are able to with information from the output descriptors. ",
2003 : : {
2004 [ + - + - ]: 160 : {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction base64 string"},
2005 [ + - + - ]: 160 : {"descriptors", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of either strings or objects", {
2006 [ + - + - ]: 160 : {"", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "An output descriptor"},
2007 [ + - + - ]: 160 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "An object with an output descriptor and extra information", {
2008 [ + - + - ]: 160 : {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
2009 [ + - + - : 240 : {"range", RPCArg::Type::RANGE, RPCArg::Default{1000}, "Up to what index HD chains should be explored (either end or [begin,end])"},
+ - ]
2010 : : }},
2011 : : }},
2012 [ + - + - : 240 : {"sighashtype", RPCArg::Type::STR, RPCArg::Default{"DEFAULT for Taproot, ALL otherwise"}, "The signature hash type to sign with if not specified by the PSBT. Must be one of\n"
+ - ]
2013 : : " \"DEFAULT\"\n"
2014 : : " \"ALL\"\n"
2015 : : " \"NONE\"\n"
2016 : : " \"SINGLE\"\n"
2017 : : " \"ALL|ANYONECANPAY\"\n"
2018 : : " \"NONE|ANYONECANPAY\"\n"
2019 : : " \"SINGLE|ANYONECANPAY\""},
2020 [ + - + - : 240 : {"bip32derivs", RPCArg::Type::BOOL, RPCArg::Default{true}, "Include BIP 32 derivation paths for public keys if we know them"},
+ - ]
2021 [ + - + - : 240 : {"finalize", RPCArg::Type::BOOL, RPCArg::Default{true}, "Also finalize inputs if possible"},
+ - ]
2022 : : },
2023 [ + - ]: 160 : RPCResult{
2024 [ + - + - ]: 160 : RPCResult::Type::OBJ, "", "",
2025 : : {
2026 [ + - + - ]: 160 : {RPCResult::Type::STR, "psbt", "The base64-encoded partially signed transaction"},
2027 [ + - + - ]: 160 : {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
2028 [ + - + - ]: 160 : {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "The hex-encoded network transaction if complete"},
2029 : : }
2030 [ + - + - : 640 : },
+ + - - ]
2031 : 80 : RPCExamples{
2032 [ + - + - : 160 : HelpExampleCli("descriptorprocesspsbt", "\"psbt\" \"[\\\"descriptor1\\\", \\\"descriptor2\\\"]\"") +
+ - ]
2033 [ + - + - : 240 : HelpExampleCli("descriptorprocesspsbt", "\"psbt\" \"[{\\\"desc\\\":\\\"mydescriptor\\\", \\\"range\\\":21}]\"")
+ - + - ]
2034 [ + - ]: 80 : },
2035 : 80 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
2036 : : {
2037 : : // Add descriptor information to a signing provider
2038 : 0 : FlatSigningProvider provider;
2039 : :
2040 [ # # # # : 0 : auto descs = request.params[1].get_array();
# # ]
2041 [ # # # # ]: 0 : for (size_t i = 0; i < descs.size(); ++i) {
2042 [ # # # # ]: 0 : EvalDescriptorStringOrObject(descs[i], provider, /*expand_priv=*/true);
2043 : : }
2044 : :
2045 [ # # # # ]: 0 : std::optional<int> sighash_type = ParseSighashString(request.params[2]);
2046 [ # # # # : 0 : bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
# # # # ]
2047 [ # # # # : 0 : bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
# # # # ]
2048 : :
2049 : 0 : const PartiallySignedTransaction& psbtx = ProcessPSBT(
2050 : 0 : request.params[0].get_str(),
2051 [ # # ]: 0 : request.context,
2052 : 0 : HidingSigningProvider(&provider, /*hide_secret=*/false, !bip32derivs),
2053 : : sighash_type,
2054 [ # # # # : 0 : finalize);
# # ]
2055 : :
2056 : : // Check whether or not all of the inputs are now signed
2057 : 0 : bool complete = true;
2058 [ # # ]: 0 : for (const auto& input : psbtx.inputs) {
2059 [ # # ]: 0 : complete &= PSBTInputSigned(input);
2060 : : }
2061 : :
2062 : 0 : DataStream ssTx{};
2063 [ # # ]: 0 : ssTx << psbtx;
2064 : :
2065 : 0 : UniValue result(UniValue::VOBJ);
2066 : :
2067 [ # # # # : 0 : result.pushKV("psbt", EncodeBase64(ssTx));
# # # # #
# ]
2068 [ # # # # : 0 : result.pushKV("complete", complete);
# # ]
2069 [ # # ]: 0 : if (complete) {
2070 [ # # ]: 0 : CMutableTransaction mtx;
2071 [ # # ]: 0 : PartiallySignedTransaction psbtx_copy = psbtx;
2072 [ # # # # ]: 0 : CHECK_NONFATAL(FinalizeAndExtractPSBT(psbtx_copy, mtx));
2073 : 0 : DataStream ssTx_final;
2074 [ # # ]: 0 : ssTx_final << TX_WITH_WITNESS(mtx);
2075 [ # # # # : 0 : result.pushKV("hex", HexStr(ssTx_final));
# # # # #
# ]
2076 : 0 : }
2077 : 0 : return result;
2078 : 0 : },
2079 [ + - + - : 1360 : };
+ - + - +
+ + + + +
- - - - -
- ]
2080 [ + - + - : 1920 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
- - - - -
- - - ]
2081 : :
2082 : 153 : void RegisterRawTransactionRPCCommands(CRPCTable& t)
2083 : : {
2084 : 153 : static const CRPCCommand commands[]{
2085 [ + - ]: 80 : {"rawtransactions", &getrawtransaction},
2086 [ + - ]: 80 : {"rawtransactions", &createrawtransaction},
2087 [ + - ]: 80 : {"rawtransactions", &decoderawtransaction},
2088 [ + - ]: 80 : {"rawtransactions", &decodescript},
2089 [ + - ]: 80 : {"rawtransactions", &combinerawtransaction},
2090 [ + - ]: 80 : {"rawtransactions", &signrawtransactionwithkey},
2091 [ + - ]: 80 : {"rawtransactions", &decodepsbt},
2092 [ + - ]: 80 : {"rawtransactions", &combinepsbt},
2093 [ + - ]: 80 : {"rawtransactions", &finalizepsbt},
2094 [ + - ]: 80 : {"rawtransactions", &createpsbt},
2095 [ + - ]: 80 : {"rawtransactions", &converttopsbt},
2096 [ + - ]: 80 : {"rawtransactions", &utxoupdatepsbt},
2097 [ + - ]: 80 : {"rawtransactions", &descriptorprocesspsbt},
2098 [ + - ]: 80 : {"rawtransactions", &joinpsbts},
2099 [ + - ]: 80 : {"rawtransactions", &analyzepsbt},
2100 [ + + + - : 793 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - ]
2101 [ + + ]: 2448 : for (const auto& c : commands) {
2102 : 2295 : t.appendCommand(c.name, &c);
2103 : : }
2104 : 153 : }
|