From f31b3c21907fa7fd3a26f76a82389a5b2bdb49e5 Mon Sep 17 00:00:00 2001 From: Kris Nuttycombe Date: Sat, 6 Nov 2021 11:10:40 -0500 Subject: [PATCH] Update documentation for GenerateNewSeed. --- src/wallet/wallet.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h index 4bf1a2b30..35920fb8d 100644 --- a/src/wallet/wallet.h +++ b/src/wallet/wallet.h @@ -1296,9 +1296,11 @@ public: bool IsHDFullyEnabled() const; /* Generates a new HD seed (will reset the chain child index counters) - Sets the seed's version based on the current wallet version (so the - caller must ensure the current wallet version is correct before calling - this function). */ + * by randomly generating a mnemonic phrase that can be used for wallet + * recovery, and deriving the HD seed from that phrase in accordance with + * BIP 39 / ZIP 339. Sets the seed's version based on the current wallet + * version (the caller must ensure the current wallet version is correct + * before calling this function). */ void GenerateNewSeed(Language language = English); bool SetMnemonicSeed(const MnemonicSeed& seed);