82 entry.
pushKV(
"confirmations", 0);
102 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
103 "At least one output of either type must be specified.\n"
104 "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
105 " accepted as second parameter.",
121 "Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible."},
143 std::map<COutPoint, Coin> coins;
170 if (!coins.empty()) {
189 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
205 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
219 "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
220 "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
221 "If a blockhash argument is passed, it will return the transaction if\n"
222 "the specified block is available and the transaction is in that block.\n\n"
223 "Hint: Use gettransaction for wallet transactions.\n\n"
225 "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
226 "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
227 "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
235 RPCResult{
"if verbosity is not set or set to 0",
240 Cat<std::vector<RPCResult>>(
242 {
RPCResult::Type::BOOL,
"in_active_chain",
true,
"Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
249 TxDoc({.txid_field_doc=
"The transaction id (same as provided)"})),
261 {
RPCResult::Type::OBJ,
"prevout",
true,
"The previous output, omitted if block undo data is not available",
276 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 0 \"myblockhash\"")
277 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 1 \"myblockhash\"")
278 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 2 \"myblockhash\"")
295 if (!request.params[2].isNull()) {
305 bool f_txindex_ready =
false;
307 f_txindex_ready =
g_txindex->BlockUntilSyncedToCurrentChain();
316 if (!block_has_data) {
319 errmsg =
"No such transaction found in the provided block";
321 errmsg =
"No such mempool transaction. Use -txindex or provide a block hash to enable blockchain transaction queries";
322 }
else if (!f_txindex_ready) {
323 errmsg =
"No such mempool transaction. Blockchain transactions are still in the process of being indexed";
325 errmsg =
"No such mempool or blockchain transaction";
330 if (verbosity <= 0) {
340 if (request.params[2].isNull()) {
344 if (verbosity == 1) {
357 throw JSONRPCError(
RPC_INTERNAL_ERROR,
"Undo data expected but can't be read. This could be due to disk corruption or a conflict with a pruning event.");
360 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.");
365 if (it != block.
vtx.end()) {
367 undoTX = &blockUndo.
vtxundo.at(it - block.
vtx.begin() - 1);
378 "createrawtransaction",
379 "Create a transaction spending the given inputs and creating new outputs.\n"
380 "Outputs can be addresses or data.\n"
381 "Returns hex-encoded raw transaction.\n"
382 "Note that the transaction's inputs are not signed, and\n"
383 "it is not stored in the wallet or transmitted to the network.\n",
389 HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
390 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
391 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"address\\\":0.01}]\"")
392 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
396 std::optional<bool> rbf;
397 if (!request.params[3].isNull()) {
410 "Return a JSON object representing the serialized, hex-encoded transaction.",
414 "If iswitness is not present, heuristic tests will be used in decoding.\n"
415 "If true, only witness deserialization will be tried.\n"
416 "If false, only non-witness deserialization will be tried.\n"
417 "This boolean should reflect whether the transaction has inputs\n"
418 "(e.g. fully valid, or on-chain transactions), if known by the caller."
433 bool try_witness = request.params[1].isNull() ? true : request.params[1].get_bool();
434 bool try_no_witness = request.params[1].isNull() ? true : !request.params[1].get_bool();
436 if (!
DecodeHexTx(mtx, request.params[0].get_str(), try_no_witness, try_witness)) {
452 "Decode a hex-encoded script.\n",
462 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
464 "address of P2SH script wrapping this redeem script (not returned for types that should not be wrapped)"},
466 "Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped)",
470 {
RPCResult::Type::STR,
"type",
"The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash)"},
471 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
473 {
RPCResult::Type::STR,
"p2sh-segwit",
"address of the P2SH script wrapping this witness redeem script"},
485 if (request.params[0].get_str().size() > 0){
486 std::vector<unsigned char> scriptData(
ParseHexV(request.params[0],
"argument"));
493 std::vector<std::vector<unsigned char>> solutions_data;
496 const bool can_wrap{[&] {
497 switch (which_type) {
531 const bool can_wrap_P2WSH{[&] {
532 switch (which_type) {
537 for (
const auto& solution : solutions_data) {
559 if (can_wrap_P2WSH) {
574 r.
pushKV(
"segwit", std::move(sr));
586 "combinerawtransaction",
587 "Combine multiple partially signed transactions into one transaction.\n"
588 "The combined transaction may be another partially signed transaction or a \n"
589 "fully signed transaction.",
601 HelpExampleCli(
"combinerawtransaction", R
"('["myhex1", "myhex2", "myhex3"]')")
607 std::vector<CMutableTransaction> txVariants(txs.
size());
609 for (
unsigned int idx = 0; idx < txs.
size(); idx++) {
610 if (!
DecodeHexTx(txVariants[idx], txs[idx].get_str())) {
615 if (txVariants.empty()) {
632 view.SetBackend(viewMempool);
634 for (
const CTxIn& txin : mergedTx.
vin) {
645 for (
unsigned int i = 0; i < mergedTx.
vin.size(); i++) {
655 if (txv.vin.size() > i) {
672 "signrawtransactionwithkey",
673 "Sign inputs for raw transaction (serialized, hex-encoded).\n"
674 "The second argument is an array of base58-encoded private\n"
675 "keys that will be the only keys used to sign the transaction.\n"
676 "The third optional argument (may be null) is an array of previous transaction outputs that\n"
677 "this transaction depends on but may not yet be in the block chain.\n",
704 " \"ALL|ANYONECANPAY\"\n"
705 " \"NONE|ANYONECANPAY\"\n"
706 " \"SINGLE|ANYONECANPAY\"\n"
732 HelpExampleCli(
"signrawtransactionwithkey",
"\"myhex\" \"[\\\"key1\\\",\\\"key2\\\"]\"")
733 +
HelpExampleRpc(
"signrawtransactionwithkey",
"\"myhex\", \"[\\\"key1\\\",\\\"key2\\\"]\"")
738 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
744 for (
unsigned int idx = 0; idx < keys.
size(); ++idx) {
753 keystore.
pubkeys.emplace(key_id, pubkey);
754 keystore.
keys.emplace(key_id, key);
758 std::map<COutPoint, Coin> coins;
777 static const RPCResult decodepsbt_inputs{
782 {
RPCResult::Type::OBJ,
"non_witness_utxo",
true,
"Decoded network transaction for non-witness UTXOs",
783 TxDoc({.elision_description=
"The layout is the same as the output of decoderawtransaction."})
794 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
848 {
RPCResult::Type::STR_HEX,
"previous_txid",
true,
"TXID of the transaction containing the output being spent by this input"},
852 {
RPCResult::Type::NUM,
"height_locktime",
true,
"Height-based locktime required for this input"},
856 {
RPCResult::Type::OBJ,
"signature",
true,
"The signature for the pubkey and leaf hash combination",
894 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
905 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this pubnonce."},
906 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this pubnonce is for."},
907 {
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."},
915 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this partial signature."},
916 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this partial signature is for."},
917 {
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."},
938 return decodepsbt_inputs;
943 static const RPCResult decodepsbt_outputs{
974 {
RPCResult::Type::ARR,
"taproot_tree",
true,
"The tuples that make up the Taproot tree, in depth first search order",
1000 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
1024 return decodepsbt_outputs;
1031 "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
1039 TxDoc({.elision_description=
"The layout is the same as the output of decoderawtransaction."})
1050 {
RPCResult::Type::NUM,
"tx_version",
true,
"The version number of the unsigned transaction. Not to be confused with PSBT version"},
1051 {
RPCResult::Type::NUM,
"fallback_locktime",
true,
"The locktime to fallback to if no inputs specify a required locktime."},
1057 {
RPCResult::Type::NUM,
"psbt_version",
true,
"The PSBT version number. Not to be confused with the unsigned transaction version"},
1095 result.
pushKV(
"tx", std::move(tx_univ));
1101 for (
auto& xpub : xpub_pair.second) {
1102 std::vector<unsigned char> ser_xpub;
1104 xpub.EncodeWithVersion(ser_xpub.data());
1108 keypath.
pushKV(
"master_fingerprint",
HexStr(std::span<unsigned char>(xpub_pair.first.fingerprint, xpub_pair.first.fingerprint + 4)));
1110 global_xpubs.
push_back(std::move(keypath));
1113 result.
pushKV(
"global_xpubs", std::move(global_xpubs));
1121 result.
pushKV(
"input_count", (uint64_t)psbtx.
inputs.size());
1122 result.
pushKV(
"output_count", (uint64_t)psbtx.
outputs.size());
1137 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1138 this_prop.
pushKV(
"subtype", entry.subtype);
1141 proprietary.
push_back(std::move(this_prop));
1143 result.
pushKV(
"proprietary", std::move(proprietary));
1147 for (
auto entry : psbtx.
unknown) {
1150 result.
pushKV(
"unknown", std::move(unknowns));
1154 bool have_all_utxos =
true;
1156 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
1160 bool have_a_utxo =
false;
1170 out.pushKV(
"scriptPubKey", std::move(o));
1172 in.
pushKV(
"witness_utxo", std::move(
out));
1181 in.
pushKV(
"non_witness_utxo", std::move(non_wit));
1187 total_in += txout.
nValue;
1190 have_all_utxos =
false;
1193 have_all_utxos =
false;
1202 in.
pushKV(
"partial_signatures", std::move(partial_sigs));
1214 in.
pushKV(
"redeem_script", std::move(r));
1219 in.
pushKV(
"witness_script", std::move(r));
1233 in.
pushKV(
"bip32_derivs", std::move(keypaths));
1241 in.
pushKV(
"final_scriptSig", std::move(scriptsig));
1248 in.
pushKV(
"final_scriptwitness", std::move(txinwitness));
1257 in.
pushKV(
"ripemd160_preimages", std::move(ripemd160_preimages));
1266 in.
pushKV(
"sha256_preimages", std::move(sha256_preimages));
1275 in.
pushKV(
"hash160_preimages", std::move(hash160_preimages));
1284 in.
pushKV(
"hash256_preimages", std::move(hash256_preimages));
1290 in.
pushKV(
"previous_vout",
static_cast<uint64_t
>(input.
prev_out));
1311 const auto& [xonly, leaf_hash] = pubkey_leaf;
1316 script_sigs.
push_back(std::move(sigobj));
1318 in.
pushKV(
"taproot_script_path_sigs", std::move(script_sigs));
1324 for (
const auto& [leaf, control_blocks] : input.
m_tap_scripts) {
1325 const auto& [
script, leaf_ver] = leaf;
1328 script_info.
pushKV(
"leaf_ver", leaf_ver);
1330 for (
const auto& control_block : control_blocks) {
1333 script_info.
pushKV(
"control_blocks", std::move(control_blocks_univ));
1334 tap_scripts.
push_back(std::move(script_info));
1336 in.
pushKV(
"taproot_scripts", std::move(tap_scripts));
1343 const auto& [leaf_hashes, origin] = leaf_origin;
1349 for (
const auto& leaf_hash : leaf_hashes) {
1352 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1353 keypaths.
push_back(std::move(path_obj));
1355 in.
pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1375 for (
const auto& pub : parts) {
1378 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1381 in.
pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1386 const auto& [agg, lh] = agg_lh;
1387 for (
const auto& [part, pubnonce] : part_pubnonce) {
1391 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1396 in.
pushKV(
"musig2_pubnonces", musig_pubnonces);
1401 const auto& [agg, lh] = agg_lh;
1402 for (
const auto& [part, psig] : part_psig) {
1406 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1411 in.
pushKV(
"musig2_partial_sigs", musig_partial_sigs);
1419 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1420 this_prop.
pushKV(
"subtype", entry.subtype);
1423 proprietary.
push_back(std::move(this_prop));
1425 in.
pushKV(
"proprietary", std::move(proprietary));
1429 if (input.
unknown.size() > 0) {
1431 for (
auto entry : input.
unknown) {
1434 in.
pushKV(
"unknown", std::move(unknowns));
1439 result.
pushKV(
"inputs", std::move(inputs));
1444 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
1451 out.pushKV(
"redeem_script", std::move(r));
1456 out.pushKV(
"witness_script", std::move(r));
1469 out.pushKV(
"bip32_derivs", std::move(keypaths));
1477 out.pushKV(
"script", spk);
1490 elem.
pushKV(
"depth", depth);
1491 elem.
pushKV(
"leaf_ver", leaf_ver);
1495 out.pushKV(
"taproot_tree", std::move(tree));
1502 const auto& [leaf_hashes, origin] = leaf_origin;
1508 for (
const auto& leaf_hash : leaf_hashes) {
1511 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1512 keypaths.
push_back(std::move(path_obj));
1514 out.pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1524 for (
const auto& pub : parts) {
1527 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1530 out.pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1538 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1539 this_prop.
pushKV(
"subtype", entry.subtype);
1542 proprietary.
push_back(std::move(this_prop));
1544 out.pushKV(
"proprietary", std::move(proprietary));
1548 if (output.
unknown.size() > 0) {
1550 for (
auto entry : output.
unknown) {
1553 out.pushKV(
"unknown", std::move(unknowns));
1560 output_value += output.
amount;
1563 have_all_utxos =
false;
1566 result.
pushKV(
"outputs", std::move(outputs));
1567 if (have_all_utxos) {
1580 "Combine multiple partially signed Bitcoin transactions into one transaction.\n"
1581 "Implements the Combiner role.\n",
1593 HelpExampleCli(
"combinepsbt", R
"('["mybase64_1", "mybase64_2", "mybase64_3"]')")
1598 std::vector<PartiallySignedTransaction> psbtxs;
1603 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1608 psbtxs.push_back(*psbt_res);
1611 std::optional<PartiallySignedTransaction> merged_psbt =
CombinePSBTs(psbtxs);
1617 ssTx << *merged_psbt;
1626 "Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a\n"
1627 "network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be\n"
1628 "created which has the final_scriptSig and final_scriptwitness fields filled for inputs that are complete.\n"
1629 "Implements the Finalizer and Extractor roles.\n",
1633 " extract and return the complete transaction in normal network serialization instead of the PSBT."},
1638 {
RPCResult::Type::STR,
"psbt",
true,
"The base64-encoded partially signed transaction if not extracted"},
1655 bool extract = request.params[1].isNull() || (!request.params[1].isNull() && request.params[1].get_bool());
1662 std::string result_str;
1666 result_str =
HexStr(ssTx);
1667 result.
pushKV(
"hex", result_str);
1671 result.
pushKV(
"psbt", result_str);
1673 result.
pushKV(
"complete", complete);
1684 "Creates a transaction in the Partially Signed Transaction format.\n"
1685 "Implements the Creator role.\n"
1686 "Note that the transaction's inputs are not signed, and\n"
1687 "it is not stored in the wallet or transmitted to the network.\n",
1688 Cat<std::vector<RPCArg>>(
1698 HelpExampleCli(
"createpsbt",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
1702 std::optional<bool> rbf;
1703 if (!request.params[3].isNull()) {
1704 rbf = request.params[3].
get_bool();
1709 uint32_t psbt_version = 2;
1710 if (!request.params[5].isNull()) {
1711 psbt_version = request.params[5].getInt<uint32_t>();
1713 if (psbt_version != 2 && psbt_version != 0) {
1731 "Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction\n"
1732 "createpsbt and walletcreatefundedpsbt should be used for new applications.\n",
1736 " will continue. If false, RPC will fail if any signatures are present."},
1738 "If iswitness is not present, heuristic tests will be used in decoding.\n"
1739 "If true, only witness deserialization will be tried.\n"
1740 "If false, only non-witness deserialization will be tried.\n"
1741 "This boolean should reflect whether the transaction has inputs\n"
1742 "(e.g. fully valid, or on-chain transactions), if known by the caller."
1750 "\nCreate a transaction\n"
1751 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
1752 "\nConvert the transaction to a PSBT\n"
1759 bool permitsigdata = request.params[1].isNull() ? false : request.params[1].get_bool();
1760 bool witness_specified = !request.params[2].isNull();
1761 bool iswitness = witness_specified ? request.params[2].get_bool() :
false;
1762 const bool try_witness = witness_specified ? iswitness :
true;
1763 const bool try_no_witness = witness_specified ? !iswitness :
true;
1764 if (!
DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
1778 uint32_t psbt_version = 2;
1779 if (!request.params[3].isNull()) {
1780 psbt_version = request.params[3].getInt<uint32_t>();
1782 if (psbt_version != 2 && psbt_version != 0) {
1800 "Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.\n",
1812 RPCResult::Type::STR,
"",
"The base64-encoded partially signed transaction with inputs updated"
1821 if (!request.params[1].isNull()) {
1822 auto descs = request.params[1].get_array();
1823 for (
size_t i = 0; i < descs.size(); ++i) {
1830 request.params[0].get_str(),
1847 "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"
1848 "No input in any of the PSBTs can be in more than one of the PSBTs.\n",
1864 std::vector<PartiallySignedTransaction> psbtxs;
1867 if (txs.
size() <= 1) {
1871 uint32_t best_version = 1;
1872 uint32_t best_locktime = 0xffffffff;
1873 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1878 psbtxs.push_back(*psbt_res);
1889 if (psbt_locktime < best_locktime) {
1890 best_locktime = psbt_locktime;
1901 for (
auto& psbt : psbtxs) {
1902 for (
const PSBTInput& input : psbt.inputs) {
1903 if (!merged_psbt.
AddInput(input)) {
1907 for (
const PSBTOutput& output : psbt.outputs) {
1910 for (
auto& xpub_pair : psbt.m_xpubs) {
1911 if (!merged_psbt.
m_xpubs.contains(xpub_pair.first)) {
1912 merged_psbt.
m_xpubs[xpub_pair.first] = xpub_pair.second;
1914 merged_psbt.
m_xpubs[xpub_pair.first].insert(xpub_pair.second.begin(), xpub_pair.second.end());
1917 merged_psbt.
unknown.insert(psbt.unknown.begin(), psbt.unknown.end());
1921 std::vector<int> input_indices(merged_psbt.
inputs.size());
1922 std::iota(input_indices.begin(), input_indices.end(), 0);
1923 std::vector<int> output_indices(merged_psbt.
outputs.size());
1924 std::iota(output_indices.begin(), output_indices.end(), 0);
1928 std::shuffle(output_indices.begin(), output_indices.end(),
FastRandomContext());
1931 for (
int i : input_indices) {
1934 for (
int i : output_indices) {
1940 ssTx << shuffled_psbt;
1950 "Analyzes and provides information about the current status of a PSBT and its inputs\n",
1963 {
RPCResult::Type::OBJ,
"missing",
true,
"Things that are missing that are required to complete this input",
1967 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing"},
1971 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose signature is missing"},
1976 {
RPCResult::Type::STR,
"next",
true,
"Role of the next person that this input needs to go to"},
1979 {
RPCResult::Type::NUM,
"estimated_vsize",
true,
"Estimated vsize of the final signed transaction"},
1980 {
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"},
1981 {
RPCResult::Type::STR_AMOUNT,
"fee",
true,
"The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled"},
2002 for (
const auto& input : psbta.
inputs) {
2006 input_univ.
pushKV(
"has_utxo", input.has_utxo);
2007 input_univ.
pushKV(
"is_final", input.is_final);
2010 if (!input.missing_pubkeys.empty()) {
2012 for (
const CKeyID& pubkey : input.missing_pubkeys) {
2015 missing.
pushKV(
"pubkeys", std::move(missing_pubkeys_univ));
2017 if (!input.missing_redeem_script.IsNull()) {
2018 missing.
pushKV(
"redeemscript",
HexStr(input.missing_redeem_script));
2020 if (!input.missing_witness_script.IsNull()) {
2021 missing.
pushKV(
"witnessscript",
HexStr(input.missing_witness_script));
2023 if (!input.missing_sigs.empty()) {
2025 for (
const CKeyID& pubkey : input.missing_sigs) {
2028 missing.
pushKV(
"signatures", std::move(missing_sigs_univ));
2030 if (!missing.
getKeys().empty()) {
2031 input_univ.
pushKV(
"missing", std::move(missing));
2033 inputs_result.
push_back(std::move(input_univ));
2035 if (!inputs_result.
empty()) result.
pushKV(
"inputs", std::move(inputs_result));
2043 if (psbta.
fee != std::nullopt) {
2047 if (!psbta.
error.empty()) {
2059 "descriptorprocesspsbt",
2060 "Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool. \n"
2061 "Then, sign the inputs we are able to with information from the output descriptors. ",
2071 {
"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"
2076 " \"ALL|ANYONECANPAY\"\n"
2077 " \"NONE|ANYONECANPAY\"\n"
2078 " \"SINGLE|ANYONECANPAY\""},
2091 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[\\\"descriptor1\\\", \\\"descriptor2\\\"]\"") +
2092 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[{\\\"desc\\\":\\\"mydescriptor\\\", \\\"range\\\":21}]\"")
2099 auto descs = request.params[1].get_array();
2100 for (
size_t i = 0; i < descs.size(); ++i) {
2105 bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
2106 bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
2109 request.params[0].get_str(),
2116 bool complete =
true;
2117 for (
const auto& input : psbtx.
inputs) {
2127 result.
pushKV(
"complete", complete);
2160 for (
const auto& c : commands) {
2161 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 const 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
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
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)
std::string EncodeHexTx(const CTransaction &tx)
std::string SighashToStr(unsigned char sighash_type)
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)
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)
is a home for public enum and struct type definitions that are used internally by node code,...
static constexpr TransactionSerParams TX_WITH_WITNESS
std::shared_ptr< const CTransaction > CTransactionRef
void UpdatePSBTOutput(const SigningProvider &provider, PartiallySignedTransaction &psbt, int index)
Updates a PSBTOutput with information from provider.
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.
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.
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.
const 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.
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)
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
std::map< CScriptID, CScript > scripts
@ 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:
@ ELISION
Special type to denote elision (...)
@ 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::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
std::string EncodeBase64(std::span< const unsigned char > input)