From db225cea56b0531cc42d4b89dc61b02890f432ff Mon Sep 17 00:00:00 2001 From: Ryan Ofsky Date: Mon, 18 Nov 2024 10:29:55 -0500 Subject: [PATCH] wallet, refactor: Replace GetDisplayName() with LogName() The GetDisplayName() method name was confusing because it suggested the return value could be used for display, while documentation and implementation indicated it only meant to be used for logging. Also the name didn't suggest that it was formatting the wallet names, which made it harder understand how messages were formatted in the places it was called. Fix these issues by splitting up the GetDisplayName() method and replacing it with LogName() / DisplayName() methods. This commit is a refactoring that does not change any behavior. --- src/wallet/scriptpubkeyman.cpp | 2 +- src/wallet/scriptpubkeyman.h | 4 ++-- src/wallet/wallet.h | 12 ++++++------ 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/wallet/scriptpubkeyman.cpp b/src/wallet/scriptpubkeyman.cpp index d2ac171f8d3..40e017600d1 100644 --- a/src/wallet/scriptpubkeyman.cpp +++ b/src/wallet/scriptpubkeyman.cpp @@ -996,7 +996,7 @@ bool DescriptorScriptPubKeyMan::TopUp(unsigned int size) WalletBatch batch(m_storage.GetDatabase()); if (!batch.TxnBegin()) return false; bool res = TopUpWithDB(batch, size); - if (!batch.TxnCommit()) throw std::runtime_error(strprintf("Error during descriptors keypool top up. Cannot commit changes for wallet %s", m_storage.GetDisplayName())); + if (!batch.TxnCommit()) throw std::runtime_error(strprintf("Error during descriptors keypool top up. Cannot commit changes for wallet [%s]", m_storage.LogName())); return res; } diff --git a/src/wallet/scriptpubkeyman.h b/src/wallet/scriptpubkeyman.h index e41ab6d669d..33c6ea3dcad 100644 --- a/src/wallet/scriptpubkeyman.h +++ b/src/wallet/scriptpubkeyman.h @@ -43,7 +43,7 @@ class WalletStorage { public: virtual ~WalletStorage() = default; - virtual std::string GetDisplayName() const = 0; + virtual std::string LogName() const = 0; virtual WalletDatabase& GetDatabase() const = 0; virtual bool IsWalletFlagSet(uint64_t) const = 0; virtual void UnsetBlankWalletFlag(WalletBatch&) = 0; @@ -162,7 +162,7 @@ public: template void WalletLogPrintf(util::ConstevalFormatString wallet_fmt, const Params&... params) const { - LogInfo("%s %s", m_storage.GetDisplayName(), tfm::format(wallet_fmt, params...)); + LogInfo("[%s] %s", m_storage.LogName(), tfm::format(wallet_fmt, params...)); }; /** Keypool has new keys */ diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h index fa2833827c4..fc4c55fb7e9 100644 --- a/src/wallet/wallet.h +++ b/src/wallet/wallet.h @@ -905,14 +905,14 @@ public: /** Loads the flags into the wallet. (used by LoadWallet) */ bool LoadWalletFlags(uint64_t flags); - /** Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name */ - std::string GetDisplayName() const override + /** Return wallet name for use in logs, will return "default wallet" if the wallet has no name. */ + std::string LogName() const override { - std::string wallet_name = GetName().length() == 0 ? "default wallet" : GetName(); - return strprintf("[%s]", wallet_name); + std::string name{GetName()}; + return name.empty() ? "default wallet" : name; }; - /** Return wallet name for display, translating "default wallet" string if returned. */ + /** Return wallet name for display, like LogName() but translates "default wallet" string. */ std::string DisplayName() const { std::string name{GetName()}; @@ -923,7 +923,7 @@ public: template void WalletLogPrintf(util::ConstevalFormatString wallet_fmt, const Params&... params) const { - LogInfo("%s %s", GetDisplayName(), tfm::format(wallet_fmt, params...)); + LogInfo("[%s] %s", LogName(), tfm::format(wallet_fmt, params...)); }; /** Upgrade the wallet */