phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

wallet, refactor: Replace GetDisplayName() with LogName()

Browse source 
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.
This commit is contained in:
Ryan Ofsky 2024-11-18 10:29:55 -05:00
parent 370abf849b
commit a46ec1dece
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/wallet/scriptpubkeyman.cpp
View file

@ -1317,7 +1317,7 @@ bool LegacyScriptPubKeyMan::TopUp(unsigned int kpSize)
return false; return false;
} }
} }
if (!batch.TxnCommit()) throw std::runtime_error(strprintf("Error during keypool top up. Cannot commit changes for wallet %s", m_storage.GetDisplayName())); if (!batch.TxnCommit()) throw std::runtime_error(strprintf("Error during keypool top up. Cannot commit changes for wallet [%s]", m_storage.LogName()));
NotifyCanGetAddressesChanged(); NotifyCanGetAddressesChanged();
// Note: Unlike with DescriptorSPKM, LegacySPKM does not need to call // Note: Unlike with DescriptorSPKM, LegacySPKM does not need to call
// m_storage.TopUpCallback() as we do not know what new scripts the LegacySPKM is // m_storage.TopUpCallback() as we do not know what new scripts the LegacySPKM is
@ -2230,7 +2230,7 @@ bool DescriptorScriptPubKeyMan::TopUp(unsigned int size)
WalletBatch batch(m_storage.GetDatabase()); WalletBatch batch(m_storage.GetDatabase());
if (!batch.TxnBegin()) return false; if (!batch.TxnBegin()) return false;
bool res = TopUpWithDB(batch, size); 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; return res;
} }

4
src/wallet/scriptpubkeyman.h
View file

@ -43,7 +43,7 @@ class WalletStorage
{ {
public: public:
virtual ~WalletStorage() = default; virtual ~WalletStorage() = default;
virtual std::string GetDisplayName() const = 0; virtual std::string LogName() const = 0;
virtual WalletDatabase& GetDatabase() const = 0; virtual WalletDatabase& GetDatabase() const = 0;
virtual bool IsWalletFlagSet(uint64_t) const = 0; virtual bool IsWalletFlagSet(uint64_t) const = 0;
virtual void UnsetBlankWalletFlag(WalletBatch&) = 0; virtual void UnsetBlankWalletFlag(WalletBatch&) = 0;
@ -257,7 +257,7 @@ public:
template <typename... Params> template <typename... Params>
void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> 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...));
}; };
/** Watch-only address added */ /** Watch-only address added */

12
src/wallet/wallet.h
View file

@ -922,14 +922,14 @@ public:
/** Determine if we are a legacy wallet */ /** Determine if we are a legacy wallet */
bool IsLegacy() const; bool IsLegacy() const;
/** Returns a bracketed wallet name for displaying in logs, will return [default wallet] if the wallet has no name */ /** Return wallet name for use in logs, will return "default wallet" if the wallet has no name. */
std::string GetDisplayName() const override std::string LogName() const override
{ {
std::string wallet_name = GetName().length() == 0 ? "default wallet" : GetName(); std::string name{GetName()};
return strprintf("[%s]", wallet_name); 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 DisplayName() const
{ {
std::string name{GetName()}; std::string name{GetName()};
@ -940,7 +940,7 @@ public:
template <typename... Params> template <typename... Params>
void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> 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 */ /** Upgrade the wallet */