address

Documentation

Index

• Constants
• Variables
• func Bech32ToPKHash(encodedAddr string) (hash.PKHash, error)
• type AddrV1
  • func (addr *AddrV1) Bech32() string
  • func (addr *AddrV1) Bytes() []byte
  • func (addr *AddrV1) Payload() []byte
  • func (addr *AddrV1) PublicKeyHash() hash.PKHash
• type Address
  • func Bech32ToAddress(encodedAddr string) (Address, error)
  • func BytesToAddress(bytes []byte) (Address, error)
  • func New(payload []byte) Address

Constants

const (
	// MainnetPrefix is the prefix added to the human readable address of mainnet
	MainnetPrefix = "io"
	// TestnetPrefix is the prefix added to the human readable address of testnet
	TestnetPrefix = "it"
)

Variables

var ErrInvalidAddr = errors.New("invalid address")

ErrInvalidAddr indicates the invalid address error

var V1 = v1{
	AddressLength: 20,
}

V1 is a singleton and defines V1 address metadata

Functions

func Bech32ToPKHash

func Bech32ToPKHash(encodedAddr string) (hash.PKHash, error)

Bech32ToPKHash returns the public key hash from an encoded address

Types

type AddrV1

type AddrV1 struct {
	// contains filtered or unexported fields
}

AddrV1 is V1 address format to be used on IoTeX blockchain and subchains. It is composed of 20 bytes: hash derived from the the public key:

func (*AddrV1) Bech32

func (addr *AddrV1) Bech32() string

Bech32 encodes an address struct into a a Bech32 encoded address string The encoded address string will start with "io" for mainnet, and with "it" for testnet

func (*AddrV1) Bytes

func (addr *AddrV1) Bytes() []byte

Bytes converts an address struct into a byte array

func (*AddrV1) Payload

func (addr *AddrV1) Payload() []byte

Payload returns the payload, which is the public key hash

func (*AddrV1) PublicKeyHash

func (addr *AddrV1) PublicKeyHash() hash.PKHash

PublicKeyHash returns the public key hash

type Address

type Address interface {
	// Payload returns the payload
	Payload() []byte
	// Bech32 encodes the whole address into an address string encoded in Bech32 format
	Bech32() string
	// Bytes serializes the whole address struct into a byte slice, which is composed of the payload to
	// identify an address within one blockchain:
	Bytes() []byte
}

Address defines the interface of the blockchain address

func Bech32ToAddress

func Bech32ToAddress(encodedAddr string) (Address, error)

Bech32ToAddress decodes an encoded address string into an address struct

func BytesToAddress

func BytesToAddress(bytes []byte) (Address, error)

BytesToAddress converts a byte array into an address struct

func New

func New(payload []byte) Address

New constructs an address instance