basesystems: Implements encoders/decoders for basesystems

[ bsd3, data, library, numeric, serialization ] [ Propose Tags ] [ Report a vulnerability ]

This package implements encoder and decoder methods for numeric basesystems and provides definitions for common basesystems like base16, base58btc, base64, and more.

[Skip to Readme]

Modules

[Index] [Quick Jump]

Data
- Data.BaseSystem
- Data.BaseSystems

Flags

Manual Flags

Name	Description	Default
ci	CI Build options	Disabled
dev	Developer build options	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

basesystems-1.0.0.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	1.0.0.0, 1.0.0.1
Change log	CHANGE_LOG.md
Dependencies	array (>=0.5 && <0.6), base (>=4.18 && <5), bytestring (>=0.11 && <0.12), containers (>=0.6 && <0.7), text (>=2.0 && <2.1) [details]
License	BSD-3-Clause
Author	Zoey McBride
Maintainer	zoeymcbride@mailbox.org
Uploaded	by z0 at 2026-04-01T21:34:06Z
Category	Numeric, Data, Serialization
Source repo	head: git clone https://git.sr.ht/~z0/basesystems
Distributions
Reverse Dependencies	1 direct, 0 indirect [details]
Downloads	14 total (10 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs uploaded by user Build status unknown [no reports yet]

Readme for basesystems-1.0.0.1

[back to package description]

basesystems

This project code contains for Encoding/Decoding number basesystems in Haskell. It's implemented in a strategy pattern style where BaseSystem is a type-class which provides the encoder and decoder methods:

class BaseSystem a where
  encoder :: a -> ByteString -> String
  decoder :: a -> String -> Maybe ByteString

Then we define data structure representations for a and implement each method with the data from a. For instance, this is how the implementations of base64 and base10 are distinguished.

Example

ghci> import Data.BaseSystem
ghci> import Data.BaseSystems
ghci> import Data.BaseSystem.Internal (packInteger)
ghci>
ghci> encoder base10 (packInteger 123) -- "123"
ghci> decoder base10 "123"             -- Just <123 as binary in ByteString>
ghci> encoder base64 (packInteger 123) -- "ew=="
ghci> decoder base64 "ew=="            -- Just <123 as binary in ByteString>

Coverage

This project aims to eventually implement most if not all of the mulitbase specification's basesytems list.

Currently, the following basesystems are supported:

base2
base10
base16(upper/lower)
base32(upper/lower) w/pad + nopad
base32hex(lower/upper) w/pad + nopad
base58btc
base64 w/pad + nopad
base64url w/pad + nopad

Unit testing

Since these functions can have such a large amount of inputs/outputs + possible edge cases, we generate test sets in bulk from scripts in the python folder to JSON format. Code for running tests can be found at the main ipfshs repo.

Reporting bugs

Bugs can be reported to the ipfshs ticket tracker.

License

This project is free software and is provided under the BSD 3-clause licensing agreement.