From 6e77a7b65cda1b46ce42f0c99ca91562255aeb28 Mon Sep 17 00:00:00 2001 From: Andrew Chow Date: Wed, 20 Nov 2019 15:41:20 -0500 Subject: [PATCH] keypool: Add comment about TopUp and when to use it --- src/wallet/scriptpubkeyman.h | 4 ++++ 1 file changed, 4 insertions(+) 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