Bitcoin Core Fuzz Coverage Report for wallet_tx_can_be_bumped

Coverage Report

Created: 2025-11-19 11:20

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