Skip to content

Commit fa88669

Browse files
author
MarcoFalke
committed
doc: Clarify the getmempoolinfo.loaded RPC field documentation
Also, clarify the LoadMempool doxygen.
1 parent 6888886 commit fa88669

File tree

4 files changed

+5
-6
lines changed

4 files changed

+5
-6
lines changed

src/kernel/mempool_persist.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
#include <util/time.h>
2020
#include <validation.h>
2121

22-
#include <chrono>
2322
#include <cstdint>
2423
#include <cstdio>
2524
#include <exception>

src/kernel/mempool_persist.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ class CTxMemPool;
1212

1313
namespace kernel {
1414

15-
/** Dump the mempool to disk. */
15+
/** Dump the mempool to a file. */
1616
bool DumpMempool(const CTxMemPool& pool, const fs::path& dump_path,
1717
fsbridge::FopenFn mockable_fopen_function = fsbridge::fopen,
1818
bool skip_file_commit = false);
1919

20-
/** Load the mempool from disk. */
20+
/** Import the file and attempt to add its contents to the mempool. */
2121
bool LoadMempool(CTxMemPool& pool, const fs::path& load_path,
2222
Chainstate& active_chainstate,
2323
fsbridge::FopenFn mockable_fopen_function = fsbridge::fopen);

src/rpc/mempool.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ static RPCHelpMan getmempoolinfo()
696696
RPCResult{
697697
RPCResult::Type::OBJ, "", "",
698698
{
699-
{RPCResult::Type::BOOL, "loaded", "True if the mempool is fully loaded"},
699+
{RPCResult::Type::BOOL, "loaded", "True if the initial load attempt of the persisted mempool finished"},
700700
{RPCResult::Type::NUM, "size", "Current tx count"},
701701
{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"},
702702
{RPCResult::Type::NUM, "usage", "Total memory usage for the mempool"},

src/txmempool.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -663,13 +663,13 @@ class CTxMemPool
663663
void GetTransactionAncestry(const uint256& txid, size_t& ancestors, size_t& descendants, size_t* ancestorsize = nullptr, CAmount* ancestorfees = nullptr) const;
664664

665665
/**
666-
* @returns true if we've made an attempt to load the mempool regardless of
666+
* @returns true if an initial attempt to load the persisted mempool was made, regardless of
667667
* whether the attempt was successful or not
668668
*/
669669
bool GetLoadTried() const;
670670

671671
/**
672-
* Set whether or not we've made an attempt to load the mempool (regardless
672+
* Set whether or not an initial attempt to load the persisted mempool was made (regardless
673673
* of whether the attempt was successful or not)
674674
*/
675675
void SetLoadTried(bool load_tried);

0 commit comments

Comments
 (0)