wallet

Documentation

Index

• Constants
• Variables
• type ID
  • func NewID(data []byte) (id ID)
  • func (id ID) Equal(cmp ID) bool
  • func (id ID) IsValid() bool
  • func (id ID) MarshalBinary() (data []byte, err error)
  • func (id ID) String() string
  • func (id *ID) UnmarshalBinary(data []byte) error
  • func (id *ID) UnmarshalHex(text string) error

Constants

const (
	// IDSize is the size of a wallet ID in bytes.
	// NOTE: The length of wallet ID's string is IDSize * 2.
	IDSize = 3
)

Variables

var (
	// ErrMalformedID is the error returned when a wallet ID is malformed.
	ErrMalformedID = errors.New("wallet: malformed ID")
)

Types

type ID

type ID [IDSize]byte

ID is a wallet ID computed as a truncated hash of a public key for a specific BIP32 path.

func NewID

func NewID(data []byte) (id ID)

NewID creates a new wallet ID the given data.

func (ID) Equal

func (id ID) Equal(cmp ID) bool

Equal compares vs another wallet ID for equality.

func (ID) IsValid

func (id ID) IsValid() bool

IsValid checks whether a wallet ID is well-formed.

func (ID) MarshalBinary

func (id ID) MarshalBinary() (data []byte, err error)

MarshalBinary encodes a wallet ID into binary form.

func (ID) String

func (id ID) String() string

String returns the string representation of a wallet ID.

func (*ID) UnmarshalBinary

func (id *ID) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes a binary marshaled wallet ID.

func (*ID) UnmarshalHex

func (id *ID) UnmarshalHex(text string) error

UnmarshalHex deserializes a hexadecimal text string into wallet ID.