Coverage Report

Created: 2026-10-07 13:27

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