From 03346022d611871f2cc185440b19d928b9264d9d Mon Sep 17 00:00:00 2001 From: Fabian Jahr Date: Thu, 18 Mar 2021 00:43:35 +0100 Subject: [PATCH] naming nits --- src/bech32.cpp | 8 ++++---- src/bech32.h | 11 ++++++----- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/bech32.cpp b/src/bech32.cpp index 289e0213e8..288b14e023 100644 --- a/src/bech32.cpp +++ b/src/bech32.cpp @@ -15,10 +15,10 @@ namespace typedef std::vector data; -/** The Bech32 character set for encoding. */ +/** The Bech32 and Bech32m character set for encoding. */ const char* CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l"; -/** The Bech32 character set for decoding. */ +/** The Bech32 and Bech32m character set for decoding. */ const int8_t CHARSET_REV[128] = { -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, @@ -150,8 +150,8 @@ data CreateChecksum(Encoding encoding, const std::string& hrp, const data& value /** Encode a Bech32 or Bech32m string. */ std::string Encode(Encoding encoding, const std::string& hrp, const data& values) { - // First ensure that the HRP is all lowercase. BIP-173 requires an encoder - // to return a lowercase Bech32 string, but if given an uppercase HRP, the + // First ensure that the HRP is all lowercase. BIP-173 and BIP350 require an encoder + // to return a lowercase Bech32/Bech32m string, but if given an uppercase HRP, the // result will always be invalid. for (const char& c : hrp) assert(c < 'A' || c > 'Z'); data checksum = CreateChecksum(encoding, hrp, values); diff --git a/src/bech32.h b/src/bech32.h index 3679ea8ccb..e9450ccc2b 100644 --- a/src/bech32.h +++ b/src/bech32.h @@ -2,10 +2,11 @@ // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. -// Bech32 is a string encoding format used in newer address types. -// The output consists of a human-readable part (alphanumeric), a -// separator character (1), and a base32 data section, the last -// 6 characters of which are a checksum. +// Bech32 and Bech32m are string encoding formats used in newer +// address types. The outputs consist of a human-readable part +// (alphanumeric), a separator character (1), and a base32 data +// section, the last 6 characters of which are a checksum. The +// module is namespaced under bech32 for historical reasons. // // For more information, see BIP 173 and BIP 350. @@ -40,7 +41,7 @@ struct DecodeResult DecodeResult(Encoding enc, std::string&& h, std::vector&& d) : encoding(enc), hrp(std::move(h)), data(std::move(d)) {} }; -/** Decode a Bech32 string. */ +/** Decode a Bech32 or Bech32m string. */ DecodeResult Decode(const std::string& str); } // namespace bech32