radix

README

Radix (Base) Conversion

Sequence of integers (byte, int) can be represent big number in positional numeral system with specified radix.

This project's functions convert input sequence from one radix to output sequence with other radix. Also encode/decode these sequences with specified alphabet.

Aim of this project to implement universal radix converter. But implementation of []byte input conversion using big.Int is more efficient than universtal implementation of []int input conversion. Check benchmarks into convert_test.go.

Base58 encoding (used by Bitcoin and others) builds on this conversion of big number from base 256 to base 58.

Examples

package main

import (
	"fmt"
	"log"
	
	"github.com/bergusman/radix-go"
)

func main() {
	out, err := radix.Convert([]int{1, 3, 3, 7}, 10, 16)
	if err != nil {
		log.Fatal(err)
	}

	str, err := radix.Encode(out, "0123456789ABCDEF")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(str) // Output: 539

	out, err = radix.Convert([]int{1, 3, 3, 7}, 10, 5)
	if err != nil {
		log.Fatal(err)
	}

	str, err = radix.Encode(out, "🌑🌘🌗🌖🌕")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(str) // Output: 🌗🌑🌖🌗🌗
}

Base58

package main

import (
	"encoding/hex"
	"fmt"
	"log"

	"github.com/bergusman/radix-go"
)

func main() {
	addr, err := hex.DecodeString("8aee40b8e87eb05bc3b9ff902349bb2dd19a5e90")
	if err != nil {
		log.Fatal(err)
	}

	str, err := radix.Base58Encode(addr, radix.AlphabetBitcoin)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(str) // Output: 2wG9ewuHafzR4yG2hYu8U3YmpZxb
}

Can check here: http://lenschulwitz.com/base58

Documentation

Overview

Package radix implements radix conversions for integer sequences ([]byte or []int) and their encoding/deconding to string by specified alphabet.

Example

out, err := radix.Convert([]int{1, 3, 3, 7}, 10, 16)
if err != nil {
	log.Fatal(err)
}

str, err := radix.Encode(out, "0123456789ABCDEF")
if err != nil {
	log.Fatal(err)
}

fmt.Println(str)

Output:

539

Example (Bitcoin)

addr := []byte{138, 238, 64, 184, 232, 126, 176, 91, 195, 185, 255, 144, 35, 73, 187, 45, 209, 154, 94, 144}
str, err := radix.Base58Encode(addr, radix.AlphabetBitcoin)
if err != nil {
	log.Fatal(err)
}

fmt.Println(str)

Output:

2wG9ewuHafzR4yG2hYu8U3YmpZxb

Example (Emoji)

out, err := radix.Convert([]int{1, 3, 3, 7}, 10, 5)
if err != nil {
	log.Fatal(err)
}

str, err := radix.Encode(out, "🌑🌘🌗🌖🌕")
if err != nil {
	log.Fatal(err)
}

fmt.Println(str)

Output:

🌗🌑🌖🌗🌗

Index

• Constants
• Variables
• func Base58Decode(input string, alphabet string) ([]byte, error)
• func Base58Encode(input []byte, alphabet string) (string, error)
• func Convert(in []int, inrx int, outrx int) (out []int, err error)
• func ConvertBytes(in []byte, outrx int) (out []byte, err error)
• func Decode(input string, alphabet string) (output []int, err error)
• func DecodeBytes(input string, alphabet string) (output []byte, err error)
• func Encode(input []int, alphabet string) (output string, err error)
• func EncodeBytes(input []byte, alphabet string) (output string, err error)

Examples

• Package
• Package (Bitcoin)
• Package (Emoji)
• Convert
• Encode

Constants

const AlphabetBitcoin = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"

const AlphabetFlickr = "123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"

const AlphabetRipple = "rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz"

Variables

var ErrBase58BadAlphabet = errors.New("base58: alphabet length less than 58")

Functions

func Base58Decode

func Base58Decode(input string, alphabet string) ([]byte, error)

func Base58Encode

func Base58Encode(input []byte, alphabet string) (string, error)

func Convert

func Convert(in []int, inrx int, outrx int) (out []int, err error)

Convert converts input (int) with radix (inrx) to ouput (out) with radix (outrx).

Example

out, err := radix.Convert([]int{1, 3, 3, 7}, 10, 2)
if err != nil {
	log.Fatal(err)
}

fmt.Println(out)

Output:

[1 0 1 0 0 1 1 1 0 0 1]

func ConvertBytes

func ConvertBytes(in []byte, outrx int) (out []byte, err error)

ConvertBytes converts input bytes (in) with 256 radix to output bytes (out) with radix (outrx).

func Decode

func Decode(input string, alphabet string) (output []int, err error)

Decode decodes input string by alphabet.

func DecodeBytes

func DecodeBytes(input string, alphabet string) (output []byte, err error)

DecodeBytes decodes input string by alphabet to bytes output.

func Encode

func Encode(input []int, alphabet string) (output string, err error)

Encode encodes input to string with alphabet.

Example

out, err := radix.Convert([]int{1, 3, 3, 7}, 10, 2)
if err != nil {
	log.Fatal(err)
}

str, err := radix.Encode(out, "01")
if err != nil {
	log.Fatal(err)
}

fmt.Println(str)

Output:

10100111001

func EncodeBytes

func EncodeBytes(input []byte, alphabet string) (output string, err error)

EncodeBytes encodes bytes input to string with alphabet.