assets

Documentation

Index

• type TapdClient
  • func NewTapdClient(config *TapdConfig) (*TapdClient, error)
  • func (c *TapdClient) Close()
  • func (c *TapdClient) GetAssetName(ctx context.Context, assetId []byte) (string, error)
  • func (c *TapdClient) GetRfqForAsset(ctx context.Context, satAmount btcutil.Amount, assetId, peerPubkey []byte, ...) (*rfqrpc.PeerAcceptedSellQuote, error)
• type TapdConfig
  • func DefaultTapdConfig() *TapdConfig

Types

type TapdClient

type TapdClient struct {
	taprpc.TaprootAssetsClient
	tapchannelrpc.TaprootAssetChannelsClient
	priceoraclerpc.PriceOracleClient
	rfqrpc.RfqClient
	universerpc.UniverseClient
	// contains filtered or unexported fields
}

TapdClient is a client for the Tap daemon.

func NewTapdClient

func NewTapdClient(config *TapdConfig) (*TapdClient, error)

NewTapdClient returns a new taproot assets client.

func (*TapdClient) Close

func (c *TapdClient) Close()

Close closes the client connection to the server.

func (*TapdClient) GetAssetName

func (c *TapdClient) GetAssetName(ctx context.Context,
	assetId []byte) (string, error)

GetAssetName returns the human-readable name of the asset.

func (*TapdClient) GetRfqForAsset

func (c *TapdClient) GetRfqForAsset(ctx context.Context,
	satAmount btcutil.Amount, assetId, peerPubkey []byte,
	expiry int64, feeLimitMultiplier float64) (
	*rfqrpc.PeerAcceptedSellQuote, error)

GetRfqForAsset returns a RFQ for the given asset with the given amount and to the given peer.

type TapdConfig

type TapdConfig struct {
	Activate     bool          `long:"activate" description:"Activate the Tap daemon"`
	Host         string        `long:"host" description:"The host of the Tap daemon, in the format of host:port"`
	MacaroonPath string        `long:"macaroonpath" description:"Path to the admin macaroon"`
	TLSPath      string        `long:"tlspath" description:"Path to the TLS certificate"`
	RFQtimeout   time.Duration `long:"rfqtimeout" description:"The timeout we wait for tapd peer to accept RFQ"`
}

TapdConfig is a struct that holds the configuration options to connect to a taproot assets daemon.

func DefaultTapdConfig

func DefaultTapdConfig() *TapdConfig

DefaultTapdConfig returns a default configuration to connect to a taproot assets daemon.