Coverage Report

Created: 2025-04-09 20:00

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