Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IntersectMBO/bech32
Haskell implementation of the Bech32 address format (BIP 0173).
https://github.com/IntersectMBO/bech32
Last synced: about 2 months ago
JSON representation
Haskell implementation of the Bech32 address format (BIP 0173).
- Host: GitHub
- URL: https://github.com/IntersectMBO/bech32
- Owner: IntersectMBO
- License: apache-2.0
- Created: 2019-09-27T02:43:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T08:40:00.000Z (10 months ago)
- Last Synced: 2024-04-10T09:06:21.957Z (8 months ago)
- Language: Haskell
- Homepage:
- Size: 12.1 MB
- Stars: 41
- Watchers: 44
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-cardano - bech32
README
## `bech32` command-line
A small executable is available for rapid conversion in the console. You can obtain a pre-compiled `bech32` binary for Linux, macOS, and Windows as part of the [`cardano-wallet` Releases](https://github.com/input-output-hk/cardano-wallet/releases).
```console
Usage: bech32 [PREFIX]
Convert to and from bech32 strings. Data are read from standard input.
Available options:
-h,--help Show this help text
PREFIX An optional human-readable prefix (e.g. 'addr').
- When provided, the input text is decoded from
various encoding formats and re-encoded to
bech32 using the given prefix.
- When omitted, the input text is decoded from
bech32 to base16.
-v,--version output version information and exit
Supported encoding formats: Base16, Bech32 & Base58.
```
### Examples
#### To Bech32:
```console
$ bech32 base16_ <<< 706174617465
base16_1wpshgct5v5r5mxh0
$ bech32 base58_ <<< Ae2tdPwUPEYy
base58_1p58rejhd9592uusa8pzj2
$ bech32 new_prefix <<< old_prefix1wpshgcg2s33x3
new_prefix1wpshgcgeak9mv
```
#### From Bech32
```console
$ bech32 <<< base16_1wpshgct5v5r5mxh0
706174617465
```
## Bech32 Haskell Libraries
The repository provides [Haskell](https://www.haskell.org/) libraries for
working with the **Bech32** address format, as specified by
[BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki).
There are **two** libraries provided:
* [`bech32`](http://hackage.haskell.org/package/bech32)
Core primitives for encoding and decoding Bech32 strings.
* [`bech32-th`](http://hackage.haskell.org/package/bech32-th)
Template-Haskell specific extensions, including quasiquoters
for compile-time parsing of string literals.
## Contents
* [Documentation](#documentation)
* [Usage](#usage)
* [Encoding Data](#encoding-data)
* [Decoding Data](#decoding-data)
* [Contributing](#contributing)
## Documentation
For comprehensive instructions on how to use these libraries, see the Haddock documentation:
* [Documentation for `bech32`](https://hackage.haskell.org/package/bech32/docs/Codec-Binary-Bech32.html)
* [Documentation for `bech32-th`](https://hackage.haskell.org/package/bech32-th/docs/Codec-Binary-Bech32-TH.html)
## Usage
### Encoding Data
```hs
>>> import Prelude
>>> import Codec.Binary.Bech32
>>> import Data.Text.Encoding
```
First, prepare a human-readable prefix:
```hs
>>> Right prefix = humanReadablePartFromText "example"
```
Next, prepare a data payload:
```hs
>>> messageToEncode = "Lorem ipsum dolor sit amet!"
>>> dataPart = dataPartFromBytes $ encodeUtf8 messageToEncode
```
Finally, produce a Bech32 string:
```hs
>>> encode prefix dataPart
Right "example1f3hhyetdyp5hqum4d5sxgmmvdaezqumfwssxzmt9wsss9un3cx"
```
### Decoding Data
```hs
>>> import Prelude
>>> import Codec.Binary.Bech32
>>> import Data.Text.Encoding
```
First, decode the input:
```hs
>>> input = "example1f3hhyetdyp5hqum4d5sxgmmvdaezqumfwssxzmt9wsss9un3cx"
>>> Right (prefix, dataPart) = decode input
```
Next, examine the decoded human-readable prefix:
```hs
>>> humanReadablePartToText prefix
"example"
```
Finally, examine the decoded data payload:
```hs
>>> decodeUtf8 <$> dataPartToBytes dataPart
Just "Lorem ipsum dolor sit amet!"
```