80 entry.
pushKV(
"confirmations", 0);
85static std::vector<RPCResult>
DecodeTxDoc(
const std::string& txid_field_doc)
91 {
RPCResult::Type::NUM,
"vsize",
"The virtual transaction size (differs from size for witness transactions)"},
141 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
142 "At least one output of either type must be specified.\n"
143 "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
144 " accepted as second parameter.",
160 "Allows this transaction to be replaced by a transaction with higher fees. If provided, it is an error if explicit sequence numbers are incompatible."},
181 std::map<COutPoint, Coin> coins;
185 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
187 const CTxIn& tx_in = psbtx.
tx->vin.at(i);
211 if (!coins.empty()) {
213 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
218 const CTxIn& tx_in = psbtx.
tx->vin.at(i);
229 for (
unsigned int i = 0; i < psbtx.
tx->vin.size(); ++i) {
245 for (
unsigned int i = 0; i < psbtx.
tx->vout.size(); ++i) {
259 "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
260 "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
261 "If a blockhash argument is passed, it will return the transaction if\n"
262 "the specified block is available and the transaction is in that block.\n\n"
263 "Hint: Use gettransaction for wallet transactions.\n\n"
265 "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
266 "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
267 "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
275 RPCResult{
"if verbosity is not set or set to 0",
280 Cat<std::vector<RPCResult>>(
282 {
RPCResult::Type::BOOL,
"in_active_chain",
true,
"Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
289 DecodeTxDoc(
"The transaction id (same as provided)")),
301 {
RPCResult::Type::OBJ,
"prevout",
true,
"The previous output, omitted if block undo data is not available",
316 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 0 \"myblockhash\"")
317 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 1 \"myblockhash\"")
318 +
HelpExampleCli(
"getrawtransaction",
"\"mytxid\" 2 \"myblockhash\"")
335 if (!request.params[2].isNull()) {
345 bool f_txindex_ready =
false;
347 f_txindex_ready =
g_txindex->BlockUntilSyncedToCurrentChain();
356 if (!block_has_data) {
359 errmsg =
"No such transaction found in the provided block";
361 errmsg =
"No such mempool transaction. Use -txindex or provide a block hash to enable blockchain transaction queries";
362 }
else if (!f_txindex_ready) {
363 errmsg =
"No such mempool transaction. Blockchain transactions are still in the process of being indexed";
365 errmsg =
"No such mempool or blockchain transaction";
370 if (verbosity <= 0) {
380 if (request.params[2].isNull()) {
384 if (verbosity == 1) {
397 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.");
400 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.");
405 if (it != block.
vtx.end()) {
407 undoTX = &blockUndo.
vtxundo.at(it - block.
vtx.begin() - 1);
418 "createrawtransaction",
419 "Create a transaction spending the given inputs and creating new outputs.\n"
420 "Outputs can be addresses or data.\n"
421 "Returns hex-encoded raw transaction.\n"
422 "Note that the transaction's inputs are not signed, and\n"
423 "it is not stored in the wallet or transmitted to the network.\n",
429 HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
430 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
431 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"address\\\":0.01}]\"")
432 +
HelpExampleRpc(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\", \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
436 std::optional<bool> rbf;
437 if (!request.params[3].isNull()) {
450 "Return a JSON object representing the serialized, hex-encoded transaction.",
454 "If iswitness is not present, heuristic tests will be used in decoding.\n"
455 "If true, only witness deserialization will be tried.\n"
456 "If false, only non-witness deserialization will be tried.\n"
457 "This boolean should reflect whether the transaction has inputs\n"
458 "(e.g. fully valid, or on-chain transactions), if known by the caller."
473 bool try_witness = request.params[1].isNull() ? true : request.params[1].get_bool();
474 bool try_no_witness = request.params[1].isNull() ? true : !request.params[1].get_bool();
476 if (!
DecodeHexTx(mtx, request.params[0].get_str(), try_no_witness, try_witness)) {
492 "Decode a hex-encoded script.\n",
502 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
504 "address of P2SH script wrapping this redeem script (not returned for types that should not be wrapped)"},
506 "Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped)",
510 {
RPCResult::Type::STR,
"type",
"The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash)"},
511 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
513 {
RPCResult::Type::STR,
"p2sh-segwit",
"address of the P2SH script wrapping this witness redeem script"},
525 if (request.params[0].get_str().size() > 0){
526 std::vector<unsigned char> scriptData(
ParseHexV(request.params[0],
"argument"));
533 std::vector<std::vector<unsigned char>> solutions_data;
536 const bool can_wrap{[&] {
537 switch (which_type) {
571 const bool can_wrap_P2WSH{[&] {
572 switch (which_type) {
577 for (
const auto& solution : solutions_data) {
599 if (can_wrap_P2WSH) {
614 r.
pushKV(
"segwit", std::move(sr));
626 "combinerawtransaction",
627 "Combine multiple partially signed transactions into one transaction.\n"
628 "The combined transaction may be another partially signed transaction or a \n"
629 "fully signed transaction.",
641 HelpExampleCli(
"combinerawtransaction", R
"('["myhex1", "myhex2", "myhex3"]')")
647 std::vector<CMutableTransaction> txVariants(txs.
size());
649 for (
unsigned int idx = 0; idx < txs.
size(); idx++) {
650 if (!
DecodeHexTx(txVariants[idx], txs[idx].get_str())) {
655 if (txVariants.empty()) {
675 for (
const CTxIn& txin : mergedTx.
vin) {
686 for (
unsigned int i = 0; i < mergedTx.
vin.size(); i++) {
696 if (txv.vin.size() > i) {
713 "signrawtransactionwithkey",
714 "Sign inputs for raw transaction (serialized, hex-encoded).\n"
715 "The second argument is an array of base58-encoded private\n"
716 "keys that will be the only keys used to sign the transaction.\n"
717 "The third optional argument (may be null) is an array of previous transaction outputs that\n"
718 "this transaction depends on but may not yet be in the block chain.\n",
745 " \"ALL|ANYONECANPAY\"\n"
746 " \"NONE|ANYONECANPAY\"\n"
747 " \"SINGLE|ANYONECANPAY\"\n"
773 HelpExampleCli(
"signrawtransactionwithkey",
"\"myhex\" \"[\\\"key1\\\",\\\"key2\\\"]\"")
774 +
HelpExampleRpc(
"signrawtransactionwithkey",
"\"myhex\", \"[\\\"key1\\\",\\\"key2\\\"]\"")
779 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
785 for (
unsigned int idx = 0; idx < keys.
size(); ++idx) {
794 keystore.
pubkeys.emplace(key_id, pubkey);
795 keystore.
keys.emplace(key_id, key);
799 std::map<COutPoint, Coin> coins;
821 {
RPCResult::Type::OBJ,
"non_witness_utxo",
true,
"Decoded network transaction for non-witness UTXOs",
834 {
RPCResult::Type::STR,
"address",
true,
"The Bitcoin address (only if a well-defined address exists)"},
891 {
RPCResult::Type::OBJ,
"signature",
true,
"The signature for the pubkey and leaf hash combination",
929 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
940 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this pubnonce."},
941 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this pubnonce is for."},
942 {
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."},
950 {
RPCResult::Type::STR_HEX,
"participant_pubkey",
"The compressed public key of the participant that created this partial signature."},
951 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which this partial signature is for."},
952 {
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."},
1001 {
RPCResult::Type::ARR,
"taproot_tree",
true,
"The tuples that make up the Taproot tree, in depth first search order",
1027 {
RPCResult::Type::STR_HEX,
"aggregate_pubkey",
"The compressed aggregate public key for which the participants create."},
1056 "Return a JSON object representing the serialized, base64-encoded partially signed Bitcoin transaction.",
1076 {
RPCResult::Type::NUM,
"psbt_version",
"The PSBT version number. Not to be confused with the unsigned transaction version"},
1113 result.
pushKV(
"tx", std::move(tx_univ));
1118 for (
auto& xpub : xpub_pair.second) {
1119 std::vector<unsigned char> ser_xpub;
1121 xpub.EncodeWithVersion(ser_xpub.data());
1125 keypath.
pushKV(
"master_fingerprint",
HexStr(std::span<unsigned char>(xpub_pair.first.fingerprint, xpub_pair.first.fingerprint + 4)));
1127 global_xpubs.
push_back(std::move(keypath));
1130 result.
pushKV(
"global_xpubs", std::move(global_xpubs));
1139 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1140 this_prop.
pushKV(
"subtype", entry.subtype);
1143 proprietary.
push_back(std::move(this_prop));
1145 result.
pushKV(
"proprietary", std::move(proprietary));
1149 for (
auto entry : psbtx.
unknown) {
1152 result.
pushKV(
"unknown", std::move(unknowns));
1156 bool have_all_utxos =
true;
1158 for (
unsigned int i = 0; i < psbtx.
inputs.size(); ++i) {
1162 bool have_a_utxo =
false;
1172 out.pushKV(
"scriptPubKey", std::move(o));
1174 in.
pushKV(
"witness_utxo", std::move(
out));
1183 in.
pushKV(
"non_witness_utxo", std::move(non_wit));
1189 total_in += txout.
nValue;
1192 have_all_utxos =
false;
1195 have_all_utxos =
false;
1204 in.
pushKV(
"partial_signatures", std::move(partial_sigs));
1216 in.
pushKV(
"redeem_script", std::move(r));
1221 in.
pushKV(
"witness_script", std::move(r));
1235 in.
pushKV(
"bip32_derivs", std::move(keypaths));
1243 in.
pushKV(
"final_scriptSig", std::move(scriptsig));
1250 in.
pushKV(
"final_scriptwitness", std::move(txinwitness));
1259 in.
pushKV(
"ripemd160_preimages", std::move(ripemd160_preimages));
1268 in.
pushKV(
"sha256_preimages", std::move(sha256_preimages));
1277 in.
pushKV(
"hash160_preimages", std::move(hash160_preimages));
1286 in.
pushKV(
"hash256_preimages", std::move(hash256_preimages));
1298 const auto& [xonly, leaf_hash] = pubkey_leaf;
1303 script_sigs.
push_back(std::move(sigobj));
1305 in.
pushKV(
"taproot_script_path_sigs", std::move(script_sigs));
1311 for (
const auto& [leaf, control_blocks] : input.
m_tap_scripts) {
1312 const auto& [
script, leaf_ver] = leaf;
1315 script_info.
pushKV(
"leaf_ver", leaf_ver);
1317 for (
const auto& control_block : control_blocks) {
1320 script_info.
pushKV(
"control_blocks", std::move(control_blocks_univ));
1321 tap_scripts.
push_back(std::move(script_info));
1323 in.
pushKV(
"taproot_scripts", std::move(tap_scripts));
1330 const auto& [leaf_hashes, origin] = leaf_origin;
1336 for (
const auto& leaf_hash : leaf_hashes) {
1339 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1340 keypaths.
push_back(std::move(path_obj));
1342 in.
pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1362 for (
const auto& pub : parts) {
1365 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1368 in.
pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1373 const auto& [agg, lh] = agg_lh;
1374 for (
const auto& [part, pubnonce] : part_pubnonce) {
1378 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1383 in.
pushKV(
"musig2_pubnonces", musig_pubnonces);
1388 const auto& [agg, lh] = agg_lh;
1389 for (
const auto& [part, psig] : part_psig) {
1393 if (!lh.IsNull()) info.
pushKV(
"leaf_hash",
HexStr(lh));
1398 in.
pushKV(
"musig2_partial_sigs", musig_partial_sigs);
1406 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1407 this_prop.
pushKV(
"subtype", entry.subtype);
1410 proprietary.
push_back(std::move(this_prop));
1412 in.
pushKV(
"proprietary", std::move(proprietary));
1416 if (input.
unknown.size() > 0) {
1418 for (
auto entry : input.
unknown) {
1421 in.
pushKV(
"unknown", std::move(unknowns));
1426 result.
pushKV(
"inputs", std::move(inputs));
1431 for (
unsigned int i = 0; i < psbtx.
outputs.size(); ++i) {
1438 out.pushKV(
"redeem_script", std::move(r));
1443 out.pushKV(
"witness_script", std::move(r));
1456 out.pushKV(
"bip32_derivs", std::move(keypaths));
1469 elem.
pushKV(
"depth", (
int)depth);
1470 elem.
pushKV(
"leaf_ver", (
int)leaf_ver);
1474 out.pushKV(
"taproot_tree", std::move(tree));
1481 const auto& [leaf_hashes, origin] = leaf_origin;
1487 for (
const auto& leaf_hash : leaf_hashes) {
1490 path_obj.
pushKV(
"leaf_hashes", std::move(leaf_hashes_arr));
1491 keypaths.
push_back(std::move(path_obj));
1493 out.pushKV(
"taproot_bip32_derivs", std::move(keypaths));
1503 for (
const auto& pub : parts) {
1506 musig_part.
pushKV(
"participant_pubkeys", part_pubkeys);
1509 out.pushKV(
"musig2_participant_pubkeys", musig_pubkeys);
1517 this_prop.
pushKV(
"identifier",
HexStr(entry.identifier));
1518 this_prop.
pushKV(
"subtype", entry.subtype);
1521 proprietary.
push_back(std::move(this_prop));
1523 out.pushKV(
"proprietary", std::move(proprietary));
1527 if (output.
unknown.size() > 0) {
1529 for (
auto entry : output.
unknown) {
1532 out.pushKV(
"unknown", std::move(unknowns));
1539 output_value += psbtx.
tx->vout[i].nValue;
1542 have_all_utxos =
false;
1545 result.
pushKV(
"outputs", std::move(outputs));
1546 if (have_all_utxos) {
1559 "Combine multiple partially signed Bitcoin transactions into one transaction.\n"
1560 "Implements the Combiner role.\n",
1572 HelpExampleCli(
"combinepsbt", R
"('["mybase64_1", "mybase64_2", "mybase64_3"]')")
1577 std::vector<PartiallySignedTransaction> psbtxs;
1582 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1588 psbtxs.push_back(psbtx);
1597 ssTx << merged_psbt;
1606 "Finalize the inputs of a PSBT. If the transaction is fully signed, it will produce a\n"
1607 "network serialized transaction which can be broadcast with sendrawtransaction. Otherwise a PSBT will be\n"
1608 "created which has the final_scriptSig and final_scriptWitness fields filled for inputs that are complete.\n"
1609 "Implements the Finalizer and Extractor roles.\n",
1613 " extract and return the complete transaction in normal network serialization instead of the PSBT."},
1618 {
RPCResult::Type::STR,
"psbt",
true,
"The base64-encoded partially signed transaction if not extracted"},
1635 bool extract = request.params[1].isNull() || (!request.params[1].isNull() && request.params[1].get_bool());
1642 std::string result_str;
1646 result_str =
HexStr(ssTx);
1647 result.
pushKV(
"hex", result_str);
1651 result.
pushKV(
"psbt", result_str);
1653 result.
pushKV(
"complete", complete);
1664 "Creates a transaction in the Partially Signed Transaction format.\n"
1665 "Implements the Creator role.\n"
1666 "Note that the transaction's inputs are not signed, and\n"
1667 "it is not stored in the wallet or transmitted to the network.\n",
1673 HelpExampleCli(
"createpsbt",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"address\\\":0.01}]\"")
1678 std::optional<bool> rbf;
1679 if (!request.params[3].isNull()) {
1680 rbf = request.params[3].
get_bool();
1687 for (
unsigned int i = 0; i < rawTx.
vin.size(); ++i) {
1688 psbtx.
inputs.emplace_back();
1690 for (
unsigned int i = 0; i < rawTx.
vout.size(); ++i) {
1707 "Converts a network serialized transaction to a PSBT. This should be used only with createrawtransaction and fundrawtransaction\n"
1708 "createpsbt and walletcreatefundedpsbt should be used for new applications.\n",
1712 " will continue. If false, RPC will fail if any signatures are present."},
1714 "If iswitness is not present, heuristic tests will be used in decoding.\n"
1715 "If true, only witness deserialization will be tried.\n"
1716 "If false, only non-witness deserialization will be tried.\n"
1717 "This boolean should reflect whether the transaction has inputs\n"
1718 "(e.g. fully valid, or on-chain transactions), if known by the caller."
1725 "\nCreate a transaction\n"
1726 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
1727 "\nConvert the transaction to a PSBT\n"
1734 bool permitsigdata = request.params[1].isNull() ? false : request.params[1].get_bool();
1735 bool witness_specified = !request.params[2].isNull();
1736 bool iswitness = witness_specified ? request.params[2].get_bool() :
false;
1737 const bool try_witness = witness_specified ? iswitness :
true;
1738 const bool try_no_witness = witness_specified ? !iswitness :
true;
1739 if (!
DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
1755 for (
unsigned int i = 0; i < tx.
vin.size(); ++i) {
1756 psbtx.
inputs.emplace_back();
1758 for (
unsigned int i = 0; i < tx.
vout.size(); ++i) {
1775 "Updates all segwit inputs and outputs in a PSBT with data from output descriptors, the UTXO set, txindex, or the mempool.\n",
1787 RPCResult::Type::STR,
"",
"The base64-encoded partially signed transaction with inputs updated"
1796 if (!request.params[1].isNull()) {
1797 auto descs = request.params[1].get_array();
1798 for (
size_t i = 0; i < descs.size(); ++i) {
1805 request.params[0].get_str(),
1822 "Joins multiple distinct PSBTs with different inputs and outputs into one PSBT with inputs and outputs from all of the PSBTs\n"
1823 "No input in any of the PSBTs can be in more than one of the PSBTs.\n",
1839 std::vector<PartiallySignedTransaction> psbtxs;
1842 if (txs.
size() <= 1) {
1846 uint32_t best_version = 1;
1847 uint32_t best_locktime = 0xffffffff;
1848 for (
unsigned int i = 0; i < txs.
size(); ++i) {
1854 psbtxs.push_back(psbtx);
1856 if (psbtx.
tx->version > best_version) {
1857 best_version = psbtx.
tx->version;
1860 if (psbtx.
tx->nLockTime < best_locktime) {
1861 best_locktime = psbtx.
tx->nLockTime;
1868 merged_psbt.
tx->version = best_version;
1869 merged_psbt.
tx->nLockTime = best_locktime;
1872 for (
auto& psbt : psbtxs) {
1873 for (
unsigned int i = 0; i < psbt.tx->vin.size(); ++i) {
1874 if (!merged_psbt.
AddInput(psbt.tx->vin[i], psbt.inputs[i])) {
1878 for (
unsigned int i = 0; i < psbt.tx->vout.size(); ++i) {
1879 merged_psbt.
AddOutput(psbt.tx->vout[i], psbt.outputs[i]);
1881 for (
auto& xpub_pair : psbt.m_xpubs) {
1882 if (merged_psbt.
m_xpubs.count(xpub_pair.first) == 0) {
1883 merged_psbt.
m_xpubs[xpub_pair.first] = xpub_pair.second;
1885 merged_psbt.
m_xpubs[xpub_pair.first].insert(xpub_pair.second.begin(), xpub_pair.second.end());
1888 merged_psbt.
unknown.insert(psbt.unknown.begin(), psbt.unknown.end());
1892 std::vector<int> input_indices(merged_psbt.
inputs.size());
1893 std::iota(input_indices.begin(), input_indices.end(), 0);
1894 std::vector<int> output_indices(merged_psbt.
outputs.size());
1895 std::iota(output_indices.begin(), output_indices.end(), 0);
1899 std::shuffle(output_indices.begin(), output_indices.end(),
FastRandomContext());
1903 shuffled_psbt.
tx->version = merged_psbt.
tx->version;
1904 shuffled_psbt.
tx->nLockTime = merged_psbt.
tx->nLockTime;
1905 for (
int i : input_indices) {
1908 for (
int i : output_indices) {
1914 ssTx << shuffled_psbt;
1924 "Analyzes and provides information about the current status of a PSBT and its inputs\n",
1937 {
RPCResult::Type::OBJ,
"missing",
true,
"Things that are missing that are required to complete this input",
1941 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose BIP 32 derivation path is missing"},
1945 {
RPCResult::Type::STR_HEX,
"keyid",
"Public key ID, hash160 of the public key, of a public key whose signature is missing"},
1950 {
RPCResult::Type::STR,
"next",
true,
"Role of the next person that this input needs to go to"},
1953 {
RPCResult::Type::NUM,
"estimated_vsize",
true,
"Estimated vsize of the final signed transaction"},
1954 {
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"},
1955 {
RPCResult::Type::STR_AMOUNT,
"fee",
true,
"The transaction fee paid. Shown only if all UTXO slots in the PSBT have been filled"},
1976 for (
const auto& input : psbta.
inputs) {
1980 input_univ.
pushKV(
"has_utxo", input.has_utxo);
1981 input_univ.
pushKV(
"is_final", input.is_final);
1984 if (!input.missing_pubkeys.empty()) {
1986 for (
const CKeyID& pubkey : input.missing_pubkeys) {
1989 missing.
pushKV(
"pubkeys", std::move(missing_pubkeys_univ));
1991 if (!input.missing_redeem_script.IsNull()) {
1992 missing.
pushKV(
"redeemscript",
HexStr(input.missing_redeem_script));
1994 if (!input.missing_witness_script.IsNull()) {
1995 missing.
pushKV(
"witnessscript",
HexStr(input.missing_witness_script));
1997 if (!input.missing_sigs.empty()) {
1999 for (
const CKeyID& pubkey : input.missing_sigs) {
2002 missing.
pushKV(
"signatures", std::move(missing_sigs_univ));
2004 if (!missing.
getKeys().empty()) {
2005 input_univ.
pushKV(
"missing", std::move(missing));
2007 inputs_result.
push_back(std::move(input_univ));
2009 if (!inputs_result.
empty()) result.
pushKV(
"inputs", std::move(inputs_result));
2017 if (psbta.
fee != std::nullopt) {
2021 if (!psbta.
error.empty()) {
2033 "descriptorprocesspsbt",
2034 "Update all segwit inputs in a PSBT with information from output descriptors, the UTXO set or the mempool. \n"
2035 "Then, sign the inputs we are able to with information from the output descriptors. ",
2045 {
"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"
2050 " \"ALL|ANYONECANPAY\"\n"
2051 " \"NONE|ANYONECANPAY\"\n"
2052 " \"SINGLE|ANYONECANPAY\""},
2065 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[\\\"descriptor1\\\", \\\"descriptor2\\\"]\"") +
2066 HelpExampleCli(
"descriptorprocesspsbt",
"\"psbt\" \"[{\\\"desc\\\":\\\"mydescriptor\\\", \\\"range\\\":21}]\"")
2073 auto descs = request.params[1].get_array();
2074 for (
size_t i = 0; i < descs.size(); ++i) {
2079 bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
2080 bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
2083 request.params[0].get_str(),
2090 bool complete =
true;
2091 for (
const auto& input : psbtx.
inputs) {
2101 result.
pushKV(
"complete", complete);
2134 for (
const auto& c : commands) {
2135 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
void SetBackend(CCoinsView &viewIn)
CCoinsView that adds a memory cache for transactions to another CCoinsView.
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Abstract view on the open txout dataset.
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.
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 ...
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
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.
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
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.
Double ended buffer combining vector and stream-like interfaces.
A signature creator for transactions.
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
bool ReadBlock(CBlock &block, const FlatFilePos &pos, const std::optional< uint256 > &expected_hash={}) const
Functions for disk access for blocks.
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
std::string EncodeHexTx(const CTransaction &tx)
std::string SighashToStr(unsigned char sighash_type)
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex=true, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
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.
std::string ScriptToAsmStr(const CScript &script, const bool fAttemptSighashDecode=false)
Create the assembly string representation of a CScript object.
void ScriptToUniv(const CScript &script, UniValue &out, bool include_hex=true, bool include_address=false, const SigningProvider *provider=nullptr)
UniValue ValueFromAmount(const CAmount amount)
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness=false, bool try_witness=true)
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)
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.
CTransactionRef GetTransaction(const CBlockIndex *const block_index, const CTxMemPool *const mempool, const uint256 &hash, uint256 &hashBlock, const BlockManager &blockman)
Return transaction with a given hash.
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 RPCHelpMan getrawtransaction()
static RPCHelpMan utxoupdatepsbt()
const RPCResult decodepsbt_inputs
static void TxToJSON(const CTransaction &tx, const uint256 hashBlock, UniValue &entry, Chainstate &active_chainstate, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS)
static RPCHelpMan converttopsbt()
PartiallySignedTransaction ProcessPSBT(const std::string &psbt_string, const std::any &context, const HidingSigningProvider &provider, std::optional< int > sighash_type, bool finalize)
const RPCResult decodepsbt_outputs
static std::vector< RPCArg > CreateTxDoc()
static RPCHelpMan analyzepsbt()
static RPCHelpMan decoderawtransaction()
RPCHelpMan descriptorprocesspsbt()
static RPCHelpMan combinepsbt()
static RPCHelpMan decodepsbt()
static RPCHelpMan decodescript()
static RPCHelpMan createpsbt()
static RPCHelpMan joinpsbts()
static std::vector< RPCResult > DecodeTxDoc(const std::string &txid_field_doc)
static RPCHelpMan combinerawtransaction()
static RPCHelpMan signrawtransactionwithkey()
static RPCHelpMan createrawtransaction()
static RPCHelpMan finalizepsbt()
void RegisterRawTransactionRPCCommands(CRPCTable &t)
CMutableTransaction ConstructTransaction(const UniValue &inputs_in, const UniValue &outputs_in, const UniValue &locktime, std::optional< bool > rbf)
Create a transaction from univalue parameters.
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.
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.
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)