address

package

v0.0.0-...-e64d2f0 Latest Latest Go to latest Published: Feb 8, 2021 License: MIT Imports: 6 Imported by: 0

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

This section is empty.

This section is empty.

This section is empty.

type Address struct {
	Network NetworkType
	Version AddressType
	Payload []byte
}

Address is a generic representation of a Bitcoin Cash address for converting to various string representations.

func NewFromCashAddress(addr *cashaddress.Address) (*Address, error)

NewFromCashAddress takes a cashaddress.Address and returns a generic `Address` struct.

func NewFromLegacy(addr *legacy.Address) (*Address, error)

NewFromLegacy takes a cashaddress.Address and returns a generic `Address` struct.

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

NewFromString takes a address string in Legacy or CashAddress format and returns an `*Address` or an error.

func (addr *Address) CashAddress() (*cashaddress.Address, error)

CashAddress converts various address fields to create a `*cashaddress.Address`

func (addr *Address) Copay() (*legacy.Address, error)

Copay returns a legacy address struct with the appropriate fields set to encode to the correct copay address version

func (addr *Address) Hex() string

Hex returns a string representation of the Address payload in hexadecimal.

func (addr *Address) Legacy() (*legacy.Address, error)

Legacy returns a legacy address struct with the appropriate fields set to encode to the correct legacy address version

func (r *Address) Verify() error

Verify checks to make sure the network and address type are valid.

type AddressType byte

const (
	P2KH AddressType = 0
	P2SH AddressType = 1
)

type NetworkType string

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