10#include <chainparams.h>
51 "Submit a raw transaction (serialized, hex-encoded) to the network.\n"
53 "\nIf -privatebroadcast is disabled, then the transaction will be put into the\n"
54 "local mempool of the node and will be sent unconditionally to all currently\n"
55 "connected peers, so using sendrawtransaction for manual rebroadcast will degrade\n"
56 "privacy by leaking the transaction's origin, as nodes will normally not\n"
57 "rebroadcast non-wallet transactions already in their mempool.\n"
59 "\nIf -privatebroadcast is enabled, then the transaction will be sent only via\n"
60 "dedicated, short-lived connections to Tor or I2P peers or IPv4/IPv6 peers\n"
61 "via the Tor network. This conceals the transaction's origin. The transaction\n"
62 "will only enter the local mempool when it is received back from the network.\n"
64 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
66 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
70 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
71 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
73 "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"
74 "If burning funds through unspendable outputs is desired, increase this value.\n"
75 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
81 "\nCreate a transaction\n"
82 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
83 "Sign the transaction, and get back the hex\n"
85 "\nSend the transaction (signed hex)\n"
87 "\nAs a JSON-RPC call\n"
95 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
99 for (
const auto&
out : mtx.
vout) {
100 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
110 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
112 std::string err_string;
116 if (private_broadcast_enabled &&
120 "-privatebroadcast is enabled, but none of the Tor or I2P networks is "
121 "reachable. Maybe the location of the Tor proxy couldn't be retrieved "
122 "from the Tor daemon at startup. Check whether the Tor daemon is running "
123 "and that -torcontrol, -torpassword and -i2psam are configured properly.");
133 if (TransactionError::OK != err) {
137 return tx->GetHash().GetHex();
145 "getprivatebroadcastinfo",
146 "Returns information about transactions that are currently being privately broadcast.\n",
158 {
RPCResult::Type::NUM_TIME,
"time_added",
"The time this transaction was added to the private broadcast queue (seconds since epoch)"},
159 {
RPCResult::Type::ARR,
"peers",
"Per-peer send and acknowledgment information for this transaction",
164 {
RPCResult::Type::NUM_TIME,
"sent",
"The time this transaction was picked for sending to this peer via private broadcast (seconds since epoch)"},
165 {
RPCResult::Type::NUM_TIME,
"received",
true,
"The time this peer acknowledged reception of the transaction (seconds since epoch)"},
182 for (
const auto& tx_info : txs) {
184 o.
pushKV(
"txid", tx_info.tx->GetHash().ToString());
185 o.
pushKV(
"wtxid", tx_info.tx->GetWitnessHash().ToString());
187 o.
pushKV(
"time_added", TicksSinceEpoch<std::chrono::seconds>(tx_info.time_added));
189 for (
const auto& peer : tx_info.peers) {
191 p.
pushKV(
"address", peer.address.ToStringAddrPort());
192 p.
pushKV(
"sent", TicksSinceEpoch<std::chrono::seconds>(peer.sent));
193 if (peer.received.has_value()) {
194 p.
pushKV(
"received", TicksSinceEpoch<std::chrono::seconds>(*peer.received));
198 o.
pushKV(
"peers", std::move(peers));
203 ret.pushKV(
"transactions", std::move(transactions));
212 "abortprivatebroadcast",
213 "Abort private broadcast attempts for a transaction currently being privately broadcast.\n"
214 "The transaction will be removed from the private broadcast queue.\n",
217 "If the provided id matches a txid that corresponds to multiple transactions with different wtxids, multiple transactions will be removed and returned."},
222 {
RPCResult::Type::ARR,
"removed_transactions",
"Transactions removed from the private broadcast queue",
245 if (removed_txs.empty()) {
250 for (
const auto& tx : removed_txs) {
252 o.
pushKV(
"txid", tx->GetHash().ToString());
253 o.
pushKV(
"wtxid", tx->GetWitnessHash().ToString());
255 removed_transactions.
push_back(std::move(o));
258 ret.pushKV(
"removed_transactions", std::move(removed_transactions));
268 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
269 "\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"
270 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
272 "\nThis checks if transactions violate the consensus or policy rules.\n"
273 "\nSee sendrawtransaction call.\n",
281 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
282 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
285 RPCResult::Type::ARR,
"",
"The result of the mempool acceptance test for each raw transaction in the input array.\n"
286 "Returns results for each transaction in the same order they were passed in.\n"
287 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
293 {
RPCResult::Type::STR,
"package-error",
true,
"Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
294 {
RPCResult::Type::BOOL,
"allowed",
true,
"Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
295 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
296 {
RPCResult::Type::NUM,
"vsize",
true,
"Virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted (only present when 'allowed' is true)"},
300 {
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."},
301 {
RPCResult::Type::ARR,
"effective-includes",
false,
"transactions whose fees and vsizes are included in effective-feerate.",
305 {
RPCResult::Type::STR,
"reject-reason",
true,
"Rejection reason (only present when 'allowed' is false)"},
306 {
RPCResult::Type::STR,
"reject-details",
true,
"Rejection details (only present when 'allowed' is false and rejection details exist)"},
311 "\nCreate a transaction\n"
312 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
313 "Sign the transaction, and get back the hex\n"
315 "\nTest acceptance of the transaction (signed hex)\n"
317 "\nAs a JSON-RPC call\n"
330 std::vector<CTransactionRef> txns;
331 txns.reserve(raw_transactions.
size());
332 for (
const auto& rawtx : raw_transactions.
getValues()) {
336 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
347 if (txns.size() > 1)
return ProcessNewPackage(chainstate, mempool, txns,
true, {});
357 bool exit_early{
false};
358 for (
const auto& tx : txns) {
360 result_inner.
pushKV(
"txid", tx->GetHash().GetHex());
361 result_inner.
pushKV(
"wtxid", tx->GetWitnessHash().GetHex());
365 auto it = package_result.
m_tx_results.find(tx->GetWitnessHash());
366 if (exit_early || it == package_result.
m_tx_results.end()) {
368 rpc_result.
push_back(std::move(result_inner));
371 const auto& tx_result = it->second;
375 const CAmount fee = tx_result.m_base_fees.value();
377 const int64_t virtual_size = tx_result.m_vsize.value();
378 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
379 if (max_raw_tx_fee &&
fee > max_raw_tx_fee) {
380 result_inner.
pushKV(
"allowed",
false);
381 result_inner.
pushKV(
"reject-reason",
"max-fee-exceeded");
386 result_inner.
pushKV(
"allowed",
true);
387 result_inner.
pushKV(
"vsize", virtual_size);
390 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
392 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
393 effective_includes_res.
push_back(wtxid.ToString());
395 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
396 result_inner.
pushKV(
"fees", std::move(fees));
399 result_inner.
pushKV(
"allowed",
false);
402 result_inner.
pushKV(
"reject-reason",
"missing-inputs");
408 rpc_result.
push_back(std::move(result_inner));
435 std::vector<RPCResult> list = {
436 RPCResult{
RPCResult::Type::NUM,
"vsize",
"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
444 RPCResult{
RPCResult::Type::NUM,
"chunkweight",
"sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop') of this transaction's chunk"},
458 RPCResult{
RPCResult::Type::BOOL,
"unbroadcast",
"Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
461 list.emplace_back(
RPCResult::Type::BOOL,
"bip125-replaceable",
"Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n");
470 chunk.
pushKV(
"chunkweight", chunk_feerate.
size);
472 for (
const auto& chunk_tx : chunk_txs) {
473 chunk_txids.
push_back(chunk_tx->GetTx().GetHash().ToString());
475 chunk.
pushKV(
"txs", std::move(chunk_txids));
483 for (
const auto& tx : cluster) {
484 total_weight += tx->GetAdjustedWeight();
486 info.pushKV(
"clusterweight", total_weight);
487 info.pushKV(
"txcount", cluster.size());
492 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
493 std::vector<const CTxMemPoolEntry *> current_chunk;
494 current_chunk.reserve(cluster.size());
497 for (
const auto& tx : cluster) {
498 if (current_chunk_feerate.
size == 0) {
501 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
502 current_chunk.clear();
503 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
505 current_chunk.push_back(tx);
506 current_chunk_feerate.
size -= tx->GetAdjustedWeight();
508 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
509 current_chunk.clear();
510 info.pushKV(
"chunks", std::move(all_chunks));
517 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
518 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
520 info.pushKV(
"vsize", e.GetTxSize());
521 info.pushKV(
"weight", e.GetTxWeight());
523 info.pushKV(
"height", e.GetHeight());
524 info.pushKV(
"descendantcount", descendant_count);
525 info.pushKV(
"descendantsize", descendant_size);
526 info.pushKV(
"ancestorcount", ancestor_count);
527 info.pushKV(
"ancestorsize", ancestor_size);
528 info.pushKV(
"wtxid", e.GetTx().GetWitnessHash().ToString());
529 auto feerate = pool.GetMainChunkFeerate(e);
530 info.pushKV(
"chunkweight", feerate.size);
538 info.pushKV(
"fees", std::move(fees));
541 std::set<std::string> setDepends;
549 for (
const std::string& dep : setDepends)
554 info.pushKV(
"depends", std::move(depends));
558 spent.
push_back(child.GetTx().GetHash().ToString());
561 info.pushKV(
"spentby", std::move(spent));
562 info.pushKV(
"unbroadcast", pool.IsUnbroadcastTx(tx.
GetHash()));
566 bool rbfStatus =
false;
573 info.pushKV(
"bip125-replaceable", rbfStatus);
580 if (include_mempool_sequence) {
591 o.
pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
596 uint64_t mempool_sequence;
600 a.
push_back(e.GetTx().GetHash().ToString());
604 if (!include_mempool_sequence) {
608 o.
pushKV(
"txids", std::move(a));
609 o.
pushKV(
"mempool_sequence", mempool_sequence);
617 return RPCMethod{
"getmempoolfeeratediagram",
618 "Returns the feerate diagram for the whole mempool.",
647 for (
auto f : diagram) {
649 o.
pushKV(
"weight", f.size);
662 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
663 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
666 {
"mempool_sequence",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
679 RPCResult{
"for verbose = false and mempool_sequence = true",
695 bool fVerbose =
false;
696 if (!request.params[0].isNull())
697 fVerbose = request.params[0].
get_bool();
699 bool include_mempool_sequence =
false;
700 if (!request.params[1].isNull()) {
701 include_mempool_sequence = request.params[1].get_bool();
712 "getmempoolancestors",
713 "If txid is in the mempool, returns all in-mempool ancestors.\n",
734 bool fVerbose =
false;
735 if (!request.params[1].isNull())
736 fVerbose = request.params[1].
get_bool();
743 const auto entry{mempool.
GetEntry(txid)};
744 if (entry ==
nullptr) {
753 o.
push_back(ancestorIt->GetTx().GetHash().ToString());
773 "getmempooldescendants",
774 "If txid is in the mempool, returns all in-mempool descendants.\n",
795 bool fVerbose =
false;
796 if (!request.params[1].isNull())
797 fVerbose = request.params[1].
get_bool();
804 const auto it{mempool.
GetIter(txid)};
812 setDescendants.erase(*it);
817 o.
push_back(descendantIt->GetTx().GetHash().ToString());
838 "Returns mempool data for given cluster\n",
856 const auto entry{mempool.
GetEntry(txid)};
857 if (entry ==
nullptr) {
874 "Returns mempool data for given transaction\n",
891 const auto entry{mempool.
GetEntry(txid)};
892 if (entry ==
nullptr) {
906 "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
920 {
"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)."},
932 {
RPCResult::Type::STR_HEX,
"spendingtxid",
true,
"the transaction id of the mempool transaction spending this output (omitted if unspent)"},
933 {
RPCResult::Type::STR_HEX,
"spendingtx",
true,
"the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
934 {
RPCResult::Type::STR_HEX,
"blockhash",
true,
"the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
939 HelpExampleCli(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
940 +
HelpExampleRpc(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
941 +
HelpExampleCliNamed(
"gettxspendingprevout", {{
"outputs",
"[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"}, {
"return_spending_tx",
true}})
946 if (output_params.
empty()) {
956 const bool mempool_only{options.exists(
"mempool_only") ? options[
"mempool_only"].get_bool() : !
g_txospenderindex};
957 const bool return_spending_tx{options.exists(
"return_spending_tx") ? options[
"return_spending_tx"].get_bool() :
false};
964 std::vector<Entry> prevouts_to_process;
966 for (
unsigned int idx = 0; idx < output_params.
size(); idx++) {
980 prevouts_to_process.emplace_back(
COutPoint{txid,
static_cast<uint32_t
>(nOutput)}, &o);
983 auto make_output = [return_spending_tx](
const Entry& prevout,
const CTransaction* spending_tx =
nullptr) {
986 o.pushKV(
"spendingtxid", spending_tx->GetHash().ToString());
987 if (return_spending_tx) {
1002 for (
auto it = prevouts_to_process.begin(); it != prevouts_to_process.end(); ) {
1007 if (!spending_tx && !mempool_only) {
1012 result.push_back(make_output(*it, spending_tx));
1013 it = prevouts_to_process.erase(it);
1018 if (prevouts_to_process.empty()) {
1028 for (
const auto& prevout : prevouts_to_process) {
1034 if (
const auto& spender_opt{spender.value()}) {
1035 UniValue o{make_output(prevout, spender_opt->tx.get())};
1036 o.
pushKV(
"blockhash", spender_opt->block_hash.GetHex());
1037 result.push_back(std::move(o));
1040 result.push_back(make_output(prevout));
1055 ret.pushKV(
"size", pool.
size());
1068 ret.pushKV(
"optimal", pool.m_txgraph->DoWork(0));
1070 ret.pushKV(
"fullrbf",
true);
1078 "Returns details on the active state of the TX memory pool.",
1083 std::vector<RPCResult> list = {
1084 {
RPCResult::Type::BOOL,
"loaded",
"True if the initial load attempt of the persisted mempool finished"},
1086 {
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"},
1093 {
RPCResult::Type::NUM,
"unbroadcastcount",
"Current number of transactions that haven't passed initial broadcast yet"},
1094 {
RPCResult::Type::BOOL,
"permitbaremultisig",
"True if the mempool accepts transactions with bare multisig outputs"},
1095 {
RPCResult::Type::NUM,
"maxdatacarriersize",
"Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
1096 {
RPCResult::Type::NUM,
"limitclustercount",
"Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
1097 {
RPCResult::Type::NUM,
"limitclustersize",
"Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
1101 list.emplace_back(
RPCResult::Type::BOOL,
"fullrbf",
"True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)");
1121 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
1122 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
1131 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
1132 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1134 "Whether to apply the fee delta metadata from the mempool file.\n"
1135 "It will be added to any existing fee deltas.\n"
1136 "The fee delta can be set by the prioritisetransaction RPC.\n"
1137 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
1138 "Only set this bool if you understand what it does."},
1140 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
1141 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1158 const fs::path load_path{
fs::u8path(self.
Arg<std::string_view>(
"filepath"))};
1159 const UniValue& use_current_time{request.params[1][
"use_current_time"]};
1160 const UniValue& apply_fee_delta{request.params[1][
"apply_fee_delta_priority"]};
1161 const UniValue& apply_unbroadcast{request.params[1][
"apply_unbroadcast_set"]};
1163 .
use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
1164 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
1165 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
1182 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
1209 ret.pushKV(
"filename", dump_path.utf8string());
1222 RPCResult{
RPCResult::Type::NUM,
"vsize",
"The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1234 o.
pushKV(
"txid", orphan.
tx->GetHash().ToString());
1235 o.
pushKV(
"wtxid", orphan.
tx->GetWitnessHash().ToString());
1236 o.
pushKV(
"bytes", orphan.
tx->ComputeTotalSize());
1240 for (
const auto fromPeer: orphan.
announcers) {
1251 "Shows transactions in the tx orphanage.\n"
1252 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1254 {
"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",
1272 Cat<std::vector<RPCResult>>(
1293 if (verbosity == 0) {
1294 for (
auto const& orphan : orphanage) {
1295 ret.push_back(orphan.tx->GetHash().ToString());
1297 }
else if (verbosity == 1) {
1298 for (
auto const& orphan : orphanage) {
1301 }
else if (verbosity == 2) {
1302 for (
auto const& orphan : orphanage) {
1319 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1320 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1321 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1322 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1326 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1327 "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"
1328 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1334 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
1335 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1337 "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"
1338 "If burning funds through unspendable outputs is desired, increase this value.\n"
1339 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1345 {
RPCResult::Type::STR,
"package_msg",
"The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1346 {
RPCResult::Type::OBJ_DYN,
"tx-results",
"The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1350 {
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."},
1354 {
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."},
1355 {
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.",
1359 {
RPCResult::Type::STR,
"error",
true,
"Error string if rejected from mempool, or \"package-not-validated\" when the package aborts before any per-tx processing."},
1362 {
RPCResult::Type::ARR,
"replaced-transactions",
true,
"List of txids of replaced transactions",
1369 HelpExampleRpc(
"submitpackage", R
"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1370 HelpExampleCli("submitpackage", R
"('["raw-tx-without-unconfirmed-parents"]')")
1382 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1384 if (max_raw_tx_fee_rate ==
CFeeRate(0)) {
1385 client_maxfeerate = std::nullopt;
1391 std::vector<CTransactionRef> txns;
1392 txns.reserve(raw_transactions.
size());
1393 for (
const auto& rawtx : raw_transactions.
getValues()) {
1397 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
1400 for (
const auto&
out : mtx.
vout) {
1401 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
1410 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE,
"package topology disallowed. not child-with-parents or parents depend on each other.");
1418 std::string package_msg =
"success";
1421 switch(package_result.m_state.GetResult()) {
1425 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1426 for (
const auto& tx : txns) {
1435 package_result.m_state.GetRejectReason());
1441 package_msg = package_result.m_state.ToString();
1442 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1443 package_result.m_tx_results.empty());
1448 size_t num_broadcast{0};
1449 for (
const auto& tx : txns) {
1451 if (!mempool.
exists(tx->GetHash())) {
1456 std::string err_string;
1463 if (err != TransactionError::OK) {
1465 strprintf(
"transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1466 err_string, num_broadcast));
1472 rpc_result.pushKV(
"package_msg", package_msg);
1474 std::set<Txid> replaced_txids;
1475 for (
const auto& tx : txns) {
1477 result_inner.pushKV(
"txid", tx->GetHash().GetHex());
1478 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1479 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1480 if (it == package_result.m_tx_results.end()) {
1485 result_inner.pushKV(
"error",
"package-not-validated");
1486 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1489 const auto& tx_result = it->second;
1490 switch(it->second.m_result_type) {
1492 result_inner.pushKV(
"other-wtxid", it->second.m_other_wtxid.value().GetHex());
1495 result_inner.pushKV(
"error", it->second.m_state.ToString());
1499 result_inner.pushKV(
"vsize", it->second.m_vsize.value());
1506 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1508 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1509 effective_includes_res.
push_back(wtxid.ToString());
1511 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
1513 result_inner.pushKV(
"fees", std::move(fees));
1514 for (
const auto& ptx : it->second.m_replaced_transactions) {
1515 replaced_txids.insert(ptx->GetHash());
1519 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1521 rpc_result.pushKV(
"tx-results", std::move(tx_result_map));
1523 for (
const auto& txid : replaced_txids) replaced_list.
push_back(txid.ToString());
1524 rpc_result.pushKV(
"replaced-transactions", std::move(replaced_list));
1550 for (
const auto& c : commands) {
1551 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< PrivateBroadcast::TxBroadcastInfo > GetPrivateBroadcastInfo() const =0
Get info about transactions currently being privately broadcast.
virtual std::vector< node::TxOrphanage::OrphanInfo > GetOrphanTransactions()=0
virtual std::vector< CTransactionRef > AbortPrivateBroadcast(const uint256 &id)=0
Abort private broadcast attempts for transactions currently being privately broadcast.
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 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)
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.
static const CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
@ 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...
fs::path MempoolPath(const ArgsManager &argsman)
static const CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls.
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.
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.
static 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 (...
static 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.