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;
147 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
149 const CTxIn& tx_in = psbtx.
tx->vin.at(i);
173 if (!coins.empty()) {
175 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
180 const CTxIn& tx_in = psbtx.
tx->vin.at(i);
191 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
207 for (
unsigned int i = 0; i < psbtx.
tx->vout.size(); ++i) {
221 "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
222 "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
223 "If a blockhash argument is passed, it will return the transaction if\n"
224 "the specified block is available and the transaction is in that block.\n\n"
225 "Hint: Use gettransaction for wallet transactions.\n\n"
227 "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
228 "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
229 "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
237 RPCResult{
"if verbosity is not set or set to 0",
242 Cat<std::vector<RPCResult>>(
244 {
RPCResult::Type::BOOL,
"in_active_chain",
true,
"Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
251 TxDoc({.txid_field_doc=
"The transaction id (same as provided)"})),
263 {
RPCResult::Type::OBJ,
"prevout",
true,
"The previous output, omitted if block undo data is not available",
278 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 0 \"myblockhash\"")
279 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 1 \"myblockhash\"")
280 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 2 \"myblockhash\"")
297 if (!request.params[2].isNull()) {
307 bool f_txindex_ready =
false;
309 f_txindex_ready =
g_txindex->BlockUntilSyncedToCurrentChain();
318 if (!block_has_data) {
321 errmsg =
"No such transaction found in the provided block";
323 errmsg =
"No such mempool transaction. Use -txindex or provide a block hash to enable blockchain transaction queries";
324 }
else if (!f_txindex_ready) {
325 errmsg =
"No such mempool transaction. Blockchain transactions are still in the process of being indexed";
327 errmsg =
"No such mempool or blockchain transaction";
332 if (verbosity <= 0) {
342 if (request.params[2].isNull()) {
346 if (verbosity == 1) {
359 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.");
362 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.");
367 if (it != block.
vtx.end()) {
369 undoTX = &blockUndo.
vtxundo.at(it - block.
vtx.begin() - 1);
380 "createrawtransaction",
381 "Create a transaction spending the given inputs and creating new outputs.\n"
382 "Outputs can be addresses or data.\n"
383 "Returns hex-encoded raw transaction.\n"
384 "Note that the transaction's inputs are not signed, and\n"
385 "it is not stored in the wallet or transmitted to the network.\n",
391 HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
392 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
393 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"address\\\":0.01}]\"")
394 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
398 std::optional<bool> rbf;
399 if (!request.params[3].isNull()) {
412 "Return a JSON object representing the serialized, hex-encoded transaction.",
416 "If iswitness is not present, heuristic tests will be used in decoding.\n"
417 "If true, only witness deserialization will be tried.\n"
418 "If false, only non-witness deserialization will be tried.\n"
419 "This boolean should reflect whether the transaction has inputs\n"
420 "(e.g. fully valid, or on-chain transactions), if known by the caller."
435 bool try_witness = request.params[1].isNull() ? true : request.params[1].get_bool();
436 bool try_no_witness = request.params[1].isNull() ? true : !request.params[1].get_bool();
438 if (!
DecodeHexTx(mtx, request.params[0].get_str(), try_no_witness, try_witness)) {
454 "Decode a hex-encoded script.\n",
464 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
466 "address of P2SH script wrapping this redeem script (not returned for types that should not be wrapped)"},
468 "Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped)",
472 {
RPCResult::Type::STR,
"type",
"The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash)"},
473 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
475 {
RPCResult::Type::STR,
"p2sh-segwit",
"address of the P2SH script wrapping this witness redeem script"},
487 if (request.params[0].get_str().size() > 0){
488 std::vector<unsigned char> scriptData(
ParseHexV(request.params[0],
"argument"));
495 std::vector<std::vector<unsigned char>> solutions_data;
498 const bool can_wrap{[&] {
499 switch (which_type) {
533 const bool can_wrap_P2WSH{[&] {
534 switch (which_type) {
539 for (
const auto& solution : solutions_data) {
561 if (can_wrap_P2WSH) {
576 r.
pushKV(
"segwit", std::move(sr));
588 "combinerawtransaction",
589 "Combine multiple partially signed transactions into one transaction.\n"
590 "The combined transaction may be another partially signed transaction or a \n"
591 "fully signed transaction.",
603 HelpExampleCli(
"combinerawtransaction", R
"('["myhex1", "myhex2", "myhex3"]')")
609 std::vector<CMutableTransaction> txVariants(txs.
size());
611 for (
unsigned int idx = 0; idx < txs.
size(); idx++) {
612 if (!
DecodeHexTx(txVariants[idx], txs[idx].get_str())) {
617 if (txVariants.empty()) {
634 view.SetBackend(viewMempool);
636 for (
const CTxIn& txin : mergedTx.
vin) {
647 for (
unsigned int i = 0; i < mergedTx.
vin.size(); i++) {
657 if (txv.vin.size() > i) {
674 "signrawtransactionwithkey",
675 "Sign inputs for raw transaction (serialized, hex-encoded).\n"
676 "The second argument is an array of base58-encoded private\n"
677 "keys that will be the only keys used to sign the transaction.\n"
678 "The third optional argument (may be null) is an array of previous transaction outputs that\n"
679 "this transaction depends on but may not yet be in the block chain.\n",
706 " \"ALL|ANYONECANPAY\"\n"
707 " \"NONE|ANYONECANPAY\"\n"
708 " \"SINGLE|ANYONECANPAY\"\n"
734 HelpExampleCli(
"signrawtransactionwithkey",
"\"myhex\" \"[\\\"key1\\\",\\\"key2\\\"]\"")
735 +
HelpExampleRpc(
"signrawtransactionwithkey",
"\"myhex\", \"[\\\"key1\\\",\\\"key2\\\"]\"")
740 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
746 for (
unsigned int idx = 0; idx < keys.
size(); ++idx) {
755 keystore.
pubkeys.emplace(key_id, pubkey);
756 keystore.
keys.emplace(key_id, key);
760 std::map<COutPoint, Coin> coins;
779 static const RPCResult decodepsbt_inputs{
784 {
RPCResult::Type::OBJ,
"non_witness_utxo",
true,
"Decoded network transaction for non-witness UTXOs",
785 TxDoc({.elision_description=
"The layout is the same as the output of decoderawtransaction."})
796 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
853 {
RPCResult::Type::OBJ,
"signature",
true,
"The signature for the pubkey and leaf hash combination",
891 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
902 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this pubnonce."},
903 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this pubnonce is for."},
904 {
RPCResult::Type::STR_HEX,
"leaf_hash",
true,
"The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
912 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this partial signature."},
913 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this partial signature is for."},
914 {
RPCResult::Type::STR_HEX,
"leaf_hash",
true,
"The hash of the leaf script that contains the aggregate pubkey being signed for. Omitted when signing for the internal key."},
935 return decodepsbt_inputs;
940 static const RPCResult decodepsbt_outputs{
967 {
RPCResult::Type::ARR,
"taproot_tree",
true,
"The tuples that make up the Taproot tree, in depth first search order",
993 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
1017 return decodepsbt_outputs;
1024 "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
1032 TxDoc({.elision_description=
"The layout is the same as the output of decoderawtransaction."})
1043 {
RPCResult::Type::NUM,
"psbt_version",
"The PSBT version number. Not to be confused with the unsigned transaction version"},
1080 result.
pushKV(
"tx", std::move(tx_univ));
1085 for (
auto& xpub : xpub_pair.second) {
1086 std::vector<unsigned char> ser_xpub;
1088 xpub.EncodeWithVersion(ser_xpub.data());
1092 keypath.
pushKV(
"master_fingerprint",
HexStr(std::span<unsigned char>(xpub_pair.first.fingerprint, xpub_pair.first.fingerprint + 4)));
1094 global_xpubs.
push_back(std::move(keypath));
1097 result.
pushKV(
"global_xpubs", std::move(global_xpubs));
1106 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1107 this_prop.
pushKV(
"subtype", entry.subtype);
1110 proprietary.
push_back(std::move(this_prop));
1112 result.
pushKV(
"proprietary", std::move(proprietary));
1116 for (
auto entry : psbtx.
unknown) {
1119 result.
pushKV(
"unknown", std::move(unknowns));
1123 bool have_all_utxos =
true;
1125 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
1129 bool have_a_utxo =
false;
1139 out.pushKV(
"scriptPubKey", std::move(o));
1141 in.
pushKV(
"witness_utxo", std::move(
out));
1150 in.
pushKV(
"non_witness_utxo", std::move(non_wit));
1156 total_in += txout.
nValue;
1159 have_all_utxos =
false;
1162 have_all_utxos =
false;
1171 in.
pushKV(
"partial_signatures", std::move(partial_sigs));
1183 in.
pushKV(
"redeem_script", std::move(r));
1188 in.
pushKV(
"witness_script", std::move(r));
1202 in.
pushKV(
"bip32_derivs", std::move(keypaths));
1210 in.
pushKV(
"final_scriptSig", std::move(scriptsig));
1217 in.
pushKV(
"final_scriptwitness", std::move(txinwitness));
1226 in.
pushKV(
"ripemd160_preimages", std::move(ripemd160_preimages));
1235 in.
pushKV(
"sha256_preimages", std::move(sha256_preimages));
1244 in.
pushKV(
"hash160_preimages", std::move(hash160_preimages));
1253 in.
pushKV(
"hash256_preimages", std::move(hash256_preimages));
1265 const auto& [xonly, leaf_hash] = pubkey_leaf;
1270 script_sigs.
push_back(std::move(sigobj));
1272 in.
pushKV(
"taproot_script_path_sigs", std::move(script_sigs));
1278 for (
const auto& [leaf, control_blocks] : input.
m_tap_scripts) {
1279 const auto& [
script, leaf_ver] = leaf;
1282 script_info.
pushKV(
"leaf_ver", leaf_ver);
1284 for (
const auto& control_block : control_blocks) {
1287 script_info.
pushKV(
"control_blocks", std::move(control_blocks_univ));
1288 tap_scripts.
push_back(std::move(script_info));
1290 in.
pushKV(
"taproot_scripts", std::move(tap_scripts));
1297 const auto& [leaf_hashes, origin] = leaf_origin;
1303 for (
const auto& leaf_hash : leaf_hashes) {
1306 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1307 keypaths.
push_back(std::move(path_obj));
1309 in.
pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1329 for (
const auto& pub : parts) {
1332 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1335 in.
pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1340 const auto& [agg, lh] = agg_lh;
1341 for (
const auto& [part, pubnonce] : part_pubnonce) {
1345 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1350 in.
pushKV(
"musig2_pubnonces", musig_pubnonces);
1355 const auto& [agg, lh] = agg_lh;
1356 for (
const auto& [part, psig] : part_psig) {
1360 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1365 in.
pushKV(
"musig2_partial_sigs", musig_partial_sigs);
1373 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1374 this_prop.
pushKV(
"subtype", entry.subtype);
1377 proprietary.
push_back(std::move(this_prop));
1379 in.
pushKV(
"proprietary", std::move(proprietary));
1383 if (input.
unknown.size() > 0) {
1385 for (
auto entry : input.
unknown) {
1388 in.
pushKV(
"unknown", std::move(unknowns));
1393 result.
pushKV(
"inputs", std::move(inputs));
1398 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
1405 out.pushKV(
"redeem_script", std::move(r));
1410 out.pushKV(
"witness_script", std::move(r));
1423 out.pushKV(
"bip32_derivs", std::move(keypaths));
1436 elem.
pushKV(
"depth", depth);
1437 elem.
pushKV(
"leaf_ver", leaf_ver);
1441 out.pushKV(
"taproot_tree", std::move(tree));
1448 const auto& [leaf_hashes, origin] = leaf_origin;
1454 for (
const auto& leaf_hash : leaf_hashes) {
1457 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1458 keypaths.
push_back(std::move(path_obj));
1460 out.pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1470 for (
const auto& pub : parts) {
1473 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1476 out.pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1484 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1485 this_prop.
pushKV(
"subtype", entry.subtype);
1488 proprietary.
push_back(std::move(this_prop));
1490 out.pushKV(
"proprietary", std::move(proprietary));
1494 if (output.
unknown.size() > 0) {
1496 for (
auto entry : output.
unknown) {
1499 out.pushKV(
"unknown", std::move(unknowns));
1506 output_value += psbtx.
tx->vout[i].nValue;
1509 have_all_utxos =
false;
1512 result.
pushKV(
"outputs", std::move(outputs));
1513 if (have_all_utxos) {
1526 "Combine multiple partially signed Bitcoin transactions into one transaction.\n"
1527 "Implements the Combiner role.\n",
1539 HelpExampleCli(
"combinepsbt", R
"('["mybase64_1", "mybase64_2", "mybase64_3"]')")
1544 std::vector<PartiallySignedTransaction> psbtxs;
1549 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1555 psbtxs.push_back(psbtx);
1564 ssTx << merged_psbt;
1573 "Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a\n"
1574 "network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be\n"
1575 "created which has the final_scriptSig and final_scriptwitness fields filled for inputs that are complete.\n"
1576 "Implements the Finalizer and Extractor roles.\n",
1580 " extract and return the complete transaction in normal network serialization instead of the PSBT."},
1585 {
RPCResult::Type::STR,
"psbt",
true,
"The base64-encoded partially signed transaction if not extracted"},
1602 bool extract = request.params[1].isNull() || (!request.params[1].isNull() && request.params[1].get_bool());
1609 std::string result_str;
1613 result_str =
HexStr(ssTx);
1614 result.
pushKV(
"hex", result_str);
1618 result.
pushKV(
"psbt", result_str);
1620 result.
pushKV(
"complete", complete);
1631 "Creates a transaction in the Partially Signed Transaction format.\n"
1632 "Implements the Creator role.\n"
1633 "Note that the transaction's inputs are not signed, and\n"
1634 "it is not stored in the wallet or transmitted to the network.\n",
1640 HelpExampleCli(
"createpsbt",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
1645 std::optional<bool> rbf;
1646 if (!request.params[3].isNull()) {
1647 rbf = request.params[3].
get_bool();
1654 for (
unsigned int i = 0; i < rawTx.
vin.size(); ++i) {
1655 psbtx.
inputs.emplace_back();
1657 for (
unsigned int i = 0; i < rawTx.
vout.size(); ++i) {
1674 "Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction\n"
1675 "createpsbt and walletcreatefundedpsbt should be used for new applications.\n",
1679 " will continue. If false, RPC will fail if any signatures are present."},
1681 "If iswitness is not present, heuristic tests will be used in decoding.\n"
1682 "If true, only witness deserialization will be tried.\n"
1683 "If false, only non-witness deserialization will be tried.\n"
1684 "This boolean should reflect whether the transaction has inputs\n"
1685 "(e.g. fully valid, or on-chain transactions), if known by the caller."
1692 "\nCreate a transaction\n"
1693 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
1694 "\nConvert the transaction to a PSBT\n"
1701 bool permitsigdata = request.params[1].isNull() ? false : request.params[1].get_bool();
1702 bool witness_specified = !request.params[2].isNull();
1703 bool iswitness = witness_specified ? request.params[2].get_bool() :
false;
1704 const bool try_witness = witness_specified ? iswitness :
true;
1705 const bool try_no_witness = witness_specified ? !iswitness :
true;
1706 if (!
DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
1722 for (
unsigned int i = 0; i < tx.
vin.size(); ++i) {
1723 psbtx.
inputs.emplace_back();
1725 for (
unsigned int i = 0; i < tx.
vout.size(); ++i) {
1742 "Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.\n",
1754 RPCResult::Type::STR,
"",
"The base64-encoded partially signed transaction with inputs updated"
1763 if (!request.params[1].isNull()) {
1764 auto descs = request.params[1].get_array();
1765 for (
size_t i = 0; i < descs.size(); ++i) {
1772 request.params[0].get_str(),
1789 "Joins multiple distinct PSBTs with different inputs and outputs into one PSBT with inputs and outputs from all of the PSBTs\n"
1790 "No input in any of the PSBTs can be in more than one of the PSBTs.\n",
1806 std::vector<PartiallySignedTransaction> psbtxs;
1809 if (txs.
size() <= 1) {
1813 uint32_t best_version = 1;
1814 uint32_t best_locktime = 0xffffffff;
1815 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1821 psbtxs.push_back(psbtx);
1823 if (psbtx.
tx->version > best_version) {
1824 best_version = psbtx.
tx->version;
1827 if (psbtx.
tx->nLockTime < best_locktime) {
1828 best_locktime = psbtx.
tx->nLockTime;
1835 merged_psbt.
tx->version = best_version;
1836 merged_psbt.
tx->nLockTime = best_locktime;
1839 for (
auto& psbt : psbtxs) {
1840 for (
unsigned int i = 0; i < psbt.tx->vin.size(); ++i) {
1841 if (!merged_psbt.
AddInput(psbt.tx->vin[i], psbt.inputs[i])) {
1845 for (
unsigned int i = 0; i < psbt.tx->vout.size(); ++i) {
1846 merged_psbt.
AddOutput(psbt.tx->vout[i], psbt.outputs[i]);
1848 for (
auto& xpub_pair : psbt.m_xpubs) {
1849 if (!merged_psbt.
m_xpubs.contains(xpub_pair.first)) {
1850 merged_psbt.
m_xpubs[xpub_pair.first] = xpub_pair.second;
1852 merged_psbt.
m_xpubs[xpub_pair.first].insert(xpub_pair.second.begin(), xpub_pair.second.end());
1855 merged_psbt.
unknown.insert(psbt.unknown.begin(), psbt.unknown.end());
1859 std::vector<int> input_indices(merged_psbt.
inputs.size());
1860 std::iota(input_indices.begin(), input_indices.end(), 0);
1861 std::vector<int> output_indices(merged_psbt.
outputs.size());
1862 std::iota(output_indices.begin(), output_indices.end(), 0);
1866 std::shuffle(output_indices.begin(), output_indices.end(),
FastRandomContext());
1870 shuffled_psbt.
tx->version = merged_psbt.
tx->version;
1871 shuffled_psbt.
tx->nLockTime = merged_psbt.
tx->nLockTime;
1872 for (
int i : input_indices) {
1875 for (
int i : output_indices) {
1881 ssTx << shuffled_psbt;
1891 "Analyzes and provides information about the current status of a PSBT and its inputs\n",
1904 {
RPCResult::Type::OBJ,
"missing",
true,
"Things that are missing that are required to complete this input",
1908 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing"},
1912 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose signature is missing"},
1917 {
RPCResult::Type::STR,
"next",
true,
"Role of the next person that this input needs to go to"},
1920 {
RPCResult::Type::NUM,
"estimated_vsize",
true,
"Estimated vsize of the final signed transaction"},
1921 {
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"},
1922 {
RPCResult::Type::STR_AMOUNT,
"fee",
true,
"The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled"},
1943 for (
const auto& input : psbta.
inputs) {
1947 input_univ.
pushKV(
"has_utxo", input.has_utxo);
1948 input_univ.
pushKV(
"is_final", input.is_final);
1951 if (!input.missing_pubkeys.empty()) {
1953 for (
const CKeyID& pubkey : input.missing_pubkeys) {
1956 missing.
pushKV(
"pubkeys", std::move(missing_pubkeys_univ));
1958 if (!input.missing_redeem_script.IsNull()) {
1959 missing.
pushKV(
"redeemscript",
HexStr(input.missing_redeem_script));
1961 if (!input.missing_witness_script.IsNull()) {
1962 missing.
pushKV(
"witnessscript",
HexStr(input.missing_witness_script));
1964 if (!input.missing_sigs.empty()) {
1966 for (
const CKeyID& pubkey : input.missing_sigs) {
1969 missing.
pushKV(
"signatures", std::move(missing_sigs_univ));
1971 if (!missing.
getKeys().empty()) {
1972 input_univ.
pushKV(
"missing", std::move(missing));
1974 inputs_result.
push_back(std::move(input_univ));
1976 if (!inputs_result.
empty()) result.
pushKV(
"inputs", std::move(inputs_result));
1984 if (psbta.
fee != std::nullopt) {
1988 if (!psbta.
error.empty()) {
2000 "descriptorprocesspsbt",
2001 "Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool. \n"
2002 "Then, sign the inputs we are able to with information from the output descriptors. ",
2012 {
"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"
2017 " \"ALL|ANYONECANPAY\"\n"
2018 " \"NONE|ANYONECANPAY\"\n"
2019 " \"SINGLE|ANYONECANPAY\""},
2032 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[\\\"descriptor1\\\", \\\"descriptor2\\\"]\"") +
2033 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[{\\\"desc\\\":\\\"mydescriptor\\\", \\\"range\\\":21}]\"")
2040 auto descs = request.params[1].get_array();
2041 for (
size_t i = 0; i < descs.size(); ++i) {
2046 bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
2047 bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
2050 request.params[0].get_str(),
2057 bool complete =
true;
2058 for (
const auto& input : psbtx.
inputs) {
2068 result.
pushKV(
"complete", complete);
2101 for (
const auto& c : commands) {
2102 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
int Height() const
Return the maximal height in the chain.
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this 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.
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.
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.
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
bool DecodeBase64PSBT(PartiallySignedTransaction &psbt, const std::string &base64_tx, std::string &error)
Decode a base64ed PSBT into a PartiallySignedTransaction.
void UpdatePSBTOutput(const SigningProvider &provider, PartiallySignedTransaction &psbt, int index)
Updates a PSBTOutput with information from provider.
std::string PSBTRoleName(PSBTRole role)
bool CombinePSBTs(PartiallySignedTransaction &out, 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.
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.
PrecomputedTransactionData PrecomputePSBTData(const PartiallySignedTransaction &psbt)
Compute a PrecomputedTransactionData object from a psbt.
PSBTError SignPSBTInput(const SigningProvider &provider, PartiallySignedTransaction &psbt, int index, const PrecomputedTransactionData *txdata, std::optional< int > sighash, SignatureData *out_sigdata, bool finalize)
Signs a PSBTInput, verifying that all provided data matches what is being signed.
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< CTxOut > vout
std::vector< std::vector< unsigned char > > stack
std::map< CKeyID, CPubKey > pubkeys
std::map< CKeyID, CKey > keys
std::map< CScriptID, CScript > scripts
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.
uint32_t GetVersion() const
std::map< KeyOriginInfo, std::set< CExtPubKey > > m_xpubs
std::map< std::vector< unsigned char >, std::vector< unsigned char > > unknown
bool AddOutput(const CTxOut &txout, const PSBTOutput &psbtout)
std::vector< PSBTInput > inputs
std::optional< CMutableTransaction > tx
bool AddInput(const CTxIn &txin, PSBTInput &psbtin)
std::vector< PSBTOutput > outputs
std::set< PSBTProprietary > m_proprietary
@ 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)