CrossClj

1.0.0 docs

SourceDocs



RECENT

    mvxcvi/alphabase

    Clojars

    Nov 4, 2017


    OWNER
    Greg Look
    @amperity
    Seattle, WA
    greglook.net/

    Readme

    Index of all namespaces


    « Project + dependencies

    Clojure(script) library to encode binary data with alphabet base strings.

    alphabase.base58DocsSource
    Base58-check encoding implementation.
    
    alphabase.coreDocsSource
    Core encoding and decoding functions for use with arbitrary bases.
    
    alphabase.hexDocsSource
    Functions to encode and decode bytes as hexadecimal.
    
    The README below is fetched from the published project artifact. Some relative links may be broken.

    alphabase

    CircleCI API codox

    A simple cross-compiled Clojure(Script) library to handle encoding binary data in different bases using defined alphabets. If you’ve ever wanted a simple way to encode a byte array as hexadecimal or base58, this library is for you!

    Installation

    Library releases are published on Clojars. To use the latest version with Leiningen, add the following dependency to your project definition:

    Clojars Project

    Usage

    • alphabase.bytes namespace for generic byte-array handling
    • alphabase.core with arbitrary alphabet support
    • alphabase.hex and alphabase.base58 with convenience wrappers
    • alphabase.multi provides a multibase implementation

    Testing

    The unit tests can be run using the following commands:

    # Clojure tests
    lein test
    
    # ClojureScript tests on PhantomJS
    lein doo phantom test
    

    For a REPL, you can use these:

    # Clojure REPL
    lein repl
    
    # ClojureScript REPL on NodeJS
    rlwrap lein cljs-repl
    

    License

    This is free and unencumbered software released into the public domain. See the UNLICENSE file for more information.