add new multibase binary

.github/workflows/generated-pr.yml

@@ -1,14 +0,0 @@
-name: Close Generated PRs
-
-on:
-  schedule:
-    - cron: '0 0 * * *'
-  workflow_dispatch:
-
-permissions:
-  issues: write
-  pull-requests: write
-
-jobs:
-  stale:
-    uses: ipdxco/unified-github-workflows/.github/workflows/reusable-generated-pr.yml@v1

.github/workflows/go-check.yml

@@ -1,18 +0,0 @@
-name: Go Checks
-
-on:
-  pull_request:
-  push:
-    branches: ["master"]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  go-check:
-    uses: ipdxco/unified-github-workflows/.github/workflows/go-check.yml@v1.0

.github/workflows/go-test.yml

@@ -1,20 +0,0 @@
-name: Go Test
-
-on:
-  pull_request:
-  push:
-    branches: ["master"]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  go-test:
-    uses: ipdxco/unified-github-workflows/.github/workflows/go-test.yml@v1.0
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release-check.yml

@@ -1,19 +0,0 @@
-name: Release Checker
-
-on:
-  pull_request_target:
-    paths: [ 'version.json' ]
-    types: [ opened, synchronize, reopened, labeled, unlabeled ]
-  workflow_dispatch:
-
-permissions:
-  contents: write
-  pull-requests: write
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  release-check:
-    uses: ipdxco/unified-github-workflows/.github/workflows/release-check.yml@v1.0

.github/workflows/releaser.yml

@@ -1,17 +0,0 @@
-name: Releaser
-
-on:
-  push:
-    paths: [ 'version.json' ]
-  workflow_dispatch:
-
-permissions:
-  contents: write
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.sha }}
-  cancel-in-progress: true
-
-jobs:
-  releaser:
-    uses: ipdxco/unified-github-workflows/.github/workflows/releaser.yml@v1.0

.github/workflows/stale.yml

@@ -1,14 +0,0 @@
-name: Close Stale Issues
-
-on:
-  schedule:
-    - cron: '0 0 * * *'
-  workflow_dispatch:
-
-permissions:
-  issues: write
-  pull-requests: write
-
-jobs:
-  stale:
-    uses: ipdxco/unified-github-workflows/.github/workflows/reusable-stale-issue.yml@v1

.github/workflows/tagpush.yml

@@ -1,18 +0,0 @@
-name: Tag Push Checker
-
-on:
-  push:
-    tags:
-      - v*
-
-permissions:
-  contents: read
-  issues: write
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  releaser:
-    uses: ipdxco/unified-github-workflows/.github/workflows/tagpush.yml@v1.0

.travis.yml

@@ -0,0 +1,31 @@
+os:
+  - linux
+
+language: go
+
+go:
+  - 1.11.x
+  - 1.15.x
+
+env:
+  global:
+    - GOTFLAGS="-race"
+  matrix:
+    - BUILD_DEPTYPE=gomod
+
+
+# disable travis install
+install:
+  - true
+
+script:
+  - bash <(curl -s https://raw.githubusercontent.com/ipfs/ci-helpers/master/travis-ci/run-standard-tests.sh)
+
+
+cache:
+  directories:
+    - $GOPATH/pkg/mod
+    - /home/travis/.cache/go-build
+
+notifications:
+  email: false

base256emoji.go

@@ -1,95 +0,0 @@
-package multibase
-
-import (
-	"strconv"
-	"strings"
-	"unicode/utf8"
-)
-
-var base256emojiTable = [256]rune{
-	// Curated list, this is just a list of things that *somwhat* are related to our comunity
-	'🚀', '🪐', '☄', '🛰', '🌌', // Space
-	'🌑', '🌒', '🌓', '🌔', '🌕', '🌖', '🌗', '🌘', // Moon
-	'🌍', '🌏', '🌎', // Our Home, for now (earth)
-	'🐉',                // Dragon!!!
-	'☀',                // Our Garden, for now (sol)
-	'💻', '🖥', '💾', '💿', // Computer
-	// The rest is completed from https://home.unicode.org/emoji/emoji-frequency/ at the time of creation (december 2021) (the data is from 2019), most used first until we reach 256.
-	// We exclude modifier based emojies (such as flags) as they are bigger than one single codepoint.
-	// Some other emojies were removed adhoc for various reasons.
-	'😂', '❤', '😍', '🤣', '😊', '🙏', '💕', '😭', '😘', '👍',
-	'😅', '👏', '😁', '🔥', '🥰', '💔', '💖', '💙', '😢', '🤔',
-	'😆', '🙄', '💪', '😉', '☺', '👌', '🤗', '💜', '😔', '😎',
-	'😇', '🌹', '🤦', '🎉', '💞', '✌', '✨', '🤷', '😱', '😌',
-	'🌸', '🙌', '😋', '💗', '💚', '😏', '💛', '🙂', '💓', '🤩',
-	'😄', '😀', '🖤', '😃', '💯', '🙈', '👇', '🎶', '😒', '🤭',
-	'❣', '😜', '💋', '👀', '😪', '😑', '💥', '🙋', '😞', '😩',
-	'😡', '🤪', '👊', '🥳', '😥', '🤤', '👉', '💃', '😳', '✋',
-	'😚', '😝', '😴', '🌟', '😬', '🙃', '🍀', '🌷', '😻', '😓',
-	'⭐', '✅', '🥺', '🌈', '😈', '🤘', '💦', '✔', '😣', '🏃',
-	'💐', '☹', '🎊', '💘', '😠', '☝', '😕', '🌺', '🎂', '🌻',
-	'😐', '🖕', '💝', '🙊', '😹', '🗣', '💫', '💀', '👑', '🎵',
-	'🤞', '😛', '🔴', '😤', '🌼', '😫', '⚽', '🤙', '☕', '🏆',
-	'🤫', '👈', '😮', '🙆', '🍻', '🍃', '🐶', '💁', '😲', '🌿',
-	'🧡', '🎁', '⚡', '🌞', '🎈', '❌', '✊', '👋', '😰', '🤨',
-	'😶', '🤝', '🚶', '💰', '🍓', '💢', '🤟', '🙁', '🚨', '💨',
-	'🤬', '✈', '🎀', '🍺', '🤓', '😙', '💟', '🌱', '😖', '👶',
-	'🥴', '▶', '➡', '❓', '💎', '💸', '⬇', '😨', '🌚', '🦋',
-	'😷', '🕺', '⚠', '🙅', '😟', '😵', '👎', '🤲', '🤠', '🤧',
-	'📌', '🔵', '💅', '🧐', '🐾', '🍒', '😗', '🤑', '🌊', '🤯',
-	'🐷', '☎', '💧', '😯', '💆', '👆', '🎤', '🙇', '🍑', '❄',
-	'🌴', '💣', '🐸', '💌', '📍', '🥀', '🤢', '👅', '💡', '💩',
-	'👐', '📸', '👻', '🤐', '🤮', '🎼', '🥵', '🚩', '🍎', '🍊',
-	'👼', '💍', '📣', '🥂',
-}
-
-var base256emojiReverseTable map[rune]byte
-
-func init() {
-	base256emojiReverseTable = make(map[rune]byte, len(base256emojiTable))
-	for i, v := range base256emojiTable {
-		base256emojiReverseTable[v] = byte(i)
-	}
-}
-
-func base256emojiEncode(in []byte) string {
-	var l int
-	for _, v := range in {
-		l += utf8.RuneLen(base256emojiTable[v])
-	}
-	var out strings.Builder
-	out.Grow(l)
-	for _, v := range in {
-		out.WriteRune(base256emojiTable[v])
-	}
-	return out.String()
-}
-
-type base256emojiCorruptInputError struct {
-	index int
-	char  rune
-}
-
-func (e base256emojiCorruptInputError) Error() string {
-	return "illegal base256emoji data at input byte " + strconv.FormatInt(int64(e.index), 10) + ", char: '" + string(e.char) + "'"
-}
-
-func (e base256emojiCorruptInputError) String() string {
-	return e.Error()
-}
-
-func base256emojiDecode(in string) ([]byte, error) {
-	out := make([]byte, utf8.RuneCountInString(in))
-	var stri int
-	for i := 0; len(in) > 0; i++ {
-		r, n := utf8.DecodeRuneInString(in)
-		in = in[n:]
-		var ok bool
-		out[i], ok = base256emojiReverseTable[r]
-		if !ok {
-			return nil, base256emojiCorruptInputError{stri, r}
-		}
-		stri += n
-	}
-	return out, nil
-}

base256emoji_test.go

@@ -1,26 +0,0 @@
-package multibase
-
-import "testing"
-
-func TestBase256EmojiAlphabet(t *testing.T) {
-	var c uint
-	for _, v := range base256emojiTable {
-		if v != rune(0) {
-			c++
-		}
-	}
-	if c != 256 {
-		t.Errorf("Base256Emoji count is wrong, expected 256, got %d.", c)
-	}
-}
-
-func TestBase256EmojiUniq(t *testing.T) {
-	m := make(map[rune]struct{}, len(base256emojiTable))
-	for i, v := range base256emojiTable {
-		_, ok := m[v]
-		if ok {
-			t.Errorf("Base256Emoji duplicate %s at index %d.", string(v), i)
-		}
-		m[v] = struct{}{}
-	}
-}

encoder.go

@@ -2,7 +2,6 @@ package multibase
 
 import (
 	"fmt"
-	"unicode/utf8"
 )
 
 // Encoder is a multibase encoding that is verified to be supported and
@@ -15,7 +14,7 @@ type Encoder struct {
 func NewEncoder(base Encoding) (Encoder, error) {
 	_, ok := EncodingToStr[base]
 	if !ok {
-		return Encoder{-1}, fmt.Errorf("unsupported multibase encoding: %d", base)
+		return Encoder{-1}, fmt.Errorf("Unsupported multibase encoding: %d", base)
 	}
 	return Encoder{base}, nil
 }
@@ -34,18 +33,17 @@ func MustNewEncoder(base Encoding) Encoder {
 // either be the multibase name or single character multibase prefix
 func EncoderByName(str string) (Encoder, error) {
 	var base Encoding
-	var ok bool
+	ok := true
 	if len(str) == 0 {
-		return Encoder{-1}, fmt.Errorf("empty multibase encoding")
+		return Encoder{-1}, fmt.Errorf("Empty multibase encoding")
-	} else if utf8.RuneCountInString(str) == 1 {
+	} else if len(str) == 1 {
-		r, _ := utf8.DecodeRuneInString(str)
+		base = Encoding(str[0])
-		base = Encoding(r)
 		_, ok = EncodingToStr[base]
 	} else {
 		base, ok = Encodings[str]
 	}
 	if !ok {
-		return Encoder{-1}, fmt.Errorf("unsupported multibase encoding: %s", str)
+		return Encoder{-1}, fmt.Errorf("Unsupported multibase encoding: %s", str)
 	}
 	return Encoder{base}, nil
 }

encoder_test.go

@@ -2,7 +2,6 @@ package multibase
 
 import (
 	"testing"
-	"unicode/utf8"
 )
 
 func TestInvalidCode(t *testing.T) {
@@ -44,10 +43,9 @@ func TestEncoder(t *testing.T) {
 		}
 		// Test that an encoder can be created from the single letter
 		// prefix
-		r, _ := utf8.DecodeRuneInString(str)
+		_, err = EncoderByName(str[0:1])
-		_, err = EncoderByName(string(r))
 		if err != nil {
-			t.Fatalf("EncoderByName(%s) failed: %v", string(r), err)
+			t.Fatalf("EncoderByName(%s) failed: %v", str[0:1], err)
 		}
 	}
 }

go.mod

@@ -1,9 +1,10 @@
 module github.com/multiformats/go-multibase
 
-go 1.24
+go 1.11
 
 require (
 	github.com/mr-tron/base58 v1.1.0
 	github.com/multiformats/go-base32 v0.0.3
 	github.com/multiformats/go-base36 v0.1.0
+	github.com/urfave/cli/v2 v2.3.0
 )

go.sum

@@ -1,6 +1,19 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/mr-tron/base58 v1.1.0 h1:Y51FGVJ91WBqCEabAi5OPUz38eAx8DakuAm5svLcsfQ=
 github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8=
 github.com/multiformats/go-base32 v0.0.3 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI=
 github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA=
 github.com/multiformats/go-base36 v0.1.0 h1:JR6TyF7JjGd3m6FbLU2cOxhC0Li8z8dLNGQ89tUg4F4=
 github.com/multiformats/go-base36 v0.1.0/go.mod h1:kFGE83c6s80PklsHO9sRn2NCoffoRdUUOENyW/Vv6sM=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
+github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M=
+github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

multibase.go

@@ -4,7 +4,6 @@ import (
 	"encoding/base64"
 	"encoding/hex"
 	"fmt"
-	"unicode/utf8"
 
 	b58 "github.com/mr-tron/base58/base58"
 	b32 "github.com/multiformats/go-base32"
@@ -39,33 +38,31 @@ const (
 	Base64url         = 'u'
 	Base64pad         = 'M'
 	Base64urlPad      = 'U'
-	Base256Emoji      = '🚀'
 )
 
 // EncodingToStr is a map of the supported encoding, unsupported encoding
 // specified in standard are left out
 var EncodingToStr = map[Encoding]string{
-	0x00:         "identity",
+	0x00: "identity",
-	'0':          "base2",
+	'0':  "base2",
-	'f':          "base16",
+	'f':  "base16",
-	'F':          "base16upper",
+	'F':  "base16upper",
-	'b':          "base32",
+	'b':  "base32",
-	'B':          "base32upper",
+	'B':  "base32upper",
-	'c':          "base32pad",
+	'c':  "base32pad",
-	'C':          "base32padupper",
+	'C':  "base32padupper",
-	'v':          "base32hex",
+	'v':  "base32hex",
-	'V':          "base32hexupper",
+	'V':  "base32hexupper",
-	't':          "base32hexpad",
+	't':  "base32hexpad",
-	'T':          "base32hexpadupper",
+	'T':  "base32hexpadupper",
-	'k':          "base36",
+	'k':  "base36",
-	'K':          "base36upper",
+	'K':  "base36upper",
-	'z':          "base58btc",
+	'z':  "base58btc",
-	'Z':          "base58flickr",
+	'Z':  "base58flickr",
-	'm':          "base64",
+	'm':  "base64",
-	'u':          "base64url",
+	'u':  "base64url",
-	'M':          "base64pad",
+	'M':  "base64pad",
-	'U':          "base64urlpad",
+	'U':  "base64urlpad",
-	Base256Emoji: "base256emoji",
 }
 
 var Encodings = map[string]Encoding{}
@@ -126,8 +123,6 @@ func Encode(base Encoding, data []byte) (string, error) {
 		return string(Base64url) + base64.RawURLEncoding.EncodeToString(data), nil
 	case Base64:
 		return string(Base64) + base64.RawStdEncoding.EncodeToString(data), nil
-	case Base256Emoji:
-		return string(Base256Emoji) + base256emojiEncode(data), nil
 	default:
 		return "", ErrUnsupportedEncoding
 	}
@@ -140,8 +135,7 @@ func Decode(data string) (Encoding, []byte, error) {
 		return 0, nil, fmt.Errorf("cannot decode multibase for zero length string")
 	}
 
-	r, _ := utf8.DecodeRuneInString(data)
+	enc := Encoding(data[0])
-	enc := Encoding(r)
 
 	switch enc {
 	case Identity:
@@ -185,9 +179,6 @@ func Decode(data string) (Encoding, []byte, error) {
 	case Base64url:
 		bytes, err := base64.RawURLEncoding.DecodeString(data[1:])
 		return Base64url, bytes, err
-	case Base256Emoji:
-		bytes, err := base256emojiDecode(data[4:])
-		return Base256Emoji, bytes, err
 	default:
 		return -1, nil, ErrUnsupportedEncoding
 	}

multibase/main.go

@@ -0,0 +1,115 @@
+package main
+
+import (
+	"fmt"
+	"github.com/multiformats/go-multibase"
+	"io/ioutil"
+	"os"
+
+	"github.com/urfave/cli/v2"
+)
+
+func main() {
+	app := &cli.App{
+		Name:  "multibase",
+		Usage: "base encoding and transcoding tool",
+		Commands: []*cli.Command{
+			{
+				Name:      "encode",
+				ArgsUsage: "<base>",
+				Usage:     "encode data in multibase",
+				Flags: []cli.Flag{
+					&cli.PathFlag{
+						Name:    "input",
+						Aliases: []string{"i"},
+						Usage:   "the file that should be encoded",
+					},
+				},
+				Action: func(context *cli.Context) error {
+					if !context.Args().Present() || context.NArg() > 2 {
+						return cli.ShowCommandHelp(context, "")
+					}
+
+					p := context.Path("input")
+					if (p == "" && context.NArg() != 2) || (p != "" && context.NArg() != 1) {
+						return cli.ShowCommandHelp(context, "")
+					}
+
+					base, err := multibase.EncoderByName(context.Args().First())
+					if err != nil {
+						return err
+					}
+
+					if p != "" {
+						fileData, err := ioutil.ReadFile(p)
+						if err != nil {
+							return err
+						}
+						fmt.Println(base.Encode(fileData))
+						return nil
+					}
+
+					fmt.Println(base.Encode([]byte(context.Args().Get(1))))
+					return nil
+				},
+			},
+			{
+				Name:      "decode",
+				ArgsUsage: "<data>",
+				Usage:     "encode data in multibase",
+				Flags: []cli.Flag{
+					&cli.PathFlag{
+						Name:    "output",
+						Aliases: []string{"o"},
+						Usage:   "output decoded data to a file",
+					},
+				},
+				Action: func(context *cli.Context) error {
+					if context.NArg() != 1 {
+						return cli.ShowCommandHelp(context, "")
+					}
+
+					_, data, err := multibase.Decode(context.Args().First())
+					if err != nil {
+						return err
+					}
+
+					p := context.Path("output")
+					if p == "" {
+						fmt.Printf(string(data))
+						return nil
+					}
+					return ioutil.WriteFile(p, data, os.ModePerm)
+				},
+			},
+			{
+				Name:      "transcode",
+				ArgsUsage: "<new-base> <data>",
+				Usage:     "transcode multibase data",
+				Action: func(context *cli.Context) error {
+					if context.NArg() != 2 {
+						return cli.ShowCommandHelp(context, "")
+					}
+
+					newbase, err := multibase.EncoderByName(context.Args().Get(0))
+					if err != nil {
+						return err
+					}
+
+					_, data, err := multibase.Decode(context.Args().Get(1))
+					if err != nil {
+						return err
+					}
+
+					fmt.Println(newbase.Encode(data))
+					return nil
+				},
+			},
+		},
+	}
+
+	err := app.Run(os.Args)
+	if err != nil {
+		panic(err)
+	}
+}

multibase_test.go

@@ -2,7 +2,7 @@ package multibase
 
 import (
 	"bytes"
-	"crypto/rand"
+	"math/rand"
 	"sort"
 	"testing"
 )
@@ -44,7 +44,6 @@ var encodedSamples = map[Encoding]string{
 	Base64url:         "uRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE",
 	Base64pad:         "MRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE=",
 	Base64urlPad:      "URGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE=",
-	Base256Emoji:      "🚀💛✋💃✋😻😈🥺🤤🍀🌟💐✋😅✋💦✋🥺🏃😈😴🌟😻😝👏👏👏",
 }
 
 func testEncode(t *testing.T, encoding Encoding, bytes []byte, expected string) {

spec_test.go

@@ -66,7 +66,7 @@ func TestSpec(t *testing.T) {
 	}
 }
 func TestSpecVectors(t *testing.T) {
-	files, err := filepath.Glob("spec/tests/*.csv")
+	files, err := filepath.Glob("spec/tests/test[0-9]*.csv")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -145,36 +145,3 @@ func TestSpecVectors(t *testing.T) {
 		})
 	}
 }
-
-func FuzzDecode(f *testing.F) {
-	files, err := filepath.Glob("spec/tests/*.csv")
-	if err != nil {
-		f.Fatal(err)
-	}
-	for _, fname := range files {
-		func() {
-			file, err := os.Open(fname)
-			if err != nil {
-				f.Fatal(err)
-			}
-			defer file.Close()
-			reader := csv.NewReader(file)
-			reader.LazyQuotes = false
-			reader.FieldsPerRecord = 2
-			reader.TrimLeadingSpace = true
-
-			values, err := reader.ReadAll()
-			if err != nil {
-				f.Fatal(err)
-			}
-
-			for _, tc := range values[1:] {
-				f.Add(tc[1])
-			}
-		}()
-	}
-
-	f.Fuzz(func(_ *testing.T, data string) {
-		Decode(data)
-	})
-}

version.json

@@ -1,3 +0,0 @@
-{
-  "version": "v0.2.0"
-}