reclaimoptions

Documentation

Index

• type ReclaimFundsOption
  • func AccessManaPledgeID(nodeID string) ReclaimFundsOption
  • func Alias(aliasID string) ReclaimFundsOption
  • func ConsensusManaPledgeID(nodeID string) ReclaimFundsOption
  • func ToAddress(address string) ReclaimFundsOption
  • func WaitForConfirmation(wait bool) ReclaimFundsOption
• type ReclaimFundsOptions
  • func Build(options ...ReclaimFundsOption) (result *ReclaimFundsOptions, err error)

Types

type ReclaimFundsOption

type ReclaimFundsOption func(options *ReclaimFundsOptions) error

ReclaimFundsOption is a function that provides an option.

func AccessManaPledgeID

func AccessManaPledgeID(nodeID string) ReclaimFundsOption

AccessManaPledgeID is an option for SendFunds call that defines the nodeID to pledge access mana to.

func Alias

func Alias(aliasID string) ReclaimFundsOption

Alias specifies which alias to reclaim.

func ConsensusManaPledgeID

func ConsensusManaPledgeID(nodeID string) ReclaimFundsOption

ConsensusManaPledgeID is an option for SendFunds call that defines the nodeID to pledge consensus mana to.

func ToAddress

func ToAddress(address string) ReclaimFundsOption

ToAddress specifies the new governor of the alias.

func WaitForConfirmation

func WaitForConfirmation(wait bool) ReclaimFundsOption

WaitForConfirmation defines if the call should wait for confirmation before it returns.

type ReclaimFundsOptions

type ReclaimFundsOptions struct {
	AccessManaPledgeID    string
	ConsensusManaPledgeID string
	Alias                 *ledgerstate.AliasAddress
	ToAddress             ledgerstate.Address
	WaitForConfirmation   bool
}

ReclaimFundsOptions is a struct that is used to aggregate the optional parameters in the ReclaimDelegatedFunds call.

func Build

func Build(options ...ReclaimFundsOption) (result *ReclaimFundsOptions, err error)

Build build the options.