https://github.com/ppad-tech/bech32
(mirror of https://git.ppad.tech/bech32)
https://github.com/ppad-tech/bech32
Last synced: about 1 year ago
JSON representation
(mirror of https://git.ppad.tech/bech32)
- Host: GitHub
- URL: https://github.com/ppad-tech/bech32
- Owner: ppad-tech
- License: mit
- Created: 2024-12-13T14:31:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-28T05:40:00.000Z (over 1 year ago)
- Last Synced: 2025-02-28T12:47:52.995Z (over 1 year ago)
- Language: Haskell
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# bech32
[](https://hackage.haskell.org/package/ppad-bech32)
[](https://docs.ppad.tech/bech32)
A pure Haskell implementation of bech32m and bech32 encoding/decoding on
strict ByteStrings, as specified by [BIP350][bi350] and [BIP173][bi173].
## Usage
A sample GHCi session:
```
> :set -XOverloadedStrings
>
> -- import qualified
> import qualified Data.ByteString.Bech32m as Bech32m
>
> -- create a bech32m-encoded string using a human-readable part (HRP)
> -- and some input
> let Just bech32m = Bech32m.encode "bc" "a standard word8 bytestring"
> bech32m
"bc1vys8xarpdejxzunyypmk7uny8qsxy7t5v4ehgunfdenswyuz0e"
>
> -- verify that a bech32m string has a valid checksum
> Bech32m.verify bech32
True
>
> -- tweaked stuff will obviously fail to verify (s/m/w below)
> Bech32m.verify "bc1vys8xarpdejxzunyypwk7uny8qsxy7t5v4ehgunfdenswyuz0e"
False
>
> -- decode bech32m-encoded input
> Bech32m.decode bech32m
Just ("bc","a standard word8 bytestring")
```
## Documentation
Haddocks (API documentation, etc.) are hosted at
[docs.ppad.tech/bech32](https://docs.ppad.tech/bech32).
## Performance
The aim is best-in-class performance for pure, highly-auditable Haskell
code. At present we're a little over twice as fast as the official
BIP173 reference implementation.
Current benchmark figures on a relatively-beefy NixOS VPS look like (use
`cabal bench` to run the benchmark suite):
```
benchmarking benchmarks/ppad-bech32/bech32 encode/120b
time 1.126 μs (1.115 μs .. 1.136 μs)
0.999 R² (0.999 R² .. 1.000 R²)
mean 1.132 μs (1.125 μs .. 1.140 μs)
std dev 26.29 ns (21.47 ns .. 31.93 ns)
variance introduced by outliers: 29% (moderately inflated)
benchmarking benchmarks/ppad-bech32/bech32 decode/120b
time 1.293 μs (1.281 μs .. 1.308 μs)
0.999 R² (0.999 R² .. 1.000 R²)
mean 1.280 μs (1.274 μs .. 1.290 μs)
std dev 24.47 ns (18.39 ns .. 33.71 ns)
variance introduced by outliers: 21% (moderately inflated)
benchmarking benchmarks/reference/bech32 encode/120b
time 2.897 μs (2.865 μs .. 2.920 μs)
0.999 R² (0.999 R² .. 1.000 R²)
mean 2.828 μs (2.806 μs .. 2.856 μs)
std dev 81.33 ns (70.94 ns .. 97.46 ns)
variance introduced by outliers: 36% (moderately inflated)
```
## Security
This library aims at the maximum security achievable in a
garbage-collected language under an optimizing compiler such as GHC, in
which strict constant-timeness can be challenging to achieve.
If you discover any vulnerabilities, please disclose them via
security@ppad.tech.
## Development
You'll require [Nix][nixos] with [flake][flake] support enabled. Enter a
development shell with:
```
$ nix develop
```
Then do e.g.:
```
$ cabal repl ppad-bech32
```
to get a REPL for the main library.
## Attribution
The base32 implementation used internally is more or less a pure
translation of the [base32][bas32] package on Hackage.
[nixos]: https://nixos.org/
[flake]: https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html
[bi173]: https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
[bi350]: https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki
[bas32]: https://hackage.haskell.org/package/base32