83 "Submit a raw transaction (serialized, hex-encoded) to the network.\n"
85 "\nIf -privatebroadcast is disabled, then the transaction will be put into the\n"
86 "local mempool of the node and will be sent unconditionally to all currently\n"
87 "connected peers, so using sendrawtransaction for manual rebroadcast will degrade\n"
88 "privacy by leaking the transaction's origin, as nodes will normally not\n"
89 "rebroadcast non-wallet transactions already in their mempool.\n"
91 "\nIf -privatebroadcast is enabled, then the transaction will be sent via\n"
92 "dedicated, short-lived connections to Tor or I2P peers, or to IPv4/IPv6 peers\n"
93 "via the Tor network. This provides best-effort concealment of the transaction's origin.\n"
94 "Private broadcast is experimental and may change in future releases.\n"
95 "Submission does not itself add the transaction to the local mempool; normal\n"
96 "mempool acceptance and relay apply when it is received back from the network.\n"
97 "The private broadcast queue is bounded: when it is full, this RPC fails and\n"
98 "the transaction is not scheduled until an existing one completes or is\n"
99 "aborted. Use getprivatebroadcastinfo to inspect the queue and abortprivatebroadcast to abort.\n"
101 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
103 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
107 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
108 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
110 "Reject transactions with provably unspendable outputs (e.g. 'datacarrier' outputs that use the OP_RETURN opcode) greater than the specified value, expressed in " +
CURRENCY_UNIT +
".\n"
111 "If burning funds through unspendable outputs is desired, increase this value.\n"
112 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
118 "\nCreate a transaction\n"
119 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
120 "Sign the transaction, and get back the hex\n"
122 "\nSend the transaction (signed hex)\n"
124 "\nAs a JSON-RPC call\n"
136 for (
const auto& out : mtx.
vout) {
137 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
147 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.
GetFee(virtual_size);
149 std::string err_string;
153 if (private_broadcast_enabled &&
157 "-privatebroadcast is enabled, but none of the Tor or I2P networks is "
158 "reachable. Maybe the location of the Tor proxy couldn't be retrieved "
159 "from the Tor daemon at startup. Check whether the Tor daemon is running "
160 "and that -torcontrol, -torpassword and -i2psam are configured properly.");
174 return tx->GetHash().GetHex();
182 "getprivatebroadcastinfo",
183 "Returns information about transactions tracked for private broadcast.\n"
184 "Transactions that have reached the send-attempt limit remain in the result with attempts_remaining=0.\n"
185 "This method is only available when running with -privatebroadcast enabled.\n",
197 {
RPCResult::Type::NUM_TIME,
"time_added",
"The time this transaction was added to the private broadcast queue (seconds since epoch)"},
198 {
RPCResult::Type::NUM,
"attempts_remaining",
"The number of additional private broadcast send attempts allowed for this transaction"},
199 {
RPCResult::Type::ARR,
"peers",
"Per-peer send and acknowledgment information for this transaction",
204 {
RPCResult::Type::NUM_TIME,
"sent",
"The time this transaction was picked for sending to this peer via private broadcast (seconds since epoch)"},
205 {
RPCResult::Type::NUM_TIME,
"received",
true,
"The time this peer acknowledged reception of the transaction (seconds since epoch)"},
219 if (!
peerman.GetInfo().private_broadcast) {
223 const auto txs{
peerman.GetPrivateBroadcastInfo()};
226 for (
const auto& tx_info : txs) {
228 o.
pushKV(
"txid", tx_info.tx->GetHash().ToString());
229 o.
pushKV(
"wtxid", tx_info.tx->GetWitnessHash().ToString());
232 o.
pushKV(
"attempts_remaining", tx_info.attempts_remaining);
234 for (
const auto& peer : tx_info.peers) {
236 p.
pushKV(
"address", peer.address.ToStringAddrPort());
238 if (peer.received.has_value()) {
243 o.
pushKV(
"peers", std::move(peers));
248 ret.pushKV(
"transactions", std::move(transactions));
257 "abortprivatebroadcast",
258 "Abort private broadcast attempts for a transaction currently being privately broadcast.\n"
259 "The transaction will be removed from the private broadcast queue.\n"
260 "This method is only available when running with -privatebroadcast enabled.\n",
263 "If the provided id matches a txid that corresponds to multiple transactions with different wtxids, multiple transactions will be removed and returned."},
268 {
RPCResult::Type::ARR,
"removed_transactions",
"Transactions removed from the private broadcast queue",
288 if (!
peerman.GetInfo().private_broadcast) {
294 const auto removed_txs{
peerman.AbortPrivateBroadcast(
id)};
295 if (removed_txs.empty()) {
300 for (
const auto& tx : removed_txs) {
302 o.
pushKV(
"txid", tx->GetHash().ToString());
303 o.
pushKV(
"wtxid", tx->GetWitnessHash().ToString());
305 removed_transactions.
push_back(std::move(o));
308 ret.pushKV(
"removed_transactions", std::move(removed_transactions));
318 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
319 "\nIf multiple transactions are passed in, parents must come before children and package policies apply: the transactions cannot conflict with any mempool transactions or each other.\n"
320 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
322 "\nThis checks if transactions violate the consensus or policy rules.\n"
323 "\nSee sendrawtransaction call.\n",
331 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
332 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
335 RPCResult::Type::ARR,
"",
"The result of the mempool acceptance test for each raw transaction in the input array.\n"
336 "Returns results for each transaction in the same order they were passed in.\n"
337 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
343 {
RPCResult::Type::STR,
"package-error",
true,
"Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
344 {
RPCResult::Type::BOOL,
"allowed",
true,
"Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
345 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
346 {
RPCResult::Type::NUM,
"vsize_adjusted",
true,
"Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141 (only present when 'allowed' is true)."},
347 {
RPCResult::Type::NUM,
"vsize",
true,
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
348 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
349 {
RPCResult::Type::NUM,
"vsize_bip141",
true,
"Virtual transaction size as defined in BIP 141.\n"
350 "This is different from actual serialized size for witness transactions as witness data is discounted (only present when 'allowed' is true)."},
354 {
RPCResult::Type::STR_AMOUNT,
"effective-feerate",
false,
"the effective feerate in " +
CURRENCY_UNIT +
" per KvB. May differ from the base feerate if, for example, there are modified fees from prioritisetransaction or a package feerate was used."},
355 {
RPCResult::Type::ARR,
"effective-includes",
false,
"transactions whose fees and vsizes are included in effective-feerate.",
359 {
RPCResult::Type::STR,
"reject-reason",
true,
"Rejection reason (only present when 'allowed' is false)"},
360 {
RPCResult::Type::STR,
"reject-details",
true,
"Rejection details (only present when 'allowed' is false and rejection details exist)"},
365 "\nCreate a transaction\n"
366 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
367 "Sign the transaction, and get back the hex\n"
369 "\nTest acceptance of the transaction (signed hex)\n"
371 "\nAs a JSON-RPC call\n"
384 std::vector<CTransactionRef> txns;
385 txns.reserve(raw_transactions.
size());
386 for (
const auto& rawtx : raw_transactions.
getValues()) {
390 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
392 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
403 chainman.ProcessTransaction(txns[0],
true));
411 bool exit_early{
false};
412 for (
const auto& tx : txns) {
414 result_inner.
pushKV(
"txid", tx->GetHash().GetHex());
415 result_inner.
pushKV(
"wtxid", tx->GetWitnessHash().GetHex());
419 auto it = package_result.
m_tx_results.find(tx->GetWitnessHash());
420 if (exit_early || it == package_result.
m_tx_results.end()) {
422 rpc_result.
push_back(std::move(result_inner));
425 const auto& tx_result = it->second;
429 const CAmount fee = tx_result.m_base_fees.value();
431 const int64_t virtual_size = tx_result.m_vsize.value();
432 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.
GetFee(virtual_size);
433 if (max_raw_tx_fee &&
fee > max_raw_tx_fee) {
434 result_inner.
pushKV(
"allowed",
false);
435 result_inner.
pushKV(
"reject-reason",
"max-fee-exceeded");
440 result_inner.
pushKV(
"allowed",
true);
441 result_inner.
pushKV(
"vsize_adjusted", virtual_size);
442 result_inner.
pushKV(
"vsize", virtual_size);
446 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
448 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
449 effective_includes_res.
push_back(wtxid.ToString());
451 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
452 result_inner.
pushKV(
"fees", std::move(fees));
455 result_inner.
pushKV(
"allowed",
false);
458 result_inner.
pushKV(
"reject-reason",
"missing-inputs");
464 rpc_result.
push_back(std::move(result_inner));
491 std::vector<RPCResult> list = {
492 {
RPCResult::Type::NUM,
"vsize",
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
493 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
495 "This is different from actual serialized size for witness transactions as witness data is discounted."},
496 {
RPCResult::Type::NUM,
"vsize_adjusted",
"Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
504 RPCResult{
RPCResult::Type::NUM,
"chunkweight",
"sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop') of this transaction's chunk"},
518 RPCResult{
RPCResult::Type::BOOL,
"unbroadcast",
"Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
521 list.emplace_back(
RPCResult::Type::BOOL,
"bip125-replaceable",
"Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n");
530 chunk.
pushKV(
"chunkweight", chunk_feerate.
size);
532 for (
const auto& chunk_tx : chunk_txs) {
533 chunk_txids.
push_back(chunk_tx->GetTx().GetHash().ToString());
535 chunk.
pushKV(
"txs", std::move(chunk_txids));
543 for (
const auto& tx : cluster) {
544 total_weight += tx->GetAdjustedWeight();
546 info.pushKV(
"clusterweight", total_weight);
547 info.pushKV(
"txcount", cluster.size());
552 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
553 std::vector<const CTxMemPoolEntry *> current_chunk;
554 current_chunk.reserve(cluster.size());
557 for (
const auto& tx : cluster) {
558 if (current_chunk_feerate.
size == 0) {
561 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
562 current_chunk.clear();
563 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
565 current_chunk.push_back(tx);
566 current_chunk_feerate.
size -= tx->GetAdjustedWeight();
568 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
569 current_chunk.clear();
570 info.pushKV(
"chunks", std::move(all_chunks));
577 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
578 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
580 info.pushKV(
"vsize_adjusted", e.GetTxSize());
581 info.pushKV(
"vsize", e.GetTxSize());
583 info.pushKV(
"weight", e.GetTxWeight());
585 info.pushKV(
"height", e.GetHeight());
586 info.pushKV(
"descendantcount", descendant_count);
587 info.pushKV(
"descendantsize", descendant_size);
588 info.pushKV(
"ancestorcount", ancestor_count);
589 info.pushKV(
"ancestorsize", ancestor_size);
590 info.pushKV(
"wtxid", e.GetTx().GetWitnessHash().ToString());
591 auto feerate = pool.GetMainChunkFeerate(e);
592 info.pushKV(
"chunkweight", feerate.size);
600 info.pushKV(
"fees", std::move(fees));
603 std::set<std::string> setDepends;
611 for (
const std::string& dep : setDepends)
616 info.pushKV(
"depends", std::move(depends));
620 spent.
push_back(child.GetTx().GetHash().ToString());
623 info.pushKV(
"spentby", std::move(spent));
624 info.pushKV(
"unbroadcast", pool.IsUnbroadcastTx(tx.
GetHash()));
628 bool rbfStatus =
false;
635 info.pushKV(
"bip125-replaceable", rbfStatus);
642 if (include_mempool_sequence) {
653 o.
pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
658 uint64_t mempool_sequence;
662 a.
push_back(e.GetTx().GetHash().ToString());
666 if (!include_mempool_sequence) {
670 o.
pushKV(
"txids", std::move(a));
671 o.
pushKV(
"mempool_sequence", mempool_sequence);
679 return RPCMethod{
"getmempoolfeeratediagram",
680 "Returns the feerate diagram for the whole mempool.",
707 auto diagram =
mempool.GetFeerateDiagram();
709 for (
auto f : diagram) {
711 o.
pushKV(
"weight", f.size);
724 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
725 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
728 {
"mempool_sequence",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
741 RPCResult{
"for verbose = false and mempool_sequence = true",
757 bool fVerbose =
false;
758 if (!
request.params[0].isNull())
759 fVerbose =
request.params[0].get_bool();
761 bool include_mempool_sequence =
false;
762 if (!
request.params[1].isNull()) {
763 include_mempool_sequence =
request.params[1].get_bool();
774 "getmempoolancestors",
775 "If txid is in the mempool, returns all in-mempool ancestors.\n",
796 bool fVerbose =
false;
797 if (!
request.params[1].isNull())
798 fVerbose =
request.params[1].get_bool();
805 const auto entry{
mempool.GetEntry(txid)};
806 if (entry ==
nullptr) {
810 auto ancestors{
mempool.CalculateMemPoolAncestors(*entry)};
815 o.
push_back(ancestorIt->GetTx().GetHash().ToString());
835 "getmempooldescendants",
836 "If txid is in the mempool, returns all in-mempool descendants.\n",
857 bool fVerbose =
false;
858 if (!
request.params[1].isNull())
859 fVerbose =
request.params[1].get_bool();
866 const auto it{
mempool.GetIter(txid)};
872 mempool.CalculateDescendants(*it, setDescendants);
874 setDescendants.erase(*it);
879 o.
push_back(descendantIt->GetTx().GetHash().ToString());
900 "Returns mempool data for given cluster\n",
918 const auto entry{
mempool.GetEntry(txid)};
919 if (entry ==
nullptr) {
923 auto cluster =
mempool.GetCluster(txid);
936 "Returns mempool data for given transaction\n",
953 const auto entry{
mempool.GetEntry(txid)};
954 if (entry ==
nullptr) {
968 "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
982 {
"mempool_only",
RPCArg::Type::BOOL,
RPCArg::DefaultHint{
"true if txospenderindex unavailable, otherwise false"},
"If false and mempool lacks a relevant spend, use txospenderindex (throws an exception if not available)."},
994 {
RPCResult::Type::STR_HEX,
"spendingtxid",
true,
"the transaction id of the mempool transaction spending this output (omitted if unspent)"},
995 {
RPCResult::Type::STR_HEX,
"spendingtx",
true,
"the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
996 {
RPCResult::Type::STR_HEX,
"blockhash",
true,
"the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
1001 HelpExampleCli(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
1002 +
HelpExampleRpc(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
1003 +
HelpExampleCliNamed(
"gettxspendingprevout", {{
"outputs",
"[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"}, {
"return_spending_tx",
true}})
1008 if (output_params.
empty()) {
1019 const bool return_spending_tx{options.
exists(
"return_spending_tx") ? options[
"return_spending_tx"].
get_bool() :
false};
1024 size_t request_index;
1026 std::vector<Entry> prevouts_to_process;
1027 prevouts_to_process.
reserve(output_params.
size());
1028 for (
const size_t idx : std::views::iota(
size_t{0}, output_params.
size())) {
1042 prevouts_to_process.emplace_back(
COutPoint{txid,
static_cast<uint32_t
>(nOutput)}, idx);
1045 auto make_output = [&output_params, return_spending_tx](
const Entry& prevout,
const CTransaction* spending_tx =
nullptr) {
1046 UniValue o{output_params[prevout.request_index]};
1048 o.
pushKV(
"spendingtxid", spending_tx->GetHash().ToString());
1049 if (return_spending_tx) {
1056 std::vector<UniValue> results(output_params.
size());
1059 std::vector<Entry> unresolved;
1060 unresolved.reserve(prevouts_to_process.size());
1066 for (
const auto& prevout : prevouts_to_process) {
1067 const auto* spending_tx{mempool.
GetConflictTx(prevout.outpoint)};
1071 if (!spending_tx && !mempool_only) {
1072 unresolved.push_back(prevout);
1074 results[prevout.request_index] = make_output(prevout, spending_tx);
1084 for (
const auto& prevout : unresolved) {
1090 if (
const auto& spender_opt{spender.value()}) {
1091 UniValue o{make_output(prevout, spender_opt->tx.get())};
1092 o.
pushKV(
"blockhash", spender_opt->block_hash.GetHex());
1093 results[prevout.request_index] = std::move(o);
1096 results[prevout.request_index] = make_output(prevout);
1101 result.
reserve(results.size());
1102 for (
auto& output : results) result.
push_back(std::move(output));
1114 ret.pushKV(
"size", pool.
size());
1127 ret.pushKV(
"optimal", pool.m_txgraph->DoWork(0));
1129 ret.pushKV(
"fullrbf",
true);
1137 "Returns details on the active state of the TX memory pool.",
1142 std::vector<RPCResult> list = {
1143 {
RPCResult::Type::BOOL,
"loaded",
"True if the initial load attempt of the persisted mempool finished"},
1145 {
RPCResult::Type::NUM,
"bytes",
"Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted"},
1152 {
RPCResult::Type::NUM,
"unbroadcastcount",
"Current number of transactions that haven't passed initial broadcast yet"},
1153 {
RPCResult::Type::BOOL,
"permitbaremultisig",
"True if the mempool accepts transactions with bare multisig outputs"},
1154 {
RPCResult::Type::NUM,
"maxdatacarriersize",
"Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
1155 {
RPCResult::Type::NUM,
"limitclustercount",
"Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
1156 {
RPCResult::Type::NUM,
"limitclustersize",
"Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
1160 list.emplace_back(
RPCResult::Type::BOOL,
"fullrbf",
"True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)");
1180 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
1181 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
1190 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
1191 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1193 "Whether to apply the fee delta metadata from the mempool file.\n"
1194 "It will be added to any existing fee deltas.\n"
1195 "The fee delta can be set by the prioritisetransaction RPC.\n"
1196 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
1197 "Only set this bool if you understand what it does."},
1199 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
1200 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1217 const fs::path load_path{fs::u8path(self.
Arg<std::string_view>(
"filepath"))};
1218 const UniValue& use_current_time{
request.params[1][
"use_current_time"]};
1219 const UniValue& apply_fee_delta{
request.params[1][
"apply_fee_delta_priority"]};
1220 const UniValue& apply_unbroadcast{
request.params[1][
"apply_unbroadcast_set"]};
1222 .use_current_time = use_current_time.
isNull() ? true : use_current_time.
get_bool(),
1223 .apply_fee_delta_priority = apply_fee_delta.
isNull() ? false : apply_fee_delta.
get_bool(),
1224 .apply_unbroadcast_set = apply_unbroadcast.
isNull() ? false : apply_unbroadcast.
get_bool(),
1241 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
1268 ret.pushKV(
"filename", dump_path.utf8string());
1281 RPCResult{
RPCResult::Type::NUM,
"vsize",
"(DEPRECATED) use vsize_bip141 instead. The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1282 RPCResult{
RPCResult::Type::NUM,
"vsize_bip141",
"The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1294 o.
pushKV(
"txid", orphan.
tx->GetHash().ToString());
1295 o.
pushKV(
"wtxid", orphan.
tx->GetWitnessHash().ToString());
1296 o.
pushKV(
"bytes", orphan.
tx->ComputeTotalSize());
1299 o.
pushKV(
"weight", GetTransactionWeight(*orphan.
tx));
1301 for (
const auto fromPeer: orphan.
announcers) {
1312 "Shows transactions in the tx orphanage.\n"
1313 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1315 {
"verbosity",
RPCArg::Type::NUM,
RPCArg::Default{0},
"0 for an array of txids (may contain duplicates), 1 for an array of objects with tx details, and 2 for details from (1) and tx hex",
1354 if (verbosity == 0) {
1355 for (
auto const& orphan : orphanage) {
1356 ret.push_back(orphan.tx->GetHash().ToString());
1358 }
else if (verbosity == 1) {
1359 for (
auto const& orphan : orphanage) {
1362 }
else if (verbosity == 2) {
1363 for (
auto const& orphan : orphanage) {
1380 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1381 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1382 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1383 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1387 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1388 "None of the parents may depend on each other. Parents that are already in mempool do not need to be present in the package.\n"
1389 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1395 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
1396 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1398 "Reject transactions with provably unspendable outputs (e.g. 'datacarrier' outputs that use the OP_RETURN opcode) greater than the specified value, expressed in " +
CURRENCY_UNIT +
".\n"
1399 "If burning funds through unspendable outputs is desired, increase this value.\n"
1400 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1406 {
RPCResult::Type::STR,
"package_msg",
"The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1407 {
RPCResult::Type::OBJ_DYN,
"tx-results",
"The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1411 {
RPCResult::Type::STR_HEX,
"other-wtxid",
true,
"The wtxid of a different transaction with the same txid but different witness found in the mempool. This means the submitted transaction was ignored."},
1412 {
RPCResult::Type::NUM,
"vsize_adjusted",
true,
"Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
1413 {
RPCResult::Type::NUM,
"vsize",
true,
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
1414 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
1415 {
RPCResult::Type::NUM,
"vsize_bip141",
true,
"Virtual transaction size as defined in BIP 141."},
1418 {
RPCResult::Type::STR_AMOUNT,
"effective-feerate",
true,
"if the transaction was not already in the mempool, the effective feerate in " +
CURRENCY_UNIT +
" per KvB. For example, the package feerate and/or feerate with modified fees from prioritisetransaction."},
1419 {
RPCResult::Type::ARR,
"effective-includes",
true,
"if effective-feerate is provided, the wtxids of the transactions whose fees and vsizes are included in effective-feerate.",
1423 {
RPCResult::Type::STR,
"error",
true,
"Error string if rejected from mempool, or \"package-not-validated\" when the package aborts before any per-tx processing."},
1426 {
RPCResult::Type::ARR,
"replaced-transactions",
true,
"List of txids of replaced transactions",
1433 HelpExampleRpc(
"submitpackage", R
"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1434 HelpExampleCli("submitpackage", R
"('["raw-tx-without-unconfirmed-parents"]')")
1446 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1448 if (max_raw_tx_fee_rate ==
CFeeRate(0)) {
1449 client_maxfeerate = std::nullopt;
1455 std::vector<CTransactionRef> txns;
1456 txns.reserve(raw_transactions.
size());
1457 for (
const auto& rawtx : raw_transactions.
getValues()) {
1461 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
1464 for (
const auto& out : mtx.
vout) {
1465 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
1470 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
1474 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE,
"package topology disallowed. not child-with-parents or parents depend on each other.");
1482 std::string package_msg =
"success";
1485 switch(package_result.m_state.GetResult()) {
1489 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1490 for (
const auto& tx : txns) {
1499 package_result.m_state.GetRejectReason());
1505 package_msg = package_result.m_state.ToString();
1506 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1507 package_result.m_tx_results.empty());
1512 size_t num_broadcast{0};
1513 for (
const auto& tx : txns) {
1515 if (!mempool.
exists(tx->GetHash())) {
1520 std::string err_string;
1521 const auto err = BroadcastTransaction(
node,
1527 if (err != TransactionError::OK) {
1529 strprintf(
"transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1530 err_string, num_broadcast));
1536 rpc_result.
pushKV(
"package_msg", package_msg);
1538 std::set<Txid> replaced_txids;
1539 for (
const auto& tx : txns) {
1541 result_inner.
pushKV(
"txid", tx->GetHash().GetHex());
1542 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1543 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1544 if (it == package_result.m_tx_results.end()) {
1549 result_inner.
pushKV(
"error",
"package-not-validated");
1550 tx_result_map.
pushKV(wtxid_hex, std::move(result_inner));
1553 const auto& tx_result = it->second;
1554 switch(it->second.m_result_type) {
1556 result_inner.
pushKV(
"other-wtxid", it->second.m_other_wtxid.value().GetHex());
1559 result_inner.
pushKV(
"error", it->second.m_state.ToString());
1563 result_inner.
pushKV(
"vsize_adjusted", it->second.m_vsize.value());
1564 result_inner.
pushKV(
"vsize", it->second.m_vsize.value());
1572 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1574 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1575 effective_includes_res.
push_back(wtxid.ToString());
1577 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
1579 result_inner.
pushKV(
"fees", std::move(fees));
1580 for (
const auto& ptx : it->second.m_replaced_transactions) {
1581 replaced_txids.insert(ptx->GetHash());
1585 tx_result_map.
pushKV(wtxid_hex, std::move(result_inner));
1587 rpc_result.
pushKV(
"tx-results", std::move(tx_result_map));
1589 for (
const auto& txid : replaced_txids) replaced_list.
push_back(txid.ToString());
1590 rpc_result.
pushKV(
"replaced-transactions", std::move(replaced_list));
1616 for (
const auto& c : commands) {
1617 t.appendCommand(c.name, &c);
int64_t CAmount
Amount in satoshis (Can be negative).
std::string ToString(const T &t)
Locale-independent version of std::to_string.
#define CHECK_NONFATAL(condition)
Identity function.
bool GetBoolArg(const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return boolean argument or default value.
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
CFeeRate()=default
Fee rate of 0 satoshis per 0 vB.
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
CAmount GetFee(int32_t virtual_bytes) const
Return the fee in satoshis for the given vsize in vbytes.
An outpoint - a combination of a transaction hash and an index n into its vout.
The basic transaction that is broadcasted on the network and contained in blocks.
const Txid & GetHash() const LIFETIMEBOUND
const std::vector< CTxIn > vin
An input of a transaction.
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
const CTransaction & GetTx() const
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
bool GetLoadTried() const
CFeeRate GetMinFee(size_t sizelimit) const
size_t DynamicMemoryUsage() const
bool exists(const Txid &txid) const
std::set< txiter, CompareIteratorByHash > setEntries
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
const CTransaction * GetConflictTx(const COutPoint &prevout) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Get the transaction in the pool that spends the same prevout.
std::set< Txid > GetUnbroadcastTxs() const
Returns transactions in unbroadcast set.
unsigned long size() const
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
CAmount GetTotalFee() const EXCLUSIVE_LOCKS_REQUIRED(cs)
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
bool IsInitialBlockDownload() const noexcept
Check whether we are doing an initial block download (synchronizing from disk or network).
Chainstate & ActiveChainstate() const
virtual std::vector< node::TxOrphanage::OrphanInfo > GetOrphanTransactions()=0
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
void push_back(UniValue val)
const UniValue & find_value(std::string_view key) const
const UniValue & get_obj() const
const std::vector< UniValue > & getValues() const
void pushKVEnd(std::string key, UniValue val)
bool exists(const std::string &key) const
void reserve(size_t new_cap)
void pushKV(std::string key, UniValue val)
std::string GetRejectReason() const
std::string ToString() const
std::string ToString() const
static transaction_identifier FromUint256(const uint256 &id)
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
std::string EncodeHexTx(const CTransaction &tx)
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness, bool try_witness)
UniValue ValueFromAmount(const CAmount amount)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
FeePerUnit< WeightTag > FeePerWeight
const std::string CURRENCY_UNIT
const std::string request
fs::path MempoolPath(const ArgsManager &argsman)
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, fsbridge::FopenFn mockable_fopen_function=fsbridge::fopen, bool skip_file_commit=false)
Dump the mempool to a file.
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
@ MEMPOOL_AND_BROADCAST_TO_ALL
Add the transaction to the mempool and broadcast to all peers for which tx relay is enabled.
@ NO_MEMPOOL_PRIVATE_BROADCAST
Omit the mempool and directly send the transaction via a few dedicated connections to peers on privac...
constexpr CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls.
fs::path MempoolPath(const ArgsManager &argsman)
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
Dump the mempool to a file.
TransactionError BroadcastTransaction(NodeContext &node, const CTransactionRef tx, std::string &err_string, const CAmount &max_tx_fee, TxBroadcast broadcast_method, bool wait_callback)
Submit a transaction to the mempool and (optionally) relay it to all P2P peers.
constexpr CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
bool LoadMempool(CTxMemPool &pool, const fs::path &load_path, Chainstate &active_chainstate, ImportMempoolOptions &&opts)
Import the file and attempt to add its contents to the mempool.
std::string ToString(const T &t)
Locale-independent version of std::to_string.
constexpr bool DEFAULT_PRIVATE_BROADCAST
Default for -privatebroadcast.
@ NET_ONION
TOR (v2 or v3).
ReachableNets g_reachable_nets
bool IsChildWithParentsTree(const Package &package)
Context-free check that a package IsChildWithParents() and none of the parents depend on each other (...
constexpr uint32_t MAX_PACKAGE_COUNT
Default maximum number of transactions in a package.
@ PCKG_POLICY
The package itself is invalid (e.g. too many transactions).
@ PCKG_RESULT_UNSET
Initial value. The package has not yet been rejected.
@ PCKG_MEMPOOL_ERROR
Mempool logic error.
@ PCKG_TX
At least one tx is invalid.
RBFTransactionState IsRBFOptIn(const CTransaction &tx, const CTxMemPool &pool)
Determine whether an unconfirmed transaction is signaling opt-in to RBF according to BIP 125 This inv...
RBFTransactionState
The rbf state of unconfirmed transactions.
@ UNKNOWN
Unconfirmed tx that does not signal rbf and is not in the mempool.
@ REPLACEABLE_BIP125
Either this tx or a mempool ancestor signals rbf.
int64_t GetVirtualTransactionSize(int64_t nWeight, int64_t nSigOpCost, unsigned int bytes_per_sigop)
Compute the virtual transaction size (weight reinterpreted as bytes).
std::shared_ptr< const CTransaction > CTransactionRef
constexpr CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls.
UniValue JSONRPCError(int code, const std::string &message)
static RPCMethod savemempool()
static UniValue OrphanToJSON(const node::TxOrphanage::OrphanInfo &orphan)
static std::vector< RPCResult > ClusterDescription()
static std::vector< RPCResult > OrphanDescription()
static RPCMethod testmempoolaccept()
static RPCMethod sendrawtransaction()
static void entryToJSON(const CTxMemPool &pool, UniValue &info, const CTxMemPoolEntry &e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
static RPCMethod importmempool()
static RPCMethod submitpackage()
void RegisterMempoolRPCCommands(CRPCTable &t)
static void clusterToJSON(const CTxMemPool &pool, UniValue &info, std::vector< const CTxMemPoolEntry * > cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
UniValue MempoolInfoToJSON(const CTxMemPool &pool)
Mempool information to JSON.
static RPCMethod getmempoolcluster()
static RPCMethod getmempoolentry()
static std::vector< RPCResult > MempoolEntryDescription()
static RPCMethod getprivatebroadcastinfo()
static RPCMethod getmempoolancestors()
constexpr CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
void AppendChunkInfo(UniValue &all_chunks, FeePerWeight chunk_feerate, std::vector< const CTxMemPoolEntry * > chunk_txs)
static RPCMethod getorphantxs()
UniValue MempoolToJSON(const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
Mempool to JSON.
static RPCMethod getmempooldescendants()
static RPCMethod gettxspendingprevout()
static RPCMethod getrawmempool()
static RPCMethod abortprivatebroadcast()
static RPCMethod getmempoolfeeratediagram()
static RPCMethod getmempoolinfo()
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_CLIENT_IN_INITIAL_DOWNLOAD
Still downloading initial blocks.
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
CAmount AmountFromValue(const UniValue &value, int decimals)
Validate and return a CAmount from a UniValue number or string.
UniValue JSONRPCTransactionError(TransactionError terr, const std::string &err_string)
CFeeRate ParseFeeRate(const UniValue &json)
Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB).
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
uint256 ParseHashO(const UniValue &o, std::string_view strKey)
void RPCTypeCheckObj(const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull, bool fStrict)
std::string HelpExampleCliNamed(const std::string &methodname, const RPCArgList &args)
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
bool IsDeprecatedRPCEnabled(const std::string &method)
NodeContext & EnsureAnyNodeContext(const std::any &context)
CTxMemPool & EnsureMemPool(const NodeContext &node)
PeerManager & EnsurePeerman(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
CTxMemPool & EnsureAnyMemPool(const std::any &context)
ArgsManager & EnsureAnyArgsman(const std::any &context)
A mutable version of CTransaction.
std::vector< CTxOut > vout
Validation result for package mempool acceptance.
PackageValidationState m_state
PackageMempoolAcceptResult(PackageValidationState state, std::map< Wtxid, MempoolAcceptResult > &&results)
std::map< Wtxid, MempoolAcceptResult > m_tx_results
Map from wtxid to finished MempoolAcceptResults.
@ 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:
UniValue Default
Default constant value.
@ 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.
unsigned cluster_count
The maximum number of transactions in a cluster.
int64_t cluster_size_vbytes
The maximum allowed size in virtual bytes of a cluster.
std::optional< unsigned > max_datacarrier_bytes
A data carrying output is an unspendable output containing data.
CFeeRate incremental_relay_feerate
bool permit_bare_multisig
CFeeRate min_relay_feerate
A fee rate smaller than this is considered zero fee (for relaying, mining and transaction creation).
std::unique_ptr< CTxMemPool > mempool
std::unique_ptr< ChainstateManager > chainman
std::unique_ptr< PeerManager > peerman
Allows providing orphan information externally.
std::set< NodeId > announcers
Peers added with AddTx or AddAnnouncer.
#define AssertLockNotHeld(cs)
#define WITH_LOCK(cs, code)
#define AssertLockHeld(cs)
#define EXCLUSIVE_LOCKS_REQUIRED(...)
transaction_identifier< false > Txid
Txid commits to all transaction fields except the witness.
std::unique_ptr< TxoSpenderIndex > g_txospenderindex
The global txo spender index. May be null.
constexpr auto TicksSinceEpoch(Timepoint t)
constexpr int64_t count_seconds(std::chrono::seconds t)
PackageMempoolAcceptResult ProcessNewPackage(Chainstate &active_chainstate, CTxMemPool &pool, const Package &package, bool test_accept, const std::optional< CFeeRate > &client_maxfeerate)
Validate (and maybe submit) a package to the mempool.
V Cat(V v1, V &&v2)
Concatenate two vectors, moving elements.