bech32m

Documentation

Index

• Constants
• func ConvertBits(data []byte, fromBits, toBits uint8, pad bool) ([]byte, error)
• func Decode(bech string) (string, []byte, error)
• func DecodeNoLimit(bech string) (string, []byte, error)
• func DecodeToBase256(bech string) (string, []byte, error)
• func DecodeToBase256WithTypeNoLimit(bech string) (string, byte, []byte, error)
• func Encode(hrp string, data []byte) (string, error)
• func EncodeFromBase256(hrp string, data []byte) (string, error)
• func EncodeFromBase256WithType(hrp string, typ byte, data []byte) (string, error)
• type InvalidBitGroupsError
  • func (e InvalidBitGroupsError) Code() int
  • func (e InvalidBitGroupsError) Error() string
• type InvalidCharacterError
  • func (e InvalidCharacterError) Code() int
  • func (e InvalidCharacterError) Error() string
• type InvalidChecksumError
  • func (e InvalidChecksumError) Code() int
  • func (e InvalidChecksumError) Error() string
• type InvalidDataByteError
  • func (e InvalidDataByteError) Code() int
  • func (e InvalidDataByteError) Error() string
• type InvalidIncompleteGroupError
  • func (e InvalidIncompleteGroupError) Code() int
  • func (e InvalidIncompleteGroupError) Error() string
• type InvalidLengthError
  • func (e InvalidLengthError) Code() int
  • func (e InvalidLengthError) Error() string
• type InvalidSeparatorIndexError
  • func (e InvalidSeparatorIndexError) Code() int
  • func (e InvalidSeparatorIndexError) Error() string
• type MixedCaseError
  • func (e MixedCaseError) Code() int
  • func (e MixedCaseError) Error() string
• type NonCharsetCharError
  • func (e NonCharsetCharError) Code() int
  • func (e NonCharsetCharError) Error() string

Constants

const ChecksumConst = int(0x2bc830a3)

ChecksumConst is a type that represents the currently defined bech32 checksum constants.

Functions

func ConvertBits

func ConvertBits(data []byte, fromBits, toBits uint8, pad bool) ([]byte, error)

ConvertBits converts a byte slice where each byte is encoding fromBits bits, to a byte slice where each byte is encoding toBits bits.

func Decode

func Decode(bech string) (string, []byte, error)

Decode decodes a bech32 encoded string, returning the human-readable part and the data part excluding the checksum.

Note that the returned data is 5-bit (base32) encoded and the human-readable part will be lowercase.

func DecodeNoLimit

func DecodeNoLimit(bech string) (string, []byte, error)

DecodeNoLimit decodes a bech32 encoded string, returning the human-readable part and the data part excluding the checksum. This function does NOT validate against the BIP-173 maximum length allowed for bech32 strings.

Note that the returned data is 5-bit (base32) encoded and the human-readable part will be lowercase.

func DecodeToBase256

func DecodeToBase256(bech string) (string, []byte, error)

DecodeToBase256 decodes a bech32-encoded string into its associated human-readable part (HRP) and base32-encoded data, converts that data to a base256-encoded byte slice and returns it along with the lowercase HRP.

func DecodeToBase256WithTypeNoLimit

func DecodeToBase256WithTypeNoLimit(bech string) (string, byte, []byte, error)

DecodeToBase256WithTypeNoLimit decodes a bech32-encoded string into its associated human-readable part (HRP), type byte and base32-encoded data, converts that data to a base256-encoded byte slice.

This function does NOT validate against the BIP-173 maximum length allowed for bech32 strings.

func Encode

func Encode(hrp string, data []byte) (string, error)

Encode encodes a byte slice into a bech32 string with the given human-readable part (HRP). The HRP will be converted to lowercase if needed since mixed cased encodings are not permitted and lowercase is used for checksum purposes. Note that the bytes must each encode 5 bits (base32).

func EncodeFromBase256

func EncodeFromBase256(hrp string, data []byte) (string, error)

EncodeFromBase256 converts a base256-encoded byte slice into a base32-encoded byte slice and then encodes it into a bech32 string with the given human-readable part (HRP). The HRP will be converted to lowercase if needed since mixed cased encodings are not permitted and lowercase is used for checksum purposes.

func EncodeFromBase256WithType

func EncodeFromBase256WithType(hrp string, typ byte, data []byte) (string, error)

EncodeFromBase256WithType converts a base256-encoded byte slice into a base32-encoded byte slice and, concatenates the given type at the beginning and then encodes it into a bech32 string with the given human-readable part (HRP).

The HRP will be converted to lowercase if needed since mixed cased encodings are not permitted and lowercase is used for checksum purposes. The maximum size of type byte is 5 bits.

Types

type InvalidBitGroupsError

type InvalidBitGroupsError struct{}

InvalidBitGroupsError is returned when conversion is attempted between byte slices using bit-per-element of unsupported value.

func (InvalidBitGroupsError) Code

func (e InvalidBitGroupsError) Code() int

func (InvalidBitGroupsError) Error

func (e InvalidBitGroupsError) Error() string

type InvalidCharacterError

type InvalidCharacterError rune

InvalidCharacterError is returned when the bech32 string has a character outside the range of the supported charset.

func (InvalidCharacterError) Code

func (e InvalidCharacterError) Code() int

func (InvalidCharacterError) Error

func (e InvalidCharacterError) Error() string

type InvalidChecksumError

type InvalidChecksumError struct {
	Expected string
	Actual   string
}

InvalidChecksumError is returned when the extracted checksum of the string is different than what was expected.

func (InvalidChecksumError) Code

func (e InvalidChecksumError) Code() int

func (InvalidChecksumError) Error

func (e InvalidChecksumError) Error() string

type InvalidDataByteError

type InvalidDataByteError byte

InvalidDataByteError is returned when a byte outside the range required for conversion into a string was found.

func (InvalidDataByteError) Code

func (e InvalidDataByteError) Code() int

func (InvalidDataByteError) Error

func (e InvalidDataByteError) Error() string

type InvalidIncompleteGroupError

type InvalidIncompleteGroupError struct{}

InvalidIncompleteGroupError is returned when then byte slice used as input has data of wrong length.

func (InvalidIncompleteGroupError) Code

func (e InvalidIncompleteGroupError) Code() int

func (InvalidIncompleteGroupError) Error

func (e InvalidIncompleteGroupError) Error() string

type InvalidLengthError

type InvalidLengthError int

InvalidLengthError is returned when the bech32 string has an invalid length given the BIP-173 defined restrictions.

func (InvalidLengthError) Code

func (e InvalidLengthError) Code() int

func (InvalidLengthError) Error

func (e InvalidLengthError) Error() string

type InvalidSeparatorIndexError

type InvalidSeparatorIndexError int

InvalidSeparatorIndexError is returned when the separator character '1' is in an invalid position in the bech32 string.

func (InvalidSeparatorIndexError) Code

func (e InvalidSeparatorIndexError) Code() int

func (InvalidSeparatorIndexError) Error

func (e InvalidSeparatorIndexError) Error() string

type MixedCaseError

type MixedCaseError struct{}

MixedCaseError is returned when the bech32 string has both lower and uppercase characters.

func (MixedCaseError) Code

func (e MixedCaseError) Code() int

func (MixedCaseError) Error

func (e MixedCaseError) Error() string

type NonCharsetCharError

type NonCharsetCharError rune

NonCharsetCharError is returned when a character outside the specific bech32 charset is used in the string.

func (NonCharsetCharError) Code

func (e NonCharsetCharError) Code() int

func (NonCharsetCharError) Error

func (e NonCharsetCharError) Error() string