bech32.h

Go to the documentation of this file.

// Copyright (c) 2017, 2021 Pieter Wuille
// Copyright (c) 2021-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
// 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.
 
#ifndef BITCOIN_BECH32_H
#define BITCOIN_BECH32_H
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <utility>
#include <vector>
 
namespace bech32
{
 
static constexpr size_t CHECKSUM_SIZE = 6;
static constexpr char SEPARATOR = '1';
 
enum class Encoding {
    INVALID, 
 
    BECH32,  
    BECH32M, 
};
 
enum CharLimit : size_t {
    BECH32 = 90,            
};
 
std::string Encode(Encoding encoding, const std::string& hrp, const std::vector<uint8_t>& values);
 
struct DecodeResult
{
    Encoding encoding;         
    std::string hrp;           
    std::vector<uint8_t> data; 
 
    DecodeResult() : encoding(Encoding::INVALID) {}
    DecodeResult(Encoding enc, std::string&& h, std::vector<uint8_t>&& d) : encoding(enc), hrp(std::move(h)), data(std::move(d)) {}
};
 
DecodeResult Decode(const std::string& str, CharLimit limit = CharLimit::BECH32);
 
std::pair<std::string, std::vector<int>> LocateErrors(const std::string& str, CharLimit limit = CharLimit::BECH32);
 
} // namespace bech32
 
#endif // BITCOIN_BECH32_H