|
| 1 | +#pragma once |
| 2 | +/* Copyright (c) 2017, 2021 Pieter Wuille |
| 3 | + * |
| 4 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 5 | + * of this software and associated documentation files (the "Software"), to deal |
| 6 | + * in the Software without restriction, including without limitation the rights |
| 7 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 8 | + * copies of the Software, and to permit persons to whom the Software is |
| 9 | + * furnished to do so, subject to the following conditions: |
| 10 | + * |
| 11 | + * The above copyright notice and this permission notice shall be included in |
| 12 | + * all copies or substantial portions of the Software. |
| 13 | + * |
| 14 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 15 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 16 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 17 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 18 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 19 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 20 | + * THE SOFTWARE. |
| 21 | + */ |
| 22 | + |
| 23 | +#include <cstdint> |
| 24 | +#include <string> |
| 25 | +#include <vector> |
| 26 | + |
| 27 | +namespace bech32 |
| 28 | +{ |
| 29 | + |
| 30 | +enum class Encoding |
| 31 | +{ |
| 32 | + INVALID, |
| 33 | + |
| 34 | + BECH32, //! Bech32 encoding as defined in BIP173 |
| 35 | + BECH32M, //! Bech32m encoding as defined in BIP350 |
| 36 | +}; |
| 37 | + |
| 38 | +/** Encode a Bech32 or Bech32m string. If hrp contains uppercase characters, this will cause an |
| 39 | + * assertion error. Encoding must be one of BECH32 or BECH32M. */ |
| 40 | +std::string encode(const std::string & hrp, const std::vector<uint8_t> & values, Encoding encoding); |
| 41 | + |
| 42 | +/** A type for the result of decoding. */ |
| 43 | +struct DecodeResult |
| 44 | +{ |
| 45 | + Encoding encoding; //!< What encoding was detected in the result; Encoding::INVALID if failed. |
| 46 | + std::string hrp; //!< The human readable part |
| 47 | + std::vector<uint8_t> data; //!< The payload (excluding checksum) |
| 48 | + |
| 49 | + DecodeResult() |
| 50 | + : encoding(Encoding::INVALID) |
| 51 | + { |
| 52 | + } |
| 53 | + DecodeResult(Encoding enc, std::string && h, std::vector<uint8_t> && d) |
| 54 | + : encoding(enc) |
| 55 | + , hrp(std::move(h)) |
| 56 | + , data(std::move(d)) |
| 57 | + { |
| 58 | + } |
| 59 | +}; |
| 60 | + |
| 61 | +/** Decode a Bech32 or Bech32m string. */ |
| 62 | +DecodeResult decode(const std::string & str); |
| 63 | + |
| 64 | +} |
0 commit comments