bech32 Namespace Reference

Classes
struct	DecodeResult

Enumerations
enum class	Encoding { INVALID , BECH32 , BECH32M }

Functions
std::string	Encode (Encoding encoding, const std::string &hrp, const data &values)
	Encode a Bech32 or Bech32m string. More...
DecodeResult	Decode (const std::string &str)
	Decode a Bech32 or Bech32m string. More...
std::pair< std::string, std::vector< int > >	LocateErrors (const std::string &str)
	Find index of an incorrect character in a Bech32 string. More...
std::string	Encode (Encoding encoding, const std::string &hrp, const std::vector< uint8_t > &values)
	Encode a Bech32 or Bech32m string. More...

Enumeration Type Documentation

Encoding

enum bech32::Encoding

strong

Enumerator
INVALID	Failed decoding.
BECH32	Bech32 encoding as defined in BIP173.
BECH32M	Bech32m encoding as defined in BIP350.

Definition at line 24 of file bech32.h.

Function Documentation

Decode()

DecodeResult bech32::Decode

(

const std::string &

str

)

Decode a Bech32 or Bech32m string.

Definition at line 373 of file bech32.cpp.

Here is the caller graph for this function:

Encode() [1/2]

std::string bech32::Encode	(	Encoding	encoding,
		const std::string &	hrp,
		const data &	values
	)

Encode a Bech32 or Bech32m string.

Definition at line 357 of file bech32.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Encode() [2/2]

std::string bech32::Encode	(	Encoding	encoding,
		const std::string &	hrp,
		const std::vector< uint8_t > &	values
	)

Encode a Bech32 or Bech32m string.

If hrp contains uppercase characters, this will cause an assertion error. Encoding must be one of BECH32 or BECH32M.

LocateErrors()

std::pair< std::string, std::vector< int > > bech32::LocateErrors

(

const std::string &

str

)

Find index of an incorrect character in a Bech32 string.

Return the positions of errors in a Bech32 string.

Definition at line 400 of file bech32.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: