BaseXX

module
v0.0.0-...-ccad788 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 24, 2023 License: MIT

README

BaseXX

Go modules:           Go Reference Go Report Card

import "github.com/teal-finance/BaseXX/base58"
import "github.com/teal-finance/BaseXX/base62"
import "github.com/teal-finance/BaseXX/base91"
import "github.com/teal-finance/BaseXX/base92"
import "github.com/teal-finance/BaseXX/xascii85"

Characters often used by common BaseXX encodings:

Hexa    0123456789ABCDEF
Base58   123456789ABCDEFGH JKLMN PQRSTUVWXYZabcdefghijk mnopqrstuvwxyz
Base62  0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
Base64  0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/=
Base91  0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/=*-_~.,?!@#$%&()[]{|}<>^:`'
Base92  0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/=*-_~.,?!@#$%&()[]{|}<>^:`'"

Fork of mr-tron/base58

Originally, BaseXX is a fork of https://github.com/mr-tron/base58 adapted to support other bases:

All these packages, except xascii85, support customized encoding alphabet without any performance tradeoff.

The xascii85 package is just a layer on top of "encoding/ascii85" to provide the same API as the other packages.

Common interface

All these packages aim to provide the following API similar of "encoding/ascii85":

func NewEncoding(encoder string) *Encoding

interface Encoding  {
    Decode(dst, src []byte) (n int, err error)
    Encode(dst, src []byte) (n int)
    // Here Encode() returns the number of written bytes.
    // This is different with encoding/base64.
    // The encoded length cannot be known from just
    // the number of bytes to encode, whereas it can with Base64.

    DecodeString(s string) ([]byte, error)
    EncodeToString(src []byte) string

    DecodedLen(n int) int // Returns the Max.
    EncodedLen(n int) int // Returns the Max.

    // Not implemented.
    // Strict() *Encoding
    // WithPadding(padding rune) *Encoding
}

Similar project

BaseXX is similar to SmartGo from Radu Ovidiu Ilies who has adapted https://github.com/akamensky/base58 to support any base encoder: BaseXX has adapted https://github.com/mr-tron/base58 to support other base encoders.

BaseXX shares with SmartGo the ability to quickly create new base encoders, by copying source files and changing few things.

Performance is similar for large input samples, but for short inputs, BaseXX is faster.

To compare short inputs, see the benchmark results. To compare larger specific inputs, see the bench command.

Slower than Base91 by Joachim Henke and Michael Traver

The implementation github.com/mtraver/base91 is much cleaner and faster:

  • Standard Encoding interface
  • 190 times faster encoding
  • 35 times faster decoding

See the benchmark results.

The default encoding alphabets of BaseXX/base58, BaseXX/base62, BaseXX/base91 and BaseXX/base92 conform with the cookie token constraints:

  • characters from 0x20 (space) to 0x7E (tilde ~) included
  • except three characters: double-quote ", semicolon ; and backslash \

The BaseXX/xascii85 encoder do not support these cookie token constraints because it uses three forbidden ASCII characters: double-quote ("), semicolon (;) and backslash (\).

Compliance with Bearer token standard

The RFC 6750 is conservative and recommends to use the following 70 characters:

0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+-./_~

Usage

In the following example replace base92 by base58, base62, base91 (or xascii85).

package main

import "github.com/teal-finance/BaseXX/base92"

func main() {
    // Encode any binary data
    bin := []byte{12, 23, 24, 45, 56, 67, 78, 89}
    str := base92.Encode(bin)

    // Decode back
    bin, err := base92.Decode(str)
    if err != nil {
        panic(err)
    }

    // Use custom alphabet, not applicable for xascii85

    var noSpace = base92.NewEncoding(
        "!#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNO" +
        "PQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~")

    txt := noSpace.EncodeToString(bin)
    bin, err = noSpace.DecodeString(txt)
}

Benchmark

The benchmark shows this BaseXX project is almost faster than the original project on Base58.

goos: linux
goarch: amd64
pkg: github.com/teal-finance/BaseXX/ac/base91
cpu: AMD Ryzen 9 3900X 12-Core Processor
BenchmarkEncode-24           236           5220578 ns/op
BenchmarkDecode-24           222           5695511 ns/op
PASS
ok      github.com/teal-finance/BaseXX/ac/base91        3.600s
goos: linux
goarch: amd64
pkg: github.com/teal-finance/BaseXX/base58
cpu: AMD Ryzen 9 3900X 12-Core Processor
BenchmarkEncode-24                       1000000              1621 ns/op
BenchmarkEncodeMrTronBase58-24            663850              1734 ns/op
BenchmarkDecode-24                       1625545               745.3 ns/op
BenchmarkDecodeMrTronBase58-24           1602920               742.9 ns/op
PASS
ok      github.com/teal-finance/BaseXX/base58   6.733s
goos: linux
goarch: amd64
pkg: github.com/teal-finance/BaseXX/base62
cpu: AMD Ryzen 9 3900X 12-Core Processor
BenchmarkEncode-24       1000000              1255 ns/op
BenchmarkDecode-24       1610145               784.7 ns/op
PASS
ok      github.com/teal-finance/BaseXX/base62   3.302s
goos: linux
goarch: amd64
pkg: github.com/teal-finance/BaseXX/base91
cpu: AMD Ryzen 9 3900X 12-Core Processor
BenchmarkEncoding_Encode-24                         2821            402254 ns/op
BenchmarkEncoding_EncodeToString-24                 2972            411904 ns/op
BenchmarkEncoding_DecodeString-24                  15943             84473 ns/op
BenchmarkBproctorBase91_Decode-24                  39297             29221 ns/op
BenchmarkEquimBase91_Decode-24                    335587              3520 ns/op
BenchmarkMajestrateBase91_Decode-24               357110              3220 ns/op
BenchmarkMtraverBase91_EncodeToString-24          542314              2190 ns/op
BenchmarkMtraverBase91_Encode-24                 1308085               943.3 ns/op
BenchmarkMtraverBase91_DecodeString-24            462540              2426 ns/op
BenchmarkMtraverBase91_Decode-24                 1075700              1063 ns/op
PASS
ok      github.com/teal-finance/BaseXX/base91   14.924s
goos: linux
goarch: amd64
pkg: github.com/teal-finance/BaseXX/base92
cpu: AMD Ryzen 9 3900X 12-Core Processor
BenchmarkEncode-24                        819314              1415 ns/op
BenchmarkEncodeSmartgoBase92-24           153697              8140 ns/op
BenchmarkDecode-24                       1799289               665.9 ns/op
BenchmarkDecodeSmartgoBase92-24           341623              3501 ns/op
PASS
ok      github.com/teal-finance/BaseXX/base92   6.616s
PASS
ok      github.com/teal-finance/BaseXX/xascii85 0.003s

Can be much faster

Performance can be much much improved. Using the tips of https://github.com/mtraver/base91 (original work from Joachim Henke), this BaseXX repo may become 200 times faster on the encoding, and 30 times faster on the decoding.

✨ Contributions Welcome

This new project needs your help to become better. Please propose your enhancements, or even a further refactoring.

We welcome contributions in many forms, and there's always plenty to do!

🗣️ Feedback

If you have some suggestions, or need a new feature, please contact us, using the issue tracking, or at [email protected] or @TealFinance.

Feel free to propose a Pull Request, your contributions are welcome. 😉

Copyright (c) 2022 Teal.Finance contributors

Teal.Finance/BaseXX is free software, and can be redistributed and/or modified under the terms of the MIT License. SPDX-License-Identifier: MIT

Teal.Finance/BaseXX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the LICENSE file (alongside the source files) or https://opensource.org/licenses/MIT.

See also

See similar other projects.

BaseN collection by Radu Ovidiu Ilies

The repo https://github.com/unix-world/smartgo proposes many bases.

See the section Similar project.

Base91 by Joachim Henke and Michael Traver

The repo https://github.com/mtraver/base91 is the cleanest and fastest Base91 Go-implementation of all the Base91 benched by this BaseXX project.

Michael Traver has ported to Go the excellent work from Joachim Henke.

Base91 by Majestrate

Good Base91 implementation at https://github.com/majestrate/base91.

No bugs found while benching it.

Base91 by Equim

Good Base91 implementation at https://github.com/Equim-chan/base91-go.

No bugs found while benching it.

Base91 by Brad Proctor

The repo https://github.com/bproctor/base91 is a slow Base91 implementation. Still faster than BaseXX/Base91.

No bugs found while benching it.

Base91 by Antonino Catinello

The implementation by Antonino Catinello contains bugs. Moreover, this Base91 implementation does not accept customized encoding alphabet.

This repo contains a fork (almost unmodified) of https://codeberg.org/ac/base91. The latter cannot be used because the module name "catinello.eu/base91" is not reachable (tested in May 2022).

Base91 by Chris Snell and Breeze Chen

The repo https://github.com/breezechen/base91 is an unmaintained and buggy Base91 implementation.

Directories

Path Synopsis
ac
base91
Based on http://base91.sourceforge.net/
 Based on http://base91.sourceforge.net/
base91/cmd/base91
Command line tool to de-/encode base91.
 Command line tool to de-/encode base91.
Package base58 is a pretty good Base58 encoder with customizable encoding alphabet.
 Package base58 is a pretty good Base58 encoder with customizable encoding alphabet.
Package base62 is a pretty good Base62 encoder with customizable encoding alphabet.
 Package base62 is a pretty good Base62 encoder with customizable encoding alphabet.
Package base91 is a pretty good Base91 encoder with customizable encoding alphabet.
 Package base91 is a pretty good Base91 encoder with customizable encoding alphabet.
Package base92 is a pretty good Base92 encoder with customizable encoding alphabet.
 Package base92 is a pretty good Base92 encoder with customizable encoding alphabet.
Package encoding provides common functions for all BaseXX implementations.
 Package encoding provides common functions for all BaseXX implementations.
examples
bench
Usage
 Usage
Package xascii85 implements the standard Encoding interface on top of "encoding/ascii85".
 Package xascii85 implements the standard Encoding interface on top of "encoding/ascii85".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.