address

Documentation

Index

• type AddressApi
• type AddressApiImpl
  • func NewAddressApi(options ...config.CfdConfigOption) *AddressApiImpl
  • func (u *AddressApiImpl) CreateByPubkey(pubkey *types.Pubkey, addressType types.AddressType) (address *types.Address, err error)
  • func (u *AddressApiImpl) CreateByScript(redeemScript *types.Script, addressType types.AddressType) (address *types.Address, err error)
  • func (u *AddressApiImpl) CreateMultisigAddress(pubkeys *[]types.Pubkey, requireNum uint32, addressType types.AddressType) (address *types.Address, redeemScript *types.Script, err error)
  • func (u *AddressApiImpl) GetNetworkTypes() []types.NetworkType
  • func (u *AddressApiImpl) GetPeginAddressByPubkey(addressType types.AddressType, fedpegScript, pubkey string) (peginAddress *types.Address, claimScript *types.Script, err error)
  • func (u *AddressApiImpl) GetPegoutAddress(addressType types.AddressType, descriptorOrXpub string, bip32Counter uint32) (pegoutAddress *types.Address, baseDescriptor *string, err error)
  • func (u *AddressApiImpl) ParseAddress(addressString string) (address *types.Address, err error)
• type ConfidentialAddressApi
• type ConfidentialAddressApiImpl
  • func NewConfidentialAddressApi() *ConfidentialAddressApiImpl
  • func (u *ConfidentialAddressApiImpl) Create(addressString string, confidentialKey *types.Pubkey) (address *types.ConfidentialAddress, err error)
  • func (u *ConfidentialAddressApiImpl) Parse(addressString string) (address *types.ConfidentialAddress, err error)
• type ElementsAddressApi

Types

type AddressApi

type AddressApi interface {
	// GetNetworkTypes This function returns the available network types.
	GetNetworkTypes() []types.NetworkType
	ParseAddress(addressString string) (address *types.Address, err error)
	CreateByPubkey(pubkey *types.Pubkey, addressType types.AddressType) (address *types.Address, err error)
	CreateByScript(redeemScript *types.Script, addressType types.AddressType) (address *types.Address, err error)
	CreateMultisigAddress(pubkeys *[]types.Pubkey, requireNum uint32, addressType types.AddressType) (address *types.Address, redeemScript *types.Script, err error)
}

AddressApi This interface handles bitcoin addresses.

type AddressApiImpl

type AddressApiImpl struct {
	cfdErrors.HasInitializeError
	// contains filtered or unexported fields
}

AddressApiImpl ...

func NewAddressApi

func NewAddressApi(options ...config.CfdConfigOption) *AddressApiImpl

NewAddressApi returns an object that defines the API for address.

func (*AddressApiImpl) CreateByPubkey

func (u *AddressApiImpl) CreateByPubkey(pubkey *types.Pubkey, addressType types.AddressType) (address *types.Address, err error)

CreateByPubkey ...

func (*AddressApiImpl) CreateByScript

func (u *AddressApiImpl) CreateByScript(redeemScript *types.Script, addressType types.AddressType) (address *types.Address, err error)

CreateByScript ...

func (*AddressApiImpl) CreateMultisigAddress

func (u *AddressApiImpl) CreateMultisigAddress(pubkeys *[]types.Pubkey, requireNum uint32, addressType types.AddressType) (address *types.Address, redeemScript *types.Script, err error)

CreateMultisigAddress ...

func (*AddressApiImpl) GetNetworkTypes

func (u *AddressApiImpl) GetNetworkTypes() []types.NetworkType

GetNetworkTypes This function returns the available network types.

func (*AddressApiImpl) GetPeginAddressByPubkey

func (u *AddressApiImpl) GetPeginAddressByPubkey(addressType types.AddressType, fedpegScript, pubkey string) (peginAddress *types.Address, claimScript *types.Script, err error)

GetPeginAddressByPubkey ...

func (*AddressApiImpl) GetPegoutAddress

func (u *AddressApiImpl) GetPegoutAddress(addressType types.AddressType, descriptorOrXpub string, bip32Counter uint32) (pegoutAddress *types.Address, baseDescriptor *string, err error)

GetPegoutAddress ...

func (*AddressApiImpl) ParseAddress

func (u *AddressApiImpl) ParseAddress(addressString string) (address *types.Address, err error)

ParseAddress ...

type ConfidentialAddressApi

type ConfidentialAddressApi interface {
	Create(addressString string, confidentialKey *types.Pubkey) (address *types.ConfidentialAddress, err error)
	Parse(addressString string) (address *types.ConfidentialAddress, err error)
}

type ConfidentialAddressApiImpl

type ConfidentialAddressApiImpl struct {
	Error error
}

ConfidentialAddressApiImpl ...

func NewConfidentialAddressApi

func NewConfidentialAddressApi() *ConfidentialAddressApiImpl

func (*ConfidentialAddressApiImpl) Create

func (u *ConfidentialAddressApiImpl) Create(addressString string, confidentialKey *types.Pubkey) (address *types.ConfidentialAddress, err error)

Create ...

func (*ConfidentialAddressApiImpl) Parse

func (u *ConfidentialAddressApiImpl) Parse(addressString string) (address *types.ConfidentialAddress, err error)

ParseAddress ...

type ElementsAddressApi

type ElementsAddressApi interface {
	AddressApi
	GetPeginAddressByPubkey(addressType types.AddressType, fedpegScript, pubkey string) (peginAddress *types.Address, claimScript *types.Script, err error)
	GetPegoutAddress(addressType types.AddressType, descriptorOrXpub string, bip32Counter uint32) (pegoutAddress *types.Address, baseDescriptor *string, err error)
}

ElementsAddressApi This interface handles elements addresses.