descriptor

Documentation

Index

• type DescriptorApi
• type DescriptorApiImpl
  • func NewDescriptorApi() *DescriptorApiImpl
  • func (d *DescriptorApiImpl) GetChecksum(descriptor *types.Descriptor) (descriptorAddedChecksum string, err error)
  • func (d *DescriptorApiImpl) NewDescriptorFromAddress(address string) *types.Descriptor
  • func (d *DescriptorApiImpl) NewDescriptorFromLockingScript(lockingScript string) *types.Descriptor
  • func (d *DescriptorApiImpl) NewDescriptorFromMultisig(hashType types.HashType, pubkeys []string, requireNum int) *types.Descriptor
  • func (d *DescriptorApiImpl) NewDescriptorFromPubkey(hashType types.HashType, pubkey *types.Pubkey) *types.Descriptor
  • func (d *DescriptorApiImpl) NewDescriptorFromString(descriptor string) *types.Descriptor
  • func (d *DescriptorApiImpl) Parse(descriptor *types.Descriptor) (data *types.DescriptorData, descriptorDataList []types.DescriptorData, ...)
  • func (d *DescriptorApiImpl) ParseWithDerivationPath(descriptor *types.Descriptor, bip32DerivationPath string) (data *types.DescriptorData, descriptorDataList []types.DescriptorData, ...)
  • func (p *DescriptorApiImpl) WithConfig(conf config.CfdConfig) (obj *DescriptorApiImpl, err error)

Types

type DescriptorApi

type DescriptorApi interface {
	// NewDescriptorFromAddress This function return a Descriptor from pubkey.
	NewDescriptorFromPubkey(
		hashType types.HashType, pubkey *types.Pubkey) *types.Descriptor
	// NewDescriptorFromMultisig This function return a Descriptor from multisig.
	NewDescriptorFromMultisig(
		hashType types.HashType,
		pubkeys []string,
		requireNum int,
	) *types.Descriptor
	// NewDescriptor This function return a Descriptor.
	NewDescriptorFromString(descriptor string) *types.Descriptor
	// NewDescriptorFromLockingScript This function return a Descriptor from locking script.
	NewDescriptorFromLockingScript(lockingScript string) *types.Descriptor
	// NewDescriptorFromAddress This function return a Descriptor from address.
	NewDescriptorFromAddress(address string) *types.Descriptor
	// Parse This function return a Descriptor parsing data.
	Parse(descriptor *types.Descriptor) (
		data *types.DescriptorData,
		descriptorDataList []types.DescriptorData,
		multisigList []types.DescriptorKeyData,
		err error,
	)
	// ParseWithDerivationPath This function return a Descriptor parsing data.
	ParseWithDerivationPath(
		descriptor *types.Descriptor,
		bip32DerivationPath string,
	) (
		data *types.DescriptorData,
		descriptorDataList []types.DescriptorData,
		multisigList []types.DescriptorKeyData,
		err error,
	)
	// GetChecksum This function return a descriptor adding checksum.
	GetChecksum(
		descriptor *types.Descriptor) (descriptorAddedChecksum string, err error)
}

type DescriptorApiImpl

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

Descriptor This struct use for the output descriptor.

func NewDescriptorApi

func NewDescriptorApi() *DescriptorApiImpl

func (*DescriptorApiImpl) GetChecksum

func (d *DescriptorApiImpl) GetChecksum(descriptor *types.Descriptor) (descriptorAddedChecksum string, err error)

GetChecksum This function return a descriptor adding checksum.

func (*DescriptorApiImpl) NewDescriptorFromAddress

func (d *DescriptorApiImpl) NewDescriptorFromAddress(address string) *types.Descriptor

NewDescriptorFromAddress This function return a Descriptor from address.

func (*DescriptorApiImpl) NewDescriptorFromLockingScript

func (d *DescriptorApiImpl) NewDescriptorFromLockingScript(lockingScript string) *types.Descriptor

NewDescriptorFromLockingScript This function return a Descriptor from locking script.

func (*DescriptorApiImpl) NewDescriptorFromMultisig

func (d *DescriptorApiImpl) NewDescriptorFromMultisig(hashType types.HashType, pubkeys []string, requireNum int) *types.Descriptor

NewDescriptorFromMultisig This function return a Descriptor from multisig.

func (*DescriptorApiImpl) NewDescriptorFromPubkey

func (d *DescriptorApiImpl) NewDescriptorFromPubkey(hashType types.HashType, pubkey *types.Pubkey) *types.Descriptor

NewDescriptorFromAddress This function return a Descriptor from pubkey.

func (*DescriptorApiImpl) NewDescriptorFromString

func (d *DescriptorApiImpl) NewDescriptorFromString(descriptor string) *types.Descriptor

NewDescriptor This function return a Descriptor.

func (*DescriptorApiImpl) Parse

func (d *DescriptorApiImpl) Parse(descriptor *types.Descriptor) (data *types.DescriptorData, descriptorDataList []types.DescriptorData, multisigList []types.DescriptorKeyData, err error)

Parse This function return a Descriptor parsing data.

func (*DescriptorApiImpl) ParseWithDerivationPath

func (d *DescriptorApiImpl) ParseWithDerivationPath(descriptor *types.Descriptor, bip32DerivationPath string) (data *types.DescriptorData, descriptorDataList []types.DescriptorData, multisigList []types.DescriptorKeyData, err error)

ParseWithDerivationPath This function return a Descriptor parsing data.

func (*DescriptorApiImpl) WithConfig

func (p *DescriptorApiImpl) WithConfig(conf config.CfdConfig) (obj *DescriptorApiImpl, err error)

WithConfig This function set a configuration.