bech32

package

v2.0.0-...-2cd5660 Latest Latest Go to latest Published: Apr 4, 2021 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/GalRogozinski/iota.go

Documentation ¶

Overview ¶

Package bech32 implements bech32 encoding and decoding.

Index ¶

Variables
func Decode(s string) (string, []byte, error)
func Encode(hrp string, src []byte) (string, error)
type SyntaxError
- func (e *SyntaxError) Error() string
- func (e *SyntaxError) Unwrap() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidLength    = errors.New("invalid length")
	ErrMissingSeparator = errors.New("missing separator '" + string(separator) + "'")
	ErrInvalidSeparator = errors.New("separator '" + string(separator) + "' at invalid position")
	ErrMixedCase        = errors.New("mixed case")
	ErrInvalidCharacter = errors.New("invalid character")
	ErrInvalidChecksum  = errors.New("invalid checksum")
)

Errors reported during bech32 decoding.

Functions ¶

func Decode ¶

func Decode(s string) (string, []byte, error)

Decode decodes the Bech32 string s into its human-readable and data part. It returns an error when s does not represent a valid Bech32 encoding. An SyntaxError is returned when the error can be matched to a certain position in s.

func Encode ¶

func Encode(hrp string, src []byte) (string, error)

Encode encodes the String string and the src data as a Bech32 string. It returns an error when the input is invalid.

Types ¶

type SyntaxError ¶

type SyntaxError struct {
	Offset int // error occurred after reading Offset bytes
	// contains filtered or unexported fields
}

A SyntaxError is a description of a Bech32 syntax error.

func (*SyntaxError) Error ¶

func (e *SyntaxError) Error() string

func (*SyntaxError) Unwrap ¶

func (e *SyntaxError) Unwrap() error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
base32 Package base32 implements the conversion for bytes (base256) to base32.	Package base32 implements the conversion for bytes (base256) to base32.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL