aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Chow <achow101-github@achow101.com>2019-11-20 15:41:20 -0500
committerAndrew Chow <achow101-github@achow101.com>2019-12-05 11:51:52 -0500
commit6e77a7b65cda1b46ce42f0c99ca91562255aeb28 (patch)
tree723b5cecff1d0cc2afb7b5f475dc2812af26190d
parentea50e34b287e0da0806c1116bb55ade730e8ff6c (diff)
keypool: Add comment about TopUp and when to use it
-rw-r--r--src/wallet/scriptpubkeyman.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/wallet/scriptpubkeyman.h b/src/wallet/scriptpubkeyman.h
index 4f17156792..37b34223d9 100644
--- a/src/wallet/scriptpubkeyman.h
+++ b/src/wallet/scriptpubkeyman.h
@@ -154,6 +154,10 @@ public:
virtual void KeepDestination(int64_t index) {}
virtual void ReturnDestination(int64_t index, bool internal, const CPubKey& pubkey) {}
+ /** Fills internal address pool. Use within ScriptPubKeyMan implementations should be used sparingly and only
+ * when something from the address pool is removed, excluding GetNewDestination and GetReservedDestination.
+ * External wallet code is primarily responsible for topping up prior to fetching new addresses
+ */
virtual bool TopUp(unsigned int size = 0) { return false; }
//! Mark unused addresses as being used