formatting

Documentation

Index

• Constants
• func FormatAddress(chainIDAlias string, hrp string, addr []byte) (string, error)
• func FormatBech32(hrp string, payload []byte) (string, error)
• func IntFormat(maxValue int) string
• func ParseAddress(addrStr string) (string, string, []byte, error)
• func ParseBech32(addrStr string) (string, []byte, error)
• type CB58
  • func (cb58 CB58) ConvertBytes(b []byte) string
  • func (cb58 CB58) ConvertString(str string) ([]byte, error)
  • func (cb58 *CB58) Encoding() string
  • func (cb58 *CB58) FromString(str string) error
  • func (cb58 CB58) MarshalJSON() ([]byte, error)
  • func (cb58 CB58) String() string
  • func (cb58 *CB58) UnmarshalJSON(b []byte) error
• type CustomStringer
  • func (cs CustomStringer) String() string
• type DumpBytes
  • func (db DumpBytes) String() string
• type Encoding
• type EncodingManager
  • func NewEncodingManager(defaultEnc string) (EncodingManager, error)
• type Hex
  • func (h Hex) ConvertBytes(b []byte) string
  • func (h Hex) ConvertString(str string) ([]byte, error)
  • func (h *Hex) Encoding() string
  • func (h *Hex) FromString(str string) error
  • func (h Hex) MarshalJSON() ([]byte, error)
  • func (h Hex) String() string
  • func (h *Hex) UnmarshalJSON(b []byte) error
• type PrefixedStringer

Constants

const (
	// HexEncoding specifies a hex plus 4 byte checksum encoding format
	HexEncoding = "hex"
	// CB58Encoding specifies the CB58 encoding format
	CB58Encoding = "cb58"
)

Functions

func FormatAddress

func FormatAddress(
	chainIDAlias string,
	hrp string,
	addr []byte,
) (string, error)

FormatAddress takes in a chain prefix, HRP, and byte slice to produce a string for an address.

func FormatBech32

func FormatBech32(hrp string, payload []byte) (string, error)

FormatBech32 takes an address's bytes as input and returns a bech32 address

func IntFormat

func IntFormat(maxValue int) string

IntFormat ...

func ParseAddress

func ParseAddress(addrStr string) (string, string, []byte, error)

ParseAddress takes in an address string and splits returns the corresponding parts. This returns the chain ID alias, bech32 HRP, address bytes, and an error if it occurs.

func ParseBech32

func ParseBech32(addrStr string) (string, []byte, error)

ParseBech32 takes a bech32 address as input and returns the HRP and data section of a bech32 address

Types

type CB58

type CB58 struct{ Bytes []byte }

CB58 formats bytes in checksummed base-58 encoding

func (CB58) ConvertBytes

func (cb58 CB58) ConvertBytes(b []byte) string

ConvertBytes ...

func (CB58) ConvertString

func (cb58 CB58) ConvertString(str string) ([]byte, error)

ConvertString ...

func (*CB58) Encoding

func (cb58 *CB58) Encoding() string

Encoding ...

func (*CB58) FromString

func (cb58 *CB58) FromString(str string) error

FromString ...

func (CB58) MarshalJSON

func (cb58 CB58) MarshalJSON() ([]byte, error)

MarshalJSON ...

func (CB58) String

func (cb58 CB58) String() string

String ...

func (*CB58) UnmarshalJSON

func (cb58 *CB58) UnmarshalJSON(b []byte) error

UnmarshalJSON ...

type CustomStringer

type CustomStringer struct{ Stringer func() string }

CustomStringer ...

func (CustomStringer) String

func (cs CustomStringer) String() string

type DumpBytes

type DumpBytes struct{ Bytes []byte }

DumpBytes ...

func (DumpBytes) String

func (db DumpBytes) String() string

type Encoding

type Encoding interface {
	ConvertBytes([]byte) string
	ConvertString(str string) ([]byte, error)
	Encoding() string
}

Encoding returns a struct used to format bytes for a specific encoding

type EncodingManager

type EncodingManager interface {
	GetEncoding(encoding string) (Encoding, error)
}

EncodingManager is an interface to provide an Encoding interface

func NewEncodingManager

func NewEncodingManager(defaultEnc string) (EncodingManager, error)

NewEncodingManager returns an EncodingManager with the provided default

type Hex

type Hex struct{ Bytes []byte }

Hex implements the Encoding interface Provides a hex format with 4 byte checksum

func (Hex) ConvertBytes

func (h Hex) ConvertBytes(b []byte) string

ConvertBytes ...

func (Hex) ConvertString

func (h Hex) ConvertString(str string) ([]byte, error)

ConvertString ...

func (*Hex) Encoding

func (h *Hex) Encoding() string

Encoding ...

func (*Hex) FromString

func (h *Hex) FromString(str string) error

FromString ...

func (Hex) MarshalJSON

func (h Hex) MarshalJSON() ([]byte, error)

MarshalJSON ...

func (Hex) String

func (h Hex) String() string

String ...

func (*Hex) UnmarshalJSON

func (h *Hex) UnmarshalJSON(b []byte) error

UnmarshalJSON ...

type PrefixedStringer

type PrefixedStringer interface {
	fmt.Stringer

	PrefixedString(prefix string) string
}

PrefixedStringer extends a stringer that adds a prefix