aboutsummaryrefslogtreecommitdiff
path: root/src/bech32.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/bech32.h')
-rw-r--r--src/bech32.h11
1 files changed, 6 insertions, 5 deletions
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<uint8_t>&& 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