10#include <chainparams.h>
52 "Submit a raw transaction (serialized, hex-encoded) to the network.\n"
54 "\nIf -privatebroadcast is disabled, then the transaction will be put into the\n"
55 "local mempool of the node and will be sent unconditionally to all currently\n"
56 "connected peers, so using sendrawtransaction for manual rebroadcast will degrade\n"
57 "privacy by leaking the transaction's origin, as nodes will normally not\n"
58 "rebroadcast non-wallet transactions already in their mempool.\n"
60 "\nIf -privatebroadcast is enabled, then the transaction will be sent only via\n"
61 "dedicated, short-lived connections to Tor or I2P peers or IPv4/IPv6 peers\n"
62 "via the Tor network. This conceals the transaction's origin. The transaction\n"
63 "will only enter the local mempool when it is received back from the network.\n"
64 "The private broadcast queue is bounded: when it is full, this RPC fails and\n"
65 "the transaction is not scheduled, until an existing one completes or is\n"
66 "aborted. Use getprivatebroadcastinfo to inspect the queue and abortprivatebroadcast to abort.\n"
68 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
70 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
74 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
75 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
77 "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"
78 "If burning funds through unspendable outputs is desired, increase this value.\n"
79 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
85 "\nCreate a transaction\n"
86 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
87 "Sign the transaction, and get back the hex\n"
89 "\nSend the transaction (signed hex)\n"
91 "\nAs a JSON-RPC call\n"
99 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
103 for (
const auto&
out : mtx.
vout) {
104 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
114 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
116 std::string err_string;
120 if (private_broadcast_enabled &&
124 "-privatebroadcast is enabled, but none of the Tor or I2P networks is "
125 "reachable. Maybe the location of the Tor proxy couldn't be retrieved "
126 "from the Tor daemon at startup. Check whether the Tor daemon is running "
127 "and that -torcontrol, -torpassword and -i2psam are configured properly.");
137 if (TransactionError::OK != err) {
141 return tx->GetHash().GetHex();
149 "getprivatebroadcastinfo",
150 "Returns information about transactions tracked for private broadcast.\n"
151 "Transactions that have reached the send-attempt limit remain in the result with attempts_remaining=0.\n"
152 "This method is only available when running with -privatebroadcast enabled.\n",
164 {
RPCResult::Type::NUM_TIME,
"time_added",
"The time this transaction was added to the private broadcast queue (seconds since epoch)"},
165 {
RPCResult::Type::NUM,
"attempts_remaining",
"The number of additional private broadcast send attempts allowed for this transaction"},
166 {
RPCResult::Type::ARR,
"peers",
"Per-peer send and acknowledgment information for this transaction",
171 {
RPCResult::Type::NUM_TIME,
"sent",
"The time this transaction was picked for sending to this peer via private broadcast (seconds since epoch)"},
172 {
RPCResult::Type::NUM_TIME,
"received",
true,
"The time this peer acknowledged reception of the transaction (seconds since epoch)"},
186 if (!peerman.GetInfo().private_broadcast) {
190 const auto txs{peerman.GetPrivateBroadcastInfo()};
193 for (
const auto& tx_info : txs) {
195 o.
pushKV(
"txid", tx_info.tx->GetHash().ToString());
196 o.
pushKV(
"wtxid", tx_info.tx->GetWitnessHash().ToString());
198 o.
pushKV(
"time_added", TicksSinceEpoch<std::chrono::seconds>(tx_info.time_added));
199 o.
pushKV(
"attempts_remaining", tx_info.attempts_remaining);
201 for (
const auto& peer : tx_info.peers) {
203 p.
pushKV(
"address", peer.address.ToStringAddrPort());
204 p.
pushKV(
"sent", TicksSinceEpoch<std::chrono::seconds>(peer.sent));
205 if (peer.received.has_value()) {
206 p.
pushKV(
"received", TicksSinceEpoch<std::chrono::seconds>(*peer.received));
210 o.
pushKV(
"peers", std::move(peers));
215 ret.pushKV(
"transactions", std::move(transactions));
224 "abortprivatebroadcast",
225 "Abort private broadcast attempts for a transaction currently being privately broadcast.\n"
226 "The transaction will be removed from the private broadcast queue.\n"
227 "This method is only available when running with -privatebroadcast enabled.\n",
230 "If the provided id matches a txid that corresponds to multiple transactions with different wtxids, multiple transactions will be removed and returned."},
235 {
RPCResult::Type::ARR,
"removed_transactions",
"Transactions removed from the private broadcast queue",
255 if (!peerman.GetInfo().private_broadcast) {
261 const auto removed_txs{peerman.AbortPrivateBroadcast(
id)};
262 if (removed_txs.empty()) {
267 for (
const auto& tx : removed_txs) {
269 o.
pushKV(
"txid", tx->GetHash().ToString());
270 o.
pushKV(
"wtxid", tx->GetWitnessHash().ToString());
272 removed_transactions.
push_back(std::move(o));
275 ret.pushKV(
"removed_transactions", std::move(removed_transactions));
285 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
286 "\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"
287 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
289 "\nThis checks if transactions violate the consensus or policy rules.\n"
290 "\nSee sendrawtransaction call.\n",
298 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
299 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
302 RPCResult::Type::ARR,
"",
"The result of the mempool acceptance test for each raw transaction in the input array.\n"
303 "Returns results for each transaction in the same order they were passed in.\n"
304 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
310 {
RPCResult::Type::STR,
"package-error",
true,
"Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
311 {
RPCResult::Type::BOOL,
"allowed",
true,
"Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
312 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
313 {
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)."},
314 {
RPCResult::Type::NUM,
"vsize",
true,
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
315 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
316 {
RPCResult::Type::NUM,
"vsize_bip141",
true,
"Virtual transaction size as defined in BIP 141.\n"
317 "This is different from actual serialized size for witness transactions as witness data is discounted (only present when 'allowed' is true)."},
321 {
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."},
322 {
RPCResult::Type::ARR,
"effective-includes",
false,
"transactions whose fees and vsizes are included in effective-feerate.",
326 {
RPCResult::Type::STR,
"reject-reason",
true,
"Rejection reason (only present when 'allowed' is false)"},
327 {
RPCResult::Type::STR,
"reject-details",
true,
"Rejection details (only present when 'allowed' is false and rejection details exist)"},
332 "\nCreate a transaction\n"
333 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
334 "Sign the transaction, and get back the hex\n"
336 "\nTest acceptance of the transaction (signed hex)\n"
338 "\nAs a JSON-RPC call\n"
351 std::vector<CTransactionRef> txns;
352 txns.reserve(raw_transactions.
size());
353 for (
const auto& rawtx : raw_transactions.
getValues()) {
357 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
368 if (txns.size() > 1)
return ProcessNewPackage(chainstate, mempool, txns,
true, {});
378 bool exit_early{
false};
379 for (
const auto& tx : txns) {
381 result_inner.
pushKV(
"txid", tx->GetHash().GetHex());
382 result_inner.
pushKV(
"wtxid", tx->GetWitnessHash().GetHex());
386 auto it = package_result.
m_tx_results.find(tx->GetWitnessHash());
387 if (exit_early || it == package_result.
m_tx_results.end()) {
389 rpc_result.
push_back(std::move(result_inner));
392 const auto& tx_result = it->second;
396 const CAmount fee = tx_result.m_base_fees.value();
398 const int64_t virtual_size = tx_result.m_vsize.value();
399 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
400 if (max_raw_tx_fee &&
fee > max_raw_tx_fee) {
401 result_inner.
pushKV(
"allowed",
false);
402 result_inner.
pushKV(
"reject-reason",
"max-fee-exceeded");
407 result_inner.
pushKV(
"allowed",
true);
408 result_inner.
pushKV(
"vsize_adjusted", virtual_size);
409 result_inner.
pushKV(
"vsize", virtual_size);
413 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
415 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
416 effective_includes_res.
push_back(wtxid.ToString());
418 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
419 result_inner.
pushKV(
"fees", std::move(fees));
422 result_inner.
pushKV(
"allowed",
false);
425 result_inner.
pushKV(
"reject-reason",
"missing-inputs");
431 rpc_result.
push_back(std::move(result_inner));
458 std::vector<RPCResult> list = {
459 {
RPCResult::Type::NUM,
"vsize",
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
460 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
462 "This is different from actual serialized size for witness transactions as witness data is discounted."},
463 {
RPCResult::Type::NUM,
"vsize_adjusted",
"Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
471 RPCResult{
RPCResult::Type::NUM,
"chunkweight",
"sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop') of this transaction's chunk"},
485 RPCResult{
RPCResult::Type::BOOL,
"unbroadcast",
"Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
488 list.emplace_back(
RPCResult::Type::BOOL,
"bip125-replaceable",
"Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n");
497 chunk.
pushKV(
"chunkweight", chunk_feerate.
size);
499 for (
const auto& chunk_tx : chunk_txs) {
500 chunk_txids.
push_back(chunk_tx->GetTx().GetHash().ToString());
502 chunk.
pushKV(
"txs", std::move(chunk_txids));
510 for (
const auto& tx : cluster) {
511 total_weight += tx->GetAdjustedWeight();
513 info.pushKV(
"clusterweight", total_weight);
514 info.pushKV(
"txcount", cluster.size());
519 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
520 std::vector<const CTxMemPoolEntry *> current_chunk;
521 current_chunk.reserve(cluster.size());
524 for (
const auto& tx : cluster) {
525 if (current_chunk_feerate.
size == 0) {
528 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
529 current_chunk.clear();
530 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
532 current_chunk.push_back(tx);
533 current_chunk_feerate.
size -= tx->GetAdjustedWeight();
535 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
536 current_chunk.clear();
537 info.pushKV(
"chunks", std::move(all_chunks));
544 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
545 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
547 info.pushKV(
"vsize_adjusted", e.GetTxSize());
548 info.pushKV(
"vsize", e.GetTxSize());
550 info.pushKV(
"weight", e.GetTxWeight());
552 info.pushKV(
"height", e.GetHeight());
553 info.pushKV(
"descendantcount", descendant_count);
554 info.pushKV(
"descendantsize", descendant_size);
555 info.pushKV(
"ancestorcount", ancestor_count);
556 info.pushKV(
"ancestorsize", ancestor_size);
557 info.pushKV(
"wtxid", e.GetTx().GetWitnessHash().ToString());
558 auto feerate = pool.GetMainChunkFeerate(e);
559 info.pushKV(
"chunkweight", feerate.size);
567 info.pushKV(
"fees", std::move(fees));
570 std::set<std::string> setDepends;
578 for (
const std::string& dep : setDepends)
583 info.pushKV(
"depends", std::move(depends));
587 spent.
push_back(child.GetTx().GetHash().ToString());
590 info.pushKV(
"spentby", std::move(spent));
591 info.pushKV(
"unbroadcast", pool.IsUnbroadcastTx(tx.
GetHash()));
595 bool rbfStatus =
false;
602 info.pushKV(
"bip125-replaceable", rbfStatus);
609 if (include_mempool_sequence) {
620 o.
pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
625 uint64_t mempool_sequence;
629 a.
push_back(e.GetTx().GetHash().ToString());
633 if (!include_mempool_sequence) {
637 o.
pushKV(
"txids", std::move(a));
638 o.
pushKV(
"mempool_sequence", mempool_sequence);
646 return RPCMethod{
"getmempoolfeeratediagram",
647 "Returns the feerate diagram for the whole mempool.",
676 for (
auto f : diagram) {
678 o.
pushKV(
"weight", f.size);
691 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
692 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
695 {
"mempool_sequence",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
708 RPCResult{
"for verbose = false and mempool_sequence = true",
724 bool fVerbose =
false;
725 if (!request.params[0].isNull())
726 fVerbose = request.params[0].
get_bool();
728 bool include_mempool_sequence =
false;
729 if (!request.params[1].isNull()) {
730 include_mempool_sequence = request.params[1].get_bool();
741 "getmempoolancestors",
742 "If txid is in the mempool, returns all in-mempool ancestors.\n",
763 bool fVerbose =
false;
764 if (!request.params[1].isNull())
765 fVerbose = request.params[1].
get_bool();
772 const auto entry{mempool.
GetEntry(txid)};
773 if (entry ==
nullptr) {
782 o.
push_back(ancestorIt->GetTx().GetHash().ToString());
802 "getmempooldescendants",
803 "If txid is in the mempool, returns all in-mempool descendants.\n",
824 bool fVerbose =
false;
825 if (!request.params[1].isNull())
826 fVerbose = request.params[1].
get_bool();
833 const auto it{mempool.
GetIter(txid)};
841 setDescendants.erase(*it);
846 o.
push_back(descendantIt->GetTx().GetHash().ToString());
867 "Returns mempool data for given cluster\n",
885 const auto entry{mempool.
GetEntry(txid)};
886 if (entry ==
nullptr) {
903 "Returns mempool data for given transaction\n",
920 const auto entry{mempool.
GetEntry(txid)};
921 if (entry ==
nullptr) {
935 "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
949 {
"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)."},
961 {
RPCResult::Type::STR_HEX,
"spendingtxid",
true,
"the transaction id of the mempool transaction spending this output (omitted if unspent)"},
962 {
RPCResult::Type::STR_HEX,
"spendingtx",
true,
"the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
963 {
RPCResult::Type::STR_HEX,
"blockhash",
true,
"the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
968 HelpExampleCli(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
969 +
HelpExampleRpc(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
970 +
HelpExampleCliNamed(
"gettxspendingprevout", {{
"outputs",
"[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"}, {
"return_spending_tx",
true}})
975 if (output_params.
empty()) {
985 const bool mempool_only{options.exists(
"mempool_only") ? options[
"mempool_only"].get_bool() : !
g_txospenderindex};
986 const bool return_spending_tx{options.exists(
"return_spending_tx") ? options[
"return_spending_tx"].get_bool() :
false};
991 size_t request_index;
993 std::vector<Entry> prevouts_to_process;
994 prevouts_to_process.reserve(output_params.
size());
995 for (
const size_t idx : std::views::iota(
size_t{0}, output_params.
size())) {
1009 prevouts_to_process.emplace_back(
COutPoint{txid,
static_cast<uint32_t
>(nOutput)}, idx);
1012 auto make_output = [&output_params, return_spending_tx](
const Entry& prevout,
const CTransaction* spending_tx =
nullptr) {
1013 UniValue o{output_params[prevout.request_index]};
1015 o.
pushKV(
"spendingtxid", spending_tx->GetHash().ToString());
1016 if (return_spending_tx) {
1017 o.pushKV(
"spendingtx",
EncodeHexTx(*spending_tx));
1023 std::vector<UniValue> results(output_params.
size());
1026 std::vector<Entry> unresolved;
1027 unresolved.reserve(prevouts_to_process.size());
1033 for (
const auto& prevout : prevouts_to_process) {
1034 const auto* spending_tx{mempool.
GetConflictTx(prevout.outpoint)};
1038 if (!spending_tx && !mempool_only) {
1039 unresolved.push_back(prevout);
1041 results[prevout.request_index] = make_output(prevout, spending_tx);
1051 for (
const auto& prevout : unresolved) {
1057 if (
const auto& spender_opt{spender.value()}) {
1058 UniValue o{make_output(prevout, spender_opt->tx.get())};
1059 o.
pushKV(
"blockhash", spender_opt->block_hash.GetHex());
1060 results[prevout.request_index] = std::move(o);
1063 results[prevout.request_index] = make_output(prevout);
1068 result.reserve(results.size());
1069 for (
auto& output : results) result.push_back(std::move(output));
1081 ret.pushKV(
"size", pool.
size());
1094 ret.pushKV(
"optimal", pool.m_txgraph->DoWork(0));
1096 ret.pushKV(
"fullrbf",
true);
1104 "Returns details on the active state of the TX memory pool.",
1109 std::vector<RPCResult> list = {
1110 {
RPCResult::Type::BOOL,
"loaded",
"True if the initial load attempt of the persisted mempool finished"},
1112 {
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"},
1119 {
RPCResult::Type::NUM,
"unbroadcastcount",
"Current number of transactions that haven't passed initial broadcast yet"},
1120 {
RPCResult::Type::BOOL,
"permitbaremultisig",
"True if the mempool accepts transactions with bare multisig outputs"},
1121 {
RPCResult::Type::NUM,
"maxdatacarriersize",
"Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
1122 {
RPCResult::Type::NUM,
"limitclustercount",
"Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
1123 {
RPCResult::Type::NUM,
"limitclustersize",
"Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
1127 list.emplace_back(
RPCResult::Type::BOOL,
"fullrbf",
"True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)");
1147 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
1148 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
1157 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
1158 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1160 "Whether to apply the fee delta metadata from the mempool file.\n"
1161 "It will be added to any existing fee deltas.\n"
1162 "The fee delta can be set by the prioritisetransaction RPC.\n"
1163 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
1164 "Only set this bool if you understand what it does."},
1166 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
1167 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1184 const fs::path load_path{
fs::u8path(self.
Arg<std::string_view>(
"filepath"))};
1185 const UniValue& use_current_time{request.params[1][
"use_current_time"]};
1186 const UniValue& apply_fee_delta{request.params[1][
"apply_fee_delta_priority"]};
1187 const UniValue& apply_unbroadcast{request.params[1][
"apply_unbroadcast_set"]};
1189 .
use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
1190 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
1191 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
1208 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
1235 ret.pushKV(
"filename", dump_path.utf8string());
1248 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."},
1249 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."},
1261 o.
pushKV(
"txid", orphan.
tx->GetHash().ToString());
1262 o.
pushKV(
"wtxid", orphan.
tx->GetWitnessHash().ToString());
1263 o.
pushKV(
"bytes", orphan.
tx->ComputeTotalSize());
1268 for (
const auto fromPeer: orphan.
announcers) {
1279 "Shows transactions in the tx orphanage.\n"
1280 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1282 {
"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",
1300 Cat<std::vector<RPCResult>>(
1321 if (verbosity == 0) {
1322 for (
auto const& orphan : orphanage) {
1323 ret.push_back(orphan.tx->GetHash().ToString());
1325 }
else if (verbosity == 1) {
1326 for (
auto const& orphan : orphanage) {
1329 }
else if (verbosity == 2) {
1330 for (
auto const& orphan : orphanage) {
1347 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1348 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1349 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1350 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1354 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1355 "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"
1356 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1362 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
1363 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1365 "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"
1366 "If burning funds through unspendable outputs is desired, increase this value.\n"
1367 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1373 {
RPCResult::Type::STR,
"package_msg",
"The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1374 {
RPCResult::Type::OBJ_DYN,
"tx-results",
"The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1378 {
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."},
1379 {
RPCResult::Type::NUM,
"vsize_adjusted",
true,
"Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
1380 {
RPCResult::Type::NUM,
"vsize",
true,
"(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
1381 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
1382 {
RPCResult::Type::NUM,
"vsize_bip141",
true,
"Virtual transaction size as defined in BIP 141."},
1385 {
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."},
1386 {
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.",
1390 {
RPCResult::Type::STR,
"error",
true,
"Error string if rejected from mempool, or \"package-not-validated\" when the package aborts before any per-tx processing."},
1393 {
RPCResult::Type::ARR,
"replaced-transactions",
true,
"List of txids of replaced transactions",
1400 HelpExampleRpc(
"submitpackage", R
"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1401 HelpExampleCli("submitpackage", R
"('["raw-tx-without-unconfirmed-parents"]')")
1413 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1415 if (max_raw_tx_fee_rate ==
CFeeRate(0)) {
1416 client_maxfeerate = std::nullopt;
1422 std::vector<CTransactionRef> txns;
1423 txns.reserve(raw_transactions.
size());
1424 for (
const auto& rawtx : raw_transactions.
getValues()) {
1428 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
1431 for (
const auto&
out : mtx.
vout) {
1432 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
1441 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE,
"package topology disallowed. not child-with-parents or parents depend on each other.");
1449 std::string package_msg =
"success";
1452 switch(package_result.m_state.GetResult()) {
1456 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1457 for (
const auto& tx : txns) {
1466 package_result.m_state.GetRejectReason());
1472 package_msg = package_result.m_state.ToString();
1473 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1474 package_result.m_tx_results.empty());
1479 size_t num_broadcast{0};
1480 for (
const auto& tx : txns) {
1482 if (!mempool.
exists(tx->GetHash())) {
1487 std::string err_string;
1494 if (err != TransactionError::OK) {
1496 strprintf(
"transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1497 err_string, num_broadcast));
1503 rpc_result.pushKV(
"package_msg", package_msg);
1505 std::set<Txid> replaced_txids;
1506 for (
const auto& tx : txns) {
1508 result_inner.pushKV(
"txid", tx->GetHash().GetHex());
1509 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1510 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1511 if (it == package_result.m_tx_results.end()) {
1516 result_inner.pushKV(
"error",
"package-not-validated");
1517 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1520 const auto& tx_result = it->second;
1521 switch(it->second.m_result_type) {
1523 result_inner.pushKV(
"other-wtxid", it->second.m_other_wtxid.value().GetHex());
1526 result_inner.pushKV(
"error", it->second.m_state.ToString());
1530 result_inner.pushKV(
"vsize_adjusted", it->second.m_vsize.value());
1531 result_inner.pushKV(
"vsize", it->second.m_vsize.value());
1539 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1541 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1542 effective_includes_res.
push_back(wtxid.ToString());
1544 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
1546 result_inner.pushKV(
"fees", std::move(fees));
1547 for (
const auto& ptx : it->second.m_replaced_transactions) {
1548 replaced_txids.insert(ptx->GetHash());
1552 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1554 rpc_result.pushKV(
"tx-results", std::move(tx_result_map));
1556 for (
const auto& txid : replaced_txids) replaced_list.
push_back(txid.ToString());
1557 rpc_result.pushKV(
"replaced-transactions", std::move(replaced_list));
1583 for (
const auto& c : commands) {
1584 t.appendCommand(c.name, &c);
int64_t CAmount
Amount in satoshis (Can be negative)
static CAmount AmountFromValue(const UniValue &value)
#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.
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 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 ...
std::vector< const CTxMemPoolEntry * > GetCluster(Txid txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
std::optional< txiter > GetIter(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Returns an iterator to the given hash, if found.
bool GetLoadTried() const
CFeeRate GetMinFee(size_t sizelimit) const
size_t DynamicMemoryUsage() const
std::vector< FeePerWeight > GetFeerateDiagram() const EXCLUSIVE_LOCKS_REQUIRED(cs)
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.
void CalculateDescendants(txiter it, setEntries &setDescendants) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Populate setDescendants with all in-mempool descendants of given transaction.
unsigned long size() const
setEntries CalculateMemPoolAncestors(const CTxMemPoolEntry &entry) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Calculate all in-mempool ancestors of entry (not including the tx itself)
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
CAmount GetTotalFee() const EXCLUSIVE_LOCKS_REQUIRED(cs)
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
const CTxMemPoolEntry * GetEntry(const Txid &txid) const LIFETIMEBOUND 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)
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
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)
const UniValue & get_array() const
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)
static int32_t GetTransactionWeight(const CTransaction &tx)
@ 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.
const std::string CURRENCY_UNIT
static path u8path(std::string_view utf8_str)
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)
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.
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
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
is a home for public enum and struct type definitions that are used internally by node code,...
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).
static CTransactionRef MakeTransactionRef(Tx &&txIn)
std::shared_ptr< const CTransaction > CTransactionRef
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()
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)
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
Tagged wrapper around FeeFrac to avoid unit confusion.
@ DIFFERENT_WITNESS
Valid, transaction was already in the mempool.
@ INVALID
Fully validated, valid.
Validation result for package mempool acceptance.
PackageValidationState m_state
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)
@ OBJ_NAMED_PARAMS
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
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:
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
@ 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.
Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type.
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)
NodeContext struct containing references to chain state and connection state.
Allows providing orphan information externally.
std::set< NodeId > announcers
Peers added with AddTx or AddAnnouncer.
#define AssertLockNotHeld(cs)
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
std::unique_ptr< TxoSpenderIndex > g_txospenderindex
The global txo spender index. May be null.
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.