1 Commits

Author SHA1 Message Date
Adin Schmahmann
1be98b8c97 add new multibase binary 2021-05-07 18:31:54 -04:00
8 changed files with 165 additions and 115 deletions

View File

@@ -1,27 +0,0 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
# Automatically merge pull requests opened by web3-bot, as soon as (and only if) all tests pass.
# This reduces the friction associated with updating with our workflows.
on: [ pull_request ]
jobs:
automerge:
if: github.event.pull_request.user.login == 'web3-bot'
runs-on: ubuntu-latest
steps:
- name: Wait on tests
uses: lewagon/wait-on-check-action@bafe56a6863672c681c3cf671f5e10b20abf2eaa # v0.2
with:
ref: ${{ github.event.pull_request.head.sha }}
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
running-workflow-name: 'automerge' # the name of this job
- name: Merge PR
uses: pascalgn/automerge-action@741c311a47881be9625932b0a0de1b0937aab1ae # v0.13.1
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
MERGE_LABELS: ""
MERGE_METHOD: "squash"
MERGE_DELETE_BRANCH: true

View File

@@ -1,43 +0,0 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
on: [push, pull_request]
jobs:
unit:
runs-on: ubuntu-latest
name: Go checks
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- uses: actions/setup-go@v2
with:
go-version: "1.16.x"
- name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@be534f007836a777104a15f2456cd1fffd3ddee8 # v2020.2.2
- name: Check that go.mod is tidy
run: |
go mod tidy
if [[ -n $(git ls-files --other --exclude-standard --directory -- go.sum) ]]; then
echo "go.sum was added by go mod tidy"
exit 1
fi
git diff --exit-code -- go.sum go.mod
- name: gofmt
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: |
out=$(gofmt -s -l .)
if [[ -n "$out" ]]; then
echo $out | awk '{print "::error file=" $0 ",line=0,col=0::File is not gofmt-ed."}'
exit 1
fi
- name: go vet
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: go vet ./...
- name: staticcheck
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: |
set -o pipefail
staticcheck ./... | sed -e 's@\(.*\)\.go@./\1.go@g'

View File

@@ -1,40 +0,0 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
on: [push, pull_request]
jobs:
unit:
strategy:
fail-fast: false
matrix:
os: [ "ubuntu", "windows", "macos" ]
go: [ "1.15.x", "1.16.x" ]
runs-on: ${{ matrix.os }}-latest
name: Unit tests (${{ matrix.os}}, Go ${{ matrix.go }})
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go }}
- name: Go information
run: |
go version
go env
- name: Run tests
run: go test -v -coverprofile coverage.txt ./...
- name: Run tests (32 bit)
if: ${{ matrix.os != 'macos' }} # can't run 32 bit tests on OSX.
env:
GOARCH: 386
run: go test -v ./...
- name: Run tests with race detector
if: ${{ matrix.os == 'ubuntu' }} # speed things up. Windows and OSX VMs are slow
run: go test -v -race ./...
- name: Upload coverage to Codecov
uses: codecov/codecov-action@967e2b38a85a62bd61be5529ada27ebc109948c2 # v1.4.1
with:
file: coverage.txt
env_vars: OS=${{ matrix.os }}, GO=${{ matrix.go }}

31
.travis.yml Normal file
View File

@@ -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

View File

@@ -14,7 +14,7 @@ type Encoder struct {
func NewEncoder(base Encoding) (Encoder, error) { func NewEncoder(base Encoding) (Encoder, error) {
_, ok := EncodingToStr[base] _, ok := EncodingToStr[base]
if !ok { 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 return Encoder{base}, nil
} }
@@ -33,9 +33,9 @@ func MustNewEncoder(base Encoding) Encoder {
// either be the multibase name or single character multibase prefix // either be the multibase name or single character multibase prefix
func EncoderByName(str string) (Encoder, error) { func EncoderByName(str string) (Encoder, error) {
var base Encoding var base Encoding
var ok bool ok := true
if len(str) == 0 { if len(str) == 0 {
return Encoder{-1}, fmt.Errorf("empty multibase encoding") return Encoder{-1}, fmt.Errorf("Empty multibase encoding")
} else if len(str) == 1 { } else if len(str) == 1 {
base = Encoding(str[0]) base = Encoding(str[0])
_, ok = EncodingToStr[base] _, ok = EncodingToStr[base]
@@ -43,7 +43,7 @@ func EncoderByName(str string) (Encoder, error) {
base, ok = Encodings[str] base, ok = Encodings[str]
} }
if !ok { 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 return Encoder{base}, nil
} }

3
go.mod
View File

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

13
go.sum
View File

@@ -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 h1:Y51FGVJ91WBqCEabAi5OPUz38eAx8DakuAm5svLcsfQ=
github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8= 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 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI=
github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA= 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 h1:JR6TyF7JjGd3m6FbLU2cOxhC0Li8z8dLNGQ89tUg4F4=
github.com/multiformats/go-base36 v0.1.0/go.mod h1:kFGE83c6s80PklsHO9sRn2NCoffoRdUUOENyW/Vv6sM= 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=

115
multibase/main.go Normal file
View File

@@ -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)
}
}