60#include <validation.h>
108 entry.
pushKV(
"confirmations", 0);
128 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
129 "At least one output of either type must be specified.\n"
130 "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
131 " accepted as second parameter.",
147 "Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible."},
169 std::map<COutPoint, Coin> coins;
195 if (!coins.empty()) {
214 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
224 const auto sign_result =
SignPSBTInput(
provider, psbtx, i, &txdata, {.sighash_type = sighash_type, .finalize = finalize},
nullptr);
231 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
242 const std::vector<RPCResult> verbosity_1_block{
243 {
RPCResult::Type::BOOL,
"in_active_chain",
true,
"Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
245 {
RPCResult::Type::NUM,
"vsize_adjusted",
true,
"Sigop-adjusted virtual size in bytes, present for mempool transactions."},
251 const auto v2_extras = Cat<std::vector<RPCResult>>(
252 std::vector<RPCResult>{{
254 "transaction fee in " +
CURRENCY_UNIT +
", omitted if block undo data is not available"
258 .prevout_optional =
true,
259 .vin_inner_elision =
"Same vin fields as verbosity = 1"}));
263 "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
264 "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
265 "If a blockhash argument is passed, it will return the transaction if\n"
266 "the specified block is available and the transaction is in that block.\n\n"
267 "Hint: Use gettransaction for wallet transactions.\n\n"
269 "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
270 "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
271 "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
279 RPCResult{
"if verbosity is not set or set to 0",
284 Cat<std::vector<RPCResult>>(
286 TxDoc({.txid_field_doc=
"The transaction id (same as provided)"})),
289 Cat(
ElideGroup(verbosity_1_block,
"Same output as verbosity = 1"), v2_extras)},
295 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 0 \"myblockhash\"")
296 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 1 \"myblockhash\"")
297 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 2 \"myblockhash\"")
314 if (!request.params[2].isNull()) {
324 bool f_txindex_ready =
false;
326 f_txindex_ready =
g_txindex->BlockUntilSyncedToCurrentChain();
335 if (!block_has_data) {
338 errmsg =
"No such transaction found in the provided block";
340 errmsg =
"No such mempool transaction. Use -txindex or provide a block hash to enable blockchain transaction queries";
341 }
else if (!f_txindex_ready) {
342 errmsg =
"No such mempool transaction. Blockchain transactions are still in the process of being indexed";
344 errmsg =
"No such mempool or blockchain transaction";
349 if (verbosity <= 0) {
359 if (request.params[2].isNull()) {
365 if (blockindex ==
nullptr && hash_block.
IsNull() &&
node.mempool) {
366 auto info =
node.mempool->info(tx->GetHash());
368 result.
pushKV(
"vsize_adjusted", info.vsize);
372 if (verbosity == 1) {
385 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.");
388 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.");
392 auto it = std::find_if(block.
vtx.begin(), block.
vtx.end(), [tx](
CTransactionRef t){ return t->Equals(*tx); });
393 if (it != block.
vtx.end()) {
395 undoTX = &blockUndo.
vtxundo.at(it - block.
vtx.begin() - 1);
406 "createrawtransaction",
407 "Create a transaction spending the given inputs and creating new outputs.\n"
408 "Outputs can be addresses or data.\n"
409 "Returns hex-encoded raw transaction.\n"
410 "Note that the transaction's inputs are not signed, and\n"
411 "it is not stored in the wallet or transmitted to the network.\n",
417 HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
418 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
419 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"address\\\":0.01}]\"")
420 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
424 std::optional<bool> rbf;
425 if (!request.params[3].isNull()) {
438 "Return a JSON object representing the serialized, hex-encoded transaction.",
442 "If iswitness is not present, heuristic tests will be used in decoding.\n"
443 "If true, only witness deserialization will be tried.\n"
444 "If false, only non-witness deserialization will be tried.\n"
445 "This boolean should reflect whether the transaction has inputs\n"
446 "(e.g. fully valid, or on-chain transactions), if known by the caller."
461 bool try_witness = request.params[1].isNull() ? true : request.params[1].get_bool();
462 bool try_no_witness = request.params[1].isNull() ? true : !request.params[1].get_bool();
464 if (!
DecodeHexTx(mtx, request.params[0].get_str(), try_no_witness, try_witness)) {
480 "Decode a hex-encoded script.\n",
490 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
492 "address of P2SH script wrapping this redeem script (not returned for types that should not be wrapped)"},
494 "Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped)",
498 {
RPCResult::Type::STR,
"type",
"The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash)"},
499 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
501 {
RPCResult::Type::STR,
"p2sh-segwit",
"address of the P2SH script wrapping this witness redeem script"},
513 if (request.params[0].get_str().size() > 0){
514 std::vector<unsigned char> scriptData(
ParseHexV(request.params[0],
"argument"));
521 std::vector<std::vector<unsigned char>> solutions_data;
524 const bool can_wrap{[&] {
525 switch (which_type) {
559 const bool can_wrap_P2WSH{[&] {
560 switch (which_type) {
565 for (
const auto& solution : solutions_data) {
587 if (can_wrap_P2WSH) {
602 r.
pushKV(
"segwit", std::move(sr));
614 "combinerawtransaction",
615 "Combine multiple partially signed transactions into one transaction.\n"
616 "The combined transaction may be another partially signed transaction or a \n"
617 "fully signed transaction.",
629 HelpExampleCli(
"combinerawtransaction", R
"('["myhex1", "myhex2", "myhex3"]')")
637 if (txs.
size() < 2) {
641 std::vector<CMutableTransaction> txVariants(txs.
size());
643 for (
unsigned int idx = 0; idx < txs.
size(); idx++) {
644 if (!
DecodeHexTx(txVariants[idx], txs[idx].get_str())) {
650 std::vector<CMutableTransaction> tx_variants_copy(txVariants);
652 for (
unsigned int k{0};
k < tx_variants_copy.size(); ++
k) {
654 for (
CTxIn& input : tx_variants_copy[
k].vin) {
655 input.scriptSig.clear();
659 first_txid = tx_variants_copy[
k].GetHash();
660 }
else if (first_txid != tx_variants_copy[
k].GetHash()) {
679 view.SetBackend(viewMempool);
681 for (
const CTxIn& txin : mergedTx.
vin) {
692 for (
unsigned int i = 0; i < mergedTx.
vin.size(); i++) {
702 if (txv.vin.size() > i) {
719 "signrawtransactionwithkey",
720 "Sign inputs for raw transaction (serialized, hex-encoded).\n"
721 "The second argument is an array of base58-encoded private\n"
722 "keys that will be the only keys used to sign the transaction.\n"
723 "The third optional argument (may be null) is an array of previous transaction outputs that\n"
724 "this transaction depends on but may not yet be in the block chain.\n",
751 " \"ALL|ANYONECANPAY\"\n"
752 " \"NONE|ANYONECANPAY\"\n"
753 " \"SINGLE|ANYONECANPAY\"\n"
779 HelpExampleCli(
"signrawtransactionwithkey",
"\"myhex\" \"[\\\"key1\\\",\\\"key2\\\"]\"")
780 +
HelpExampleRpc(
"signrawtransactionwithkey",
"\"myhex\", \"[\\\"key1\\\",\\\"key2\\\"]\"")
785 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
791 for (
unsigned int idx = 0; idx <
keys.size(); ++idx) {
800 keystore.
pubkeys.emplace(key_id, pubkey);
801 keystore.
keys.emplace(key_id, key);
805 std::map<COutPoint, Coin> coins;
824 static const RPCResult decodepsbt_inputs{
829 {
RPCResult::Type::OBJ,
"non_witness_utxo",
true,
"Decoded network transaction for non-witness UTXOs",
841 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
895 {
RPCResult::Type::STR_HEX,
"previous_txid",
true,
"TXID of the transaction containing the output being spent by this input"},
899 {
RPCResult::Type::NUM,
"height_locktime",
true,
"Height-based locktime required for this input"},
903 {
RPCResult::Type::OBJ,
"signature",
true,
"The signature for the pubkey and leaf hash combination",
941 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
952 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this pubnonce."},
953 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this pubnonce is for."},
954 {
RPCResult::Type::STR_HEX,
"leaf_hash",
true,
"The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
962 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this partial signature."},
963 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this partial signature is for."},
964 {
RPCResult::Type::STR_HEX,
"leaf_hash",
true,
"The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
985 return decodepsbt_inputs;
990 static const RPCResult decodepsbt_outputs{
1021 {
RPCResult::Type::ARR,
"taproot_tree",
true,
"The tuples that make up the Taproot tree, in depth first search order",
1047 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
1071 return decodepsbt_outputs;
1078 "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
1097 {
RPCResult::Type::NUM,
"tx_version",
true,
"The version number of the unsigned transaction. Not to be confused with PSBT version"},
1098 {
RPCResult::Type::NUM,
"fallback_locktime",
true,
"The locktime to fallback to if no inputs specify a required locktime."},
1104 {
RPCResult::Type::NUM,
"psbt_version",
true,
"The PSBT version number. Not to be confused with the unsigned transaction version"},
1142 result.
pushKV(
"tx", std::move(tx_univ));
1148 for (
auto& xpub : xpub_pair.second) {
1149 std::vector<unsigned char> ser_xpub;
1151 xpub.EncodeWithVersion(ser_xpub.data());
1155 keypath.
pushKV(
"master_fingerprint",
HexStr(xpub_pair.first.fingerprint));
1157 global_xpubs.
push_back(std::move(keypath));
1160 result.
pushKV(
"global_xpubs", std::move(global_xpubs));
1168 result.
pushKV(
"input_count", (uint64_t)psbtx.
inputs.size());
1169 result.
pushKV(
"output_count", (uint64_t)psbtx.
outputs.size());
1184 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1185 this_prop.
pushKV(
"subtype", entry.subtype);
1188 proprietary.
push_back(std::move(this_prop));
1190 result.
pushKV(
"proprietary", std::move(proprietary));
1194 for (
auto [key, value] : psbtx.
unknown) {
1197 result.
pushKV(
"unknown", std::move(unknowns));
1201 bool have_all_utxos =
true;
1203 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
1207 bool have_a_utxo =
false;
1217 out.pushKV(
"scriptPubKey", std::move(o));
1219 in.
pushKV(
"witness_utxo", std::move(
out));
1228 in.
pushKV(
"non_witness_utxo", std::move(non_wit));
1234 total_in += txout.
nValue;
1237 have_all_utxos =
false;
1240 have_all_utxos =
false;
1249 in.
pushKV(
"partial_signatures", std::move(partial_sigs));
1261 in.
pushKV(
"redeem_script", std::move(r));
1266 in.
pushKV(
"witness_script", std::move(r));
1280 in.
pushKV(
"bip32_derivs", std::move(keypaths));
1288 in.
pushKV(
"final_scriptSig", std::move(scriptsig));
1295 in.
pushKV(
"final_scriptwitness", std::move(txinwitness));
1304 in.
pushKV(
"ripemd160_preimages", std::move(ripemd160_preimages));
1313 in.
pushKV(
"sha256_preimages", std::move(sha256_preimages));
1322 in.
pushKV(
"hash160_preimages", std::move(hash160_preimages));
1331 in.
pushKV(
"hash256_preimages", std::move(hash256_preimages));
1337 in.
pushKV(
"previous_vout",
static_cast<uint64_t
>(input.
prev_out));
1358 const auto& [xonly, leaf_hash] = pubkey_leaf;
1363 script_sigs.
push_back(std::move(sigobj));
1365 in.
pushKV(
"taproot_script_path_sigs", std::move(script_sigs));
1371 for (
const auto& [leaf, control_blocks] : input.
m_tap_scripts) {
1372 const auto& [
script, leaf_ver] = leaf;
1375 script_info.
pushKV(
"leaf_ver", leaf_ver);
1377 for (
const auto& control_block : control_blocks) {
1380 script_info.
pushKV(
"control_blocks", std::move(control_blocks_univ));
1381 tap_scripts.
push_back(std::move(script_info));
1383 in.
pushKV(
"taproot_scripts", std::move(tap_scripts));
1390 const auto& [leaf_hashes, origin] = leaf_origin;
1396 for (
const auto& leaf_hash : leaf_hashes) {
1399 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1400 keypaths.
push_back(std::move(path_obj));
1402 in.
pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1422 for (
const auto& pub : parts) {
1425 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1428 in.
pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1433 const auto& [agg, lh] = agg_lh;
1434 for (
const auto& [part, pubnonce] : part_pubnonce) {
1438 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1443 in.
pushKV(
"musig2_pubnonces", musig_pubnonces);
1448 const auto& [agg, lh] = agg_lh;
1449 for (
const auto& [part, psig] : part_psig) {
1453 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1458 in.
pushKV(
"musig2_partial_sigs", musig_partial_sigs);
1466 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1467 this_prop.
pushKV(
"subtype", entry.subtype);
1470 proprietary.
push_back(std::move(this_prop));
1472 in.
pushKV(
"proprietary", std::move(proprietary));
1476 if (input.
unknown.size() > 0) {
1478 for (
auto [key, value] : input.
unknown) {
1481 in.
pushKV(
"unknown", std::move(unknowns));
1486 result.
pushKV(
"inputs", std::move(inputs));
1491 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
1498 out.pushKV(
"redeem_script", std::move(r));
1503 out.pushKV(
"witness_script", std::move(r));
1516 out.pushKV(
"bip32_derivs", std::move(keypaths));
1524 out.pushKV(
"script", spk);
1537 elem.
pushKV(
"depth", depth);
1538 elem.
pushKV(
"leaf_ver", leaf_ver);
1542 out.pushKV(
"taproot_tree", std::move(tree));
1549 const auto& [leaf_hashes, origin] = leaf_origin;
1555 for (
const auto& leaf_hash : leaf_hashes) {
1558 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1559 keypaths.
push_back(std::move(path_obj));
1561 out.pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1571 for (
const auto& pub : parts) {
1574 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1577 out.pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1585 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1586 this_prop.
pushKV(
"subtype", entry.subtype);
1589 proprietary.
push_back(std::move(this_prop));
1591 out.pushKV(
"proprietary", std::move(proprietary));
1595 if (output.
unknown.size() > 0) {
1597 for (
auto [key, value] : output.
unknown) {
1600 out.pushKV(
"unknown", std::move(unknowns));
1607 output_value += output.
amount;
1610 have_all_utxos =
false;
1613 result.
pushKV(
"outputs", std::move(outputs));
1614 if (have_all_utxos) {
1627 "Combine multiple partially signed Bitcoin transactions into one transaction.\n"
1628 "Implements the Combiner role.\n",
1640 HelpExampleCli(
"combinepsbt", R
"('["mybase64_1", "mybase64_2", "mybase64_3"]')")
1645 std::vector<PartiallySignedTransaction> psbtxs;
1650 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1655 psbtxs.push_back(*psbt_res);
1658 std::optional<PartiallySignedTransaction> merged_psbt =
CombinePSBTs(psbtxs);
1664 ssTx << *merged_psbt;
1673 "Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a\n"
1674 "network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be\n"
1675 "created which has the final_scriptSig and final_scriptwitness fields filled for inputs that are complete.\n"
1676 "Implements the Finalizer and Extractor roles.\n",
1680 " extract and return the complete transaction in normal network serialization instead of the PSBT."},
1685 {
RPCResult::Type::STR,
"psbt",
true,
"The base64-encoded partially signed transaction if not extracted"},
1702 bool extract = request.params[1].isNull() || (!request.params[1].isNull() && request.params[1].get_bool());
1709 std::string result_str;
1713 result_str =
HexStr(ssTx);
1714 result.
pushKV(
"hex", result_str);
1718 result.
pushKV(
"psbt", result_str);
1720 result.
pushKV(
"complete", complete);
1731 "Creates a transaction in the Partially Signed Transaction format.\n"
1732 "Implements the Creator role.\n"
1733 "Note that the transaction's inputs are not signed, and\n"
1734 "it is not stored in the wallet or transmitted to the network.\n",
1735 Cat<std::vector<RPCArg>>(
1745 HelpExampleCli(
"createpsbt",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
1749 std::optional<bool> rbf;
1750 if (!request.params[3].isNull()) {
1751 rbf = request.params[3].
get_bool();
1756 uint32_t psbt_version = 2;
1757 if (!request.params[5].isNull()) {
1758 psbt_version = request.params[5].getInt<uint32_t>();
1760 if (psbt_version != 2 && psbt_version != 0) {
1778 "Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction\n"
1779 "createpsbt and walletcreatefundedpsbt should be used for new applications.\n",
1783 " will continue. If false, RPC will fail if any signatures are present."},
1785 "If iswitness is not present, heuristic tests will be used in decoding.\n"
1786 "If true, only witness deserialization will be tried.\n"
1787 "If false, only non-witness deserialization will be tried.\n"
1788 "This boolean should reflect whether the transaction has inputs\n"
1789 "(e.g. fully valid, or on-chain transactions), if known by the caller."
1797 "\nCreate a transaction\n"
1798 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
1799 "\nConvert the transaction to a PSBT\n"
1806 bool permitsigdata = request.params[1].isNull() ? false : request.params[1].get_bool();
1807 bool witness_specified = !request.params[2].isNull();
1808 bool iswitness = witness_specified ? request.params[2].get_bool() :
false;
1809 const bool try_witness = witness_specified ? iswitness :
true;
1810 const bool try_no_witness = witness_specified ? !iswitness :
true;
1811 if (!
DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
1825 uint32_t psbt_version = 2;
1826 if (!request.params[3].isNull()) {
1827 psbt_version = request.params[3].getInt<uint32_t>();
1829 if (psbt_version != 2 && psbt_version != 0) {
1847 "Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.\n",
1859 RPCResult::Type::STR,
"",
"The base64-encoded partially signed transaction with inputs updated"
1868 if (!request.params[1].isNull()) {
1869 auto descs = request.params[1].get_array();
1870 for (
size_t i = 0; i < descs.size(); ++i) {
1877 request.params[0].get_str(),
1894 "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"
1895 "No input in any of the PSBTs can be in more than one of the PSBTs.\n",
1911 std::vector<PartiallySignedTransaction> psbtxs;
1914 if (txs.
size() <= 1) {
1918 uint32_t best_version = 1;
1919 uint32_t best_locktime = 0xffffffff;
1920 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1925 psbtxs.push_back(*psbt_res);
1936 if (psbt_locktime < best_locktime) {
1937 best_locktime = psbt_locktime;
1948 for (
auto& psbt : psbtxs) {
1949 for (
const PSBTInput& input : psbt.inputs) {
1950 if (!merged_psbt.
AddInput(input)) {
1954 for (
const PSBTOutput& output : psbt.outputs) {
1958 merged_psbt.
m_proprietary.insert(psbt.m_proprietary.begin(), psbt.m_proprietary.end());
1959 merged_psbt.
unknown.insert(psbt.unknown.begin(), psbt.unknown.end());
1967 ssTx << merged_psbt;
1977 "Analyzes and provides information about the current status of a PSBT and its inputs\n",
1990 {
RPCResult::Type::OBJ,
"missing",
true,
"Things that are missing that are required to complete this input",
1994 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing"},
1998 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose signature is missing"},
2003 {
RPCResult::Type::STR,
"next",
true,
"Role of the next person that this input needs to go to"},
2006 {
RPCResult::Type::NUM,
"estimated_vsize",
true,
"Estimated vsize of the final signed transaction"},
2007 {
RPCResult::Type::STR_AMOUNT,
"estimated_feerate",
true,
"Estimated feerate of the final signed transaction in " +
CURRENCY_UNIT +
"/kvB. Shown only if all UTXO slots in the PSBT have been filled"},
2008 {
RPCResult::Type::STR_AMOUNT,
"fee",
true,
"The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled"},
2029 for (
const auto& input : psbta.
inputs) {
2033 input_univ.
pushKV(
"has_utxo", input.has_utxo);
2034 input_univ.
pushKV(
"is_final", input.is_final);
2037 if (!input.missing_pubkeys.empty()) {
2039 for (
const CKeyID& pubkey : input.missing_pubkeys) {
2042 missing.
pushKV(
"pubkeys", std::move(missing_pubkeys_univ));
2044 if (!input.missing_redeem_script.IsNull()) {
2045 missing.
pushKV(
"redeemscript",
HexStr(input.missing_redeem_script));
2047 if (!input.missing_witness_script.IsNull()) {
2048 missing.
pushKV(
"witnessscript",
HexStr(input.missing_witness_script));
2050 if (!input.missing_sigs.empty()) {
2052 for (
const CKeyID& pubkey : input.missing_sigs) {
2055 missing.
pushKV(
"signatures", std::move(missing_sigs_univ));
2057 if (!missing.
getKeys().empty()) {
2058 input_univ.
pushKV(
"missing", std::move(missing));
2060 inputs_result.
push_back(std::move(input_univ));
2062 if (!inputs_result.
empty()) result.
pushKV(
"inputs", std::move(inputs_result));
2070 if (psbta.
fee != std::nullopt) {
2074 if (!psbta.
error.empty()) {
2086 "descriptorprocesspsbt",
2087 "Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool. \n"
2088 "Then, sign the inputs we are able to with information from the output descriptors. ",
2098 {
"sighashtype",
RPCArg::Type::STR,
RPCArg::Default{
"DEFAULT for Taproot, ALL otherwise"},
"The signature hash type to sign with if not specified by the PSBT. Must be one of\n"
2103 " \"ALL|ANYONECANPAY\"\n"
2104 " \"NONE|ANYONECANPAY\"\n"
2105 " \"SINGLE|ANYONECANPAY\""},
2118 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[\\\"descriptor1\\\", \\\"descriptor2\\\"]\"") +
2119 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[{\\\"desc\\\":\\\"mydescriptor\\\", \\\"range\\\":21}]\"")
2126 auto descs = request.params[1].get_array();
2127 for (
size_t i = 0; i < descs.size(); ++i) {
2132 bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
2133 bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
2136 request.params[0].get_str(),
2143 bool complete =
true;
2144 const std::optional<PrecomputedTransactionData> txdata_opt{
PrecomputePSBTData(psbtx)};
2146 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
2156 result.
pushKV(
"complete", complete);
2189 for (
const auto& c : commands) {
2190 t.appendCommand(c.name, &c);
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
bool MoneyRange(const CAmount &nValue)
int64_t CAmount
Amount in satoshis (Can be negative)
std::string EncodeBase58Check(std::span< const unsigned char > input)
Encode a byte span into a base58-encoded string, including checksum.
std::string WriteHDKeypath(const std::vector< uint32_t > &keypath, bool apostrophe)
Write HD keypaths as strings.
@ BLOCK_HAVE_DATA
full block available in blk*.dat
#define CHECK_NONFATAL(condition)
Identity function.
#define NONFATAL_UNREACHABLE()
NONFATAL_UNREACHABLE() is a macro that is used to mark unreachable code.
std::vector< CTransactionRef > vtx
The block chain is a tree shaped structure starting with the genesis block at the root,...
int64_t GetBlockTime() const
int nHeight
height of the entry in the chain. The genesis block has height 0
Undo information for a CBlock.
std::vector< CTxUndo > vtxundo
bool Contains(const CBlockIndex &index) const
Efficiently check whether a block is present in this chain.
int Height() const
Return the maximal height in the chain.
const CBlock & GenesisBlock() const
CCoinsView that adds a memory cache for transactions to another CCoinsView.
CCoinsView that brings transactions from a mempool into view.
An encapsulated private key.
bool IsValid() const
Check whether this private key is valid.
CPubKey GetPubKey() const
Compute the public key from a private key.
A reference to a CKey: the Hash160 of its serialized public key.
An encapsulated public key.
bool IsCompressed() const
Check whether this is a compressed public key.
CKeyID GetID() const
Get the KeyID of this public key (hash of its serialization)
Serialized script, used inside transaction inputs and outputs.
A reference to a CScript: the Hash160 of its serialization.
The basic transaction that is broadcasted on the network and contained in blocks.
static constexpr uint32_t CURRENT_VERSION
An input of a transaction.
CScriptWitness scriptWitness
Only serialized through CTransaction.
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
An output of a transaction.
Undo information for a CTransaction.
Chainstate stores and provides an API to update our local knowledge of the current best chain.
CChain m_chain
The current chain of blockheaders we consult and build on.
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
const CChainParams & GetParams() const
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
CTxOut out
unspent transaction output
bool IsSpent() const
Either this coin never existed (see e.g.
static CoinsViewEmpty & Get()
Double ended buffer combining vector and stream-like interfaces.
A signature creator for transactions.
A structure for PSBTs which contains per output information.
std::map< CPubKey, std::vector< CPubKey > > m_musig2_participants
XOnlyPubKey m_tap_internal_key
std::map< XOnlyPubKey, std::pair< std::set< uint256 >, KeyOriginInfo > > m_tap_bip32_paths
std::set< PSBTProprietary > m_proprietary
std::map< CPubKey, KeyOriginInfo > hd_keypaths
std::vector< std::tuple< uint8_t, uint8_t, std::vector< unsigned char > > > m_tap_tree
std::map< std::vector< unsigned char >, std::vector< unsigned char > > unknown
A version of CTransaction with the PSBT format.
std::optional< std::bitset< 8 > > m_tx_modifiable
uint32_t GetVersion() const
std::map< KeyOriginInfo, std::set< CExtPubKey > > m_xpubs
std::map< std::vector< unsigned char >, std::vector< unsigned char > > unknown
std::vector< PSBTInput > inputs
void MergeGlobalXPubs(const PartiallySignedTransaction &psbt)
Merge the global xpubs of psbt into this, keeping the existing origin for an xpub seen again with a d...
std::optional< CMutableTransaction > GetUnsignedTx() const
std::vector< PSBTOutput > outputs
std::set< PSBTProprietary > m_proprietary
bool AddOutput(const PSBTOutput &psbtout)
std::optional< uint32_t > fallback_locktime
bool AddInput(const PSBTInput &psbtin)
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
void push_back(UniValue val)
const std::vector< std::string > & getKeys() const
void pushKVEnd(std::string key, UniValue val)
const UniValue & get_array() const
void pushKV(std::string key, UniValue val)
bool IsNull() const
Test whether this is the 0 key (the result of default construction).
constexpr bool IsNull() const
std::string GetHex() const
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
bool ReadBlock(CBlock &block, const FlatFilePos &pos, const std::optional< uint256 > &expected_hash) const
Functions for disk access for blocks.
std::string ToString() const
std::string GetHex() const
static transaction_identifier FromUint256(const uint256 &id)
is a home for simple enum and struct type definitions that can be used internally by functions in the...
std::string EncodeHexTx(const CTransaction &tx)
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness, bool try_witness)
void ScriptToUniv(const CScript &script, UniValue &out, bool include_hex, bool include_address, const SigningProvider *provider)
std::string SighashToStr(int32_t sighash_type)
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex, const CTxUndo *txundo, TxVerbosity verbosity, std::function< bool(const CTxOut &)> is_change_func)
std::string ScriptToAsmStr(const CScript &script, const bool fAttemptSighashDecode)
Create the assembly string representation of a CScript object.
UniValue ValueFromAmount(const CAmount amount)
TxVerbosity
Verbose level for block's transaction.
@ SHOW_DETAILS_AND_PREVOUT
The same as previous option with information about prevouts if available.
@ SHOW_DETAILS
Include TXID, inputs, outputs, and other common block's transaction information.
uint32_t ReadBE32(const B *ptr)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
const std::string CURRENCY_UNIT
uint160 Hash160(const T1 &in1)
Compute the 160-bit hash an object.
std::string HexStr(const std::span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
std::string EncodeDestination(const CTxDestination &dest)
CKey DecodeSecret(const std::string &str)
CTransactionRef GetTransaction(const CBlockIndex *const block_index, const CTxMemPool *const mempool, const Txid &hash, const BlockManager &blockman, uint256 &hashBlock)
Return transaction with a given hash.
PSBTAnalysis AnalyzePSBT(PartiallySignedTransaction psbtx)
Provides helpful miscellaneous information about where a PSBT is in the signing workflow.
void FindCoins(const NodeContext &node, std::map< COutPoint, Coin > &coins)
Look up unspent output information.
bilingual_str ErrorString(const Result< T > &result)
constexpr TransactionSerParams TX_WITH_WITNESS
std::shared_ptr< const CTransaction > CTransactionRef
util::Expected< void, PSBTError > SignPSBTInput(const SigningProvider &provider, PartiallySignedTransaction &psbt, int index, const PrecomputedTransactionData *txdata, const common::PSBTFillOptions &options, SignatureData *out_sigdata)
Signs a PSBTInput, verifying that all provided data matches what is being signed.
void UpdatePSBTOutput(const SigningProvider &provider, PartiallySignedTransaction &psbt, int index)
Updates a PSBTOutput with information from provider.
bool PSBTInputSignedAndVerified(const PartiallySignedTransaction &psbt, unsigned int input_index, const PrecomputedTransactionData *txdata)
Checks whether a PSBTInput is already signed by doing script verification using final fields.
std::string PSBTRoleName(PSBTRole role)
util::Result< PartiallySignedTransaction > DecodeBase64PSBT(const std::string &base64_tx)
Decode a base64ed PSBT into a PartiallySignedTransaction.
std::optional< PartiallySignedTransaction > CombinePSBTs(const std::vector< PartiallySignedTransaction > &psbtxs)
Combines PSBTs with the same underlying transaction, resulting in a single PSBT with all partial sign...
void RemoveUnnecessaryTransactions(PartiallySignedTransaction &psbtx)
Reduces the size of the PSBT by dropping unnecessary non_witness_utxos (i.e.
std::optional< PrecomputedTransactionData > PrecomputePSBTData(const PartiallySignedTransaction &psbt)
Compute a PrecomputedTransactionData object from a psbt.
bool FinalizeAndExtractPSBT(PartiallySignedTransaction &psbtx, CMutableTransaction &result)
Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized.
bool PSBTInputSigned(const PSBTInput &input)
Checks whether a PSBTInput is already signed by checking for non-null finalized fields.
constexpr unsigned int BIP32_EXTKEY_WITH_VERSION_SIZE
static RPCMethod decodescript()
static RPCMethod createrawtransaction()
static void TxToJSON(const CTransaction &tx, const uint256 hashBlock, UniValue &entry, Chainstate &active_chainstate, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
static RPCMethod joinpsbts()
static RPCMethod getrawtransaction()
PartiallySignedTransaction ProcessPSBT(const std::string &psbt_string, const std::any &context, const HidingSigningProvider &provider, std::optional< int > sighash_type, bool finalize)
static RPCMethod createpsbt()
static RPCMethod combinerawtransaction()
static std::vector< RPCArg > CreateTxDoc()
const RPCResult & DecodePSBTOutputs()
RPCMethod descriptorprocesspsbt()
static RPCMethod decodepsbt()
static RPCMethod combinepsbt()
static RPCMethod utxoupdatepsbt()
static RPCMethod converttopsbt()
static constexpr decltype(CTransaction::version) DEFAULT_RAWTX_VERSION
static RPCMethod finalizepsbt()
const RPCResult & DecodePSBTInputs()
void RegisterRawTransactionRPCCommands(CRPCTable &t)
static RPCMethod signrawtransactionwithkey()
static RPCMethod decoderawtransaction()
static RPCMethod analyzepsbt()
void SignTransaction(CMutableTransaction &mtx, const SigningProvider *keystore, const std::map< COutPoint, Coin > &coins, const UniValue &hashType, UniValue &result)
Sign a transaction with the given keystore and previous transactions.
CMutableTransaction ConstructTransaction(const UniValue &inputs_in, const UniValue &outputs_in, const UniValue &locktime, std::optional< bool > rbf, const uint32_t version)
Create a transaction from univalue parameters.
void ParsePrevouts(const UniValue &prevTxsUnival, FlatSigningProvider *keystore, std::map< COutPoint, Coin > &coins)
Parse a prevtxs UniValue array and get the map of coins from it.
std::vector< RPCResult > TxDoc(const TxDocOptions &opts)
Explain the UniValue "decoded" transaction object, may include extra fields if processed by wallet.
@ WithSummary
first field carries elision_summary as "...", rest skipped
@ Silent
all top-level fields skipped silently (no "..." line)
UniValue JSONRPCError(int code, const std::string &message)
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_VERIFY_ERROR
General error during transaction or block submission.
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
std::vector< CScript > EvalDescriptorStringOrObject(const UniValue &scanobject, FlatSigningProvider &provider, const bool expand_priv)
Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range ...
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
std::vector< unsigned char > ParseHexV(const UniValue &v, std::string_view name)
std::vector< RPCResult > ElideGroup(std::vector< RPCResult > fields, std::string summary)
Stamp elision onto an entire vector of RPCResult fields at once.
UniValue JSONRPCPSBTError(PSBTError err)
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.
std::string GetAllOutputTypes()
Gets all existing output types formatted for RPC help sections.
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
std::optional< int > ParseSighashString(const UniValue &sighash)
Returns a sighash value corresponding to the passed in argument.
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
std::vector< RPCResult > ScriptPubKeyDoc()
#define extract(n)
Extract the lowest 64 bits of (c0,c1,c2) into n, and left shift the number 64 bits.
bool IsOpSuccess(const opcodetype &opcode)
Test for OP_SUCCESSx opcodes as defined by BIP342.
opcodetype
Script opcodes.
NodeContext & EnsureAnyNodeContext(const std::any &context)
CTxMemPool & EnsureMemPool(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
bool ProduceSignature(const SigningProvider &provider, const BaseSignatureCreator &creator, const CScript &fromPubKey, SignatureData &sigdata)
Produce a script signature using a generic signature creator.
void UpdateInput(CTxIn &input, const SignatureData &data)
bool IsSegWitOutput(const SigningProvider &provider, const CScript &script)
Check whether a scriptPubKey is known to be segwit.
SignatureData DataFromTransaction(const CMutableTransaction &tx, unsigned int nIn, const CTxOut &txout)
Extract signature data from a transaction input, and insert it.
const SigningProvider & DUMMY_SIGNING_PROVIDER
TxoutType Solver(const CScript &scriptPubKey, std::vector< std::vector< unsigned char > > &vSolutionsRet)
Parse a scriptPubKey and identify script type for standard scripts.
@ WITNESS_UNKNOWN
Only for Witness versions not already defined above.
@ ANCHOR
anyone can spend script
@ NULL_DATA
unspendable OP_RETURN script that carries data
A mutable version of CTransaction.
std::vector< std::vector< unsigned char > > stack
std::map< CKeyID, CPubKey > pubkeys
std::map< CKeyID, CKey > keys
@ RANGE
Special type that is a NUM or [NUM,NUM].
@ OBJ_USER_KEYS
Special type where the user must set the keys e.g. to define multiple addresses; as opposed to e....
@ STR_HEX
Special type that is a STR with only hex chars.
@ AMOUNT
Special type representing a floating point amount (can be either NUM or STR)
std::string DefaultHint
Hint for default value.
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
@ NUM_TIME
Special numeric to denote unix epoch time.
@ OBJ_DYN
Special dictionary with keys that are not literals.
@ STR_HEX
Special string with only hex chars.
@ STR_AMOUNT
Special string to represent a floating point amount.
void MergeSignatureData(SignatureData sigdata)
NodeContext struct containing references to chain state and connection state.
Holds the results of AnalyzePSBT (miscellaneous information about a PSBT)
std::vector< PSBTInputAnalysis > inputs
More information about the individual inputs of the transaction.
std::string error
Error message.
std::optional< CAmount > fee
Amount of fee being paid by the transaction.
std::optional< size_t > estimated_vsize
Estimated weight of the transaction.
std::optional< CFeeRate > estimated_feerate
Estimated feerate (fee / weight) of the transaction.
PSBTRole next
Which of the BIP 174 roles needs to handle the transaction next.
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
std::vector< uint16_t > keys
FuzzedDataProvider provider
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
std::string EncodeBase64(std::span< const unsigned char > input)
V Cat(V v1, V &&v2)
Concatenate two vectors, moving elements.