address

Documentation

Index

• Constants
• Variables
• func Equal(addr1 Address, addr2 Address) bool
• type AddrV1
  • func (addr *AddrV1) Bytes() []byte
  • func (addr *AddrV1) Hex() string
  • func (addr *AddrV1) String() string
• type Address
  • func FromBytes(bytes []byte) (Address, error)
  • func FromHex(s string) (Address, error)
  • func FromString(encodedAddr string) (Address, error)
• type Hash160

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"
)

const (
	// ZeroAddress is the IoTeX address whose hash160 is all zero
	ZeroAddress = "io1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqd39ym7"

	// StakingBucketPoolAddr is the staking bucket pool address
	StakingBucketPoolAddr = "io000000000000000000000000stakingprotocol"

	// RewardingPoolAddr is the rewarding pool address
	RewardingPoolAddr = "io0000000000000000000000rewardingprotocol"
)

Variables

var (
	StakingProtocolAddrHash     = hash160b([]byte("staking"))
	RewardingProtocolAddrHash   = hash160b([]byte("rewarding"))
	StakingCreateAddrHash       = bytesToHash160([]byte("stakingCreate"))
	StakingAddDepositAddrHash   = bytesToHash160([]byte("stakingAddDeposit"))
	StakingChangeCandAddrHash   = bytesToHash160([]byte("stakingChangeCand"))
	StakingUnstakeAddrHash      = bytesToHash160([]byte("stakingUnstake"))
	StakingWithdrawAddrHash     = bytesToHash160([]byte("stakingWithdraw"))
	StakingRestakeAddrHash      = bytesToHash160([]byte("stakingRestake"))
	StakingTransferAddrHash     = bytesToHash160([]byte("stakingTransfer"))
	StakingRegisterCandAddrHash = bytesToHash160([]byte("stakingRegisterCand"))
	StakingUpdateCandAddrHash   = bytesToHash160([]byte("stakingUpdateCand"))
)

20-byte protocol address hash

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

ErrInvalidAddr indicates the invalid address error

Functions

func Equal

func Equal(addr1 Address, addr2 Address) bool

Equal determine if two addresses are equal

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 a 20-byte hash derived from the the public key

func (*AddrV1) Bytes

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

Bytes converts an address struct into a byte array

func (*AddrV1) Hex

func (addr *AddrV1) Hex() string

Hex is the hex-encoding of Bytes, prefixed with "0x"

func (*AddrV1) String

func (addr *AddrV1) String() string

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

type Address

type Address interface {
	// String encodes the address into a string using bech32 encoding
	String() string

	// Bytes returns the underlying 20-byte public key hash
	Bytes() []byte

	// Hex is the hex-encoding of Bytes, prefixed with "0x"
	Hex() string
}

Address defines the interface of the blockchain address

func FromBytes

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

FromBytes converts a byte array into an address struct

func FromHex

func FromHex(s string) (Address, error)

FromHex converts a hex-encoded string into an address struct

func FromString

func FromString(encodedAddr string) (Address, error)

FromString decodes an encoded address string into an address struct

type Hash160

type Hash160 [20]byte

Hash160 for 160-bit hash used for account and smart contract address