address

package

v0.2.0 Latest Latest Go to latest Published: Aug 21, 2020 License: GPL-3.0 Imports: 1 Imported by: 13

Details

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 Encoder interface {
	EncodeAddress(RawAddress) (Address, error)
}

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

type EncoderDecoder interface {
	Encoder
	Decoder
}

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

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.