address

package

v0.5.15 Latest Latest Go to latest Published: Oct 20, 2022 License: GPL-3.0 Imports: 1 Imported by: 13

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

Package address defines the Address API. All chains must implement this API, so that addresses can be encoded/decoded.

This section is empty.

This section is empty.

This section is empty.

type Address pack.String

An Address is a human-readable representation of a public identity. It can be the address of an external account, contract, or script.

func (addr Address) Marshal(buf []byte, rem int) ([]byte, int, error)

Marshal the address to binary. You should not call this function directly, unless you are implementing marshalling for a container type.

func (addr Address) SizeHint() int

SizeHint returns the number of bytes required to represent the address in binary.

func (addr *Address) Unmarshal(buf []byte, rem int) ([]byte, int, error)

Unmarshal the address from binary. You should not call this function directly, unless you are implementing unmarshalling for a container type.

type Decoder interface {
	DecodeAddress(Address) (RawAddress, error)
}

The Decoder interfaces is used to convert human-readable addresses into raw addresses.

type EncodeDecoder interface {
	Encoder
	Decoder
}

The EncodeDecoder interfaces combines encoding and decoding functionality into one interface.

type Encoder interface {
	EncodeAddress(RawAddress) (Address, error)
}

The Encoder interface is used to convert raw addresses into human-readable addresses.

type RawAddress pack.Bytes

RawAddress is an address that has been decoded into its binary form.

func (addr RawAddress) Marshal(buf []byte, rem int) ([]byte, int, error)

Marshal the address to binary. You should not call this function directly, unless you are implementing marshalling for a container type.

func (addr RawAddress) SizeHint() int

SizeHint returns the number of bytes required to represent the address in binary.

func (addr *RawAddress) Unmarshal(buf []byte, rem int) ([]byte, int, error)

Unmarshal the address from binary. You should not call this function directly, unless you are implementing unmarshalling for a container type.