cashaddress

Documentation

Index

• Constants
• type Address
  • func Decode(addr string, defaultPrefix string) (*Address, error)
  • func (addr *Address) Encode() (string, error)
  • func (addr *Address) String() string

Constants

const (
	RegTest = "bchreg"
	TestNet = "bchtest"
	MainNet = "bitcoincash"
)

List of valid cashaddress prefixes

const (
	P2KH uint8 = 0
	P2SH uint8 = 1
)

Valid cashaddress types

Types

type Address

type Address struct {
	Prefix  string
	Version uint8
	Payload []uint8
}

Address is a struct containing unpacked information relevant to the new address specification.

func Decode

func Decode(addr string, defaultPrefix string) (*Address, error)

FromCashAddr takes a CashAddr URI string, and returns and unpacked RawAddress, and possible an error.

func (*Address) Encode

func (addr *Address) Encode() (string, error)

ToCashAddr expects a RawAddress and a prefix, and returns the CashAddr URI, and possibly an error.

func (*Address) String

func (addr *Address) String() string

String returns a string, consuming errors. Probably shouldn't use this most places