Codec.Binary.Bech32

Encode a Bech32 string from a human-readable prefix and data payload.

Example

>>> import Prelude>>> import Codec.Binary.Bech32>>> import Data.Text.Encoding

First, prepare a human-readable prefix:

>>> Right prefix = humanReadablePartFromText "example"

Next, prepare a data payload:

>>> messageToEncode = "Lorem ipsum dolor sit amet!">>> dataPart = dataPartFromBytes $ encodeUtf8 messageToEncode

Finally, produce a Bech32 string:

>>> encode prefix dataPartRight "example1f3hhyetdyp5hqum4d5sxgmmvdaezqumfwssxzmt9wsss9un3cx"

Decode a Bech32 string into a human-readable prefix and data payload.

Example

>>> import Prelude>>> import Codec.Binary.Bech32>>> import Data.Text.Encoding

First, decode the input:

>>> input = "example1f3hhyetdyp5hqum4d5sxgmmvdaezqumfwssxzmt9wsss9un3cx">>> Right (prefix, dataPart) = decode input

Next, examine the decoded human-readable prefix:

>>> humanReadablePartToText prefix"example"

Finally, examine the decoded data payload:

>>> decodeUtf8 <$> dataPartToBytes dataPartJust "Lorem ipsum dolor sit amet!"

Represents the set of error conditions that may occur while encoding a Bech32 string.

Represents the set of errors that may occur while decoding a Bech32 string with the decode function.

Represents the data part of a Bech32 string, as defined here: https://git.io/fj8FS

Construct a DataPart directly from a list of words.

This function guarantees to satisfy the following properties:

dataPartFromWords (dataPartToWords d) == d
dataPartToWords (dataPartFromWords w) == w

Unpack a DataPart into a list of its constituent words.

This function guarantees to satisfy the following properties:

dataPartFromWords (dataPartToWords d) == d
dataPartToWords (dataPartFromWords w) == w

Constructs a DataPart from a ByteString.

This function encodes a ByteString in such a way that guarantees it can be successfully decoded with the dataPartToBytes function:

dataPartToBytes (dataPartFromBytes b) == Just b

Attempts to extract a ByteString from a DataPart.

This function guarantees to satisfy the following property:

dataPartToBytes (dataPartFromBytes b) == Just b

Constructs a DataPart from textual input.

All characters in the input must be a member of dataCharList, the set of characters permitted to appear within the data part of a Bech32 string.

Returns Nothing if any character in the input is not a member of dataCharList.

This function guarantees to satisfy the following property:

dataPartFromText (dataPartToText d) == Just d

Converts a DataPart to Text, using the Bech32 character set to render the data.

This function guarantees to satisfy the following property:

dataPartFromText (dataPartToText d) == Just d

Represents the human-readable part of a Bech32 string, as defined here: https://git.io/fj8FS

Parses the human-readable part of a Bech32 string, as defined here: https://git.io/fj8FS

Get the raw text of the human-readable part of a Bech32 string.

Represents the set of error conditions that may occur while parsing the human-readable part of a Bech32 string.

The zero-based position of a character in a string, counting from the left.

Values of this type are typically used to reflect the positions of errors.

See DecodingError.

Represents a data word of 5 bits in width.

Each character in the data portion of a Bech32 string encodes exactly 5 bits of data.

Construction and Deconstruction

Use the toEnum and fromEnum functions to construct and deconstruct Word5 values.

Packing Words into Data Payloads

Use the dataPartFromWords and dataPartToWords functions to pack and unpack Word5 values into and out of data payloads.

Like encode but allows output to be longer than 90 characters.

This isn't ideal, as Bech32 error detection becomes worse as strings get longer, but it may be useful in certain circumstances.

From BIP-0173:

"Even though the chosen code performs reasonably well up to 1023 characters, other designs are preferable for lengths above 89 characters (excluding the separator)."

Like decode but does not enforce a maximum length.

See also encodeLenient for details.

A list of all characters that are permitted to appear within the data part of a Bech32 string.

See here for more details: https://git.io/fj8FS

The shortest length permitted for the human-readable part of a Bech32 string.

The longest length permitted for the human-readable part of a Bech32 string.

The lower bound of the set of characters permitted to appear within the human-readable part of a Bech32 string.

The upper bound of the set of characters permitted to appear within the human-readable part of a Bech32 string.

The maximum length of an encoded string, in bytes.

This length includes the human-readable part, the separator character, the encoded data portion, and the checksum.

The minimum length of an encoded string, in bytes.

This length includes the human-readable part, the separator character, the encoded data portion, and the checksum.

The separator character.

This character appears immediately after the human-readable part and before the data part in an encoded string.