keypool: Add comment about TopUp and when to use it

This commit is contained in:
Andrew Chow 2019-11-20 15:41:20 -05:00
parent ea50e34b28
commit 6e77a7b65c

View File

@ -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