diff --git a/src/xrpld/app/tx/detail/SignerEntries.cpp b/src/xrpld/app/tx/detail/SignerEntries.cpp index f6a42120d11..cab362a8e3b 100644 --- a/src/xrpld/app/tx/detail/SignerEntries.cpp +++ b/src/xrpld/app/tx/detail/SignerEntries.cpp @@ -30,7 +30,7 @@ Expected, NotTEC> SignerEntries::deserialize( STObject const& obj, beast::Journal journal, - std::string const& annotation) + std::string_view annotation) { std::pair, NotTEC> s; diff --git a/src/xrpld/app/tx/detail/SignerEntries.h b/src/xrpld/app/tx/detail/SignerEntries.h index c64e106ae9e..2227aa98109 100644 --- a/src/xrpld/app/tx/detail/SignerEntries.h +++ b/src/xrpld/app/tx/detail/SignerEntries.h @@ -27,18 +27,27 @@ #include // STTx::maxMultiSigners #include // temMALFORMED #include // AccountID + #include +#include namespace ripple { // Forward declarations class STObject; -// Support for SignerEntries that is needed by a few Transactors +// Support for SignerEntries that is needed by a few Transactors. +// +// SignerEntries is represented as a std::vector. +// There is no direct constructor for SignerEntries. +// +// o A std::vector is a SignerEntries. +// o More commonly, SignerEntries are extracted from an STObject by +// calling SignerEntries::deserialize(). class SignerEntries { public: - explicit SignerEntries() = default; + explicit SignerEntries() = delete; struct SignerEntry { @@ -69,11 +78,15 @@ class SignerEntries }; // Deserialize a SignerEntries array from the network or from the ledger. + // + // obj Contains a SignerEntries field that is an STArray. + // journal For reporting error conditions. + // annotation Source of SignerEntries, like "ledger" or "transaction". static Expected, NotTEC> deserialize( STObject const& obj, beast::Journal journal, - std::string const& annotation); + std::string_view annotation); }; } // namespace ripple