Coverage Report

Created: 2025-09-19 18:21

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