README.md (3348B)
1 # base58 2 3 [](https://hackage.haskell.org/package/ppad-base58) 4  5 [](https://docs.ppad.tech/base58) 6 7 A pure Haskell implementation of base58 and base58check encoding & 8 decoding on strict ByteStrings. 9 10 ## Usage 11 12 A sample GHCi session: 13 14 ``` 15 > :set -XOverloadedStrings 16 > 17 > -- import qualified 18 > import qualified Data.ByteString.Base58 as B58 19 > import qualified Data.ByteString.Base58Check as B58Check 20 > 21 > -- simple base58 encoding and decoding 22 > let b58 = B58.encode "hello world" 23 > b58 24 "StV1DL6CwTryKyV" 25 > 26 > B58.decode b58 27 Just "hello world" 28 > 29 > -- base58check is a versioned, checksummed format 30 > let b58check = B58Check.encode "\NULhello world" -- 0x00 version byte 31 > b58check 32 "13vQB7B6MrGQZaxCqW9KER" 33 > 34 > B58Check.decode b58check 35 Just "\NULhello world" 36 ``` 37 38 ## Documentation 39 40 Haddocks (API documentation, etc.) are hosted at 41 [docs.ppad.tech/base58](https://docs.ppad.tech/base58). 42 43 ## Performance 44 45 The aim is best-in-class performance for pure, highly-auditable Haskell 46 code. 47 48 Current benchmark figures on a M4 Silicon MacBook Air look like (use 49 `cabal bench` to run the benchmark suite): 50 51 ``` 52 benchmarking ppad-base58/base58/encode/hello world 53 time 350.2 ns (349.9 ns .. 350.6 ns) 54 1.000 R² (1.000 R² .. 1.000 R²) 55 mean 350.9 ns (350.6 ns .. 351.3 ns) 56 std dev 1.096 ns (785.7 ps .. 1.603 ns) 57 58 benchmarking ppad-base58/base58/decode/StV1DL6CwTryKyV 59 time 359.5 ns (358.7 ns .. 360.8 ns) 60 1.000 R² (1.000 R² .. 1.000 R²) 61 mean 362.1 ns (361.3 ns .. 362.8 ns) 62 std dev 2.779 ns (2.415 ns .. 3.261 ns) 63 64 benchmarking ppad-base58/base58check/encode/0x00, hello world 65 time 658.6 ns (657.9 ns .. 659.7 ns) 66 1.000 R² (1.000 R² .. 1.000 R²) 67 mean 660.4 ns (659.6 ns .. 661.6 ns) 68 std dev 3.131 ns (2.370 ns .. 5.060 ns) 69 70 benchmarking ppad-base58/base58check/decode/13vQB7B6MrGQZaxCqW9KER 71 time 698.6 ns (698.0 ns .. 699.3 ns) 72 1.000 R² (1.000 R² .. 1.000 R²) 73 mean 700.2 ns (699.6 ns .. 701.0 ns) 74 std dev 2.325 ns (1.943 ns .. 2.759 ns) 75 ``` 76 77 You should build with the 'llvm' flag for maximum performance. 78 79 ## Security 80 81 This library aims at the maximum security achievable in a 82 garbage-collected language under an optimizing compiler such as GHC, in 83 which strict constant-timeness can be challenging to achieve. 84 85 If you discover any vulnerabilities, please disclose them via 86 security@ppad.tech. 87 88 ## Development 89 90 You'll require [Nix][nixos] with [flake][flake] support enabled. Enter a 91 development shell with: 92 93 ``` 94 $ nix develop 95 ``` 96 97 Then do e.g.: 98 99 ``` 100 $ cabal repl ppad-base58 101 ``` 102 103 to get a REPL for the main library. 104 105 ## Attribution 106 107 The vectors used in the test suite for both base58 108 and base58check are verbatim from paulmillr's 109 [scure-base](https://github.com/paulmillr/scure-base) library. 110 111 [nixos]: https://nixos.org/ 112 [flake]: https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html