services

Documentation

Index

• type API
• type Client
  • func NewClient(cfg *config.Config) (*Client, error)
  • func (c *Client) LSPList() (*data.LSPList, error)
  • func (c *Client) NewChannelOpenerClient() (breezservice.ChannelOpenerClient, context.Context, context.CancelFunc)
  • func (c *Client) NewFundManager() (breezservice.FundManagerClient, context.Context, context.CancelFunc)
  • func (c *Client) NewPushTxNotifierClient() (breezservice.PushTxNotifierClient, context.Context, context.CancelFunc)
  • func (c *Client) NewSwapper(timeout time.Duration) (breezservice.SwapperClient, context.Context, context.CancelFunc)
  • func (c *Client) NewSyncNotifierClient() (breezservice.SyncNotifierClient, context.Context, context.CancelFunc)
  • func (c *Client) Rates() (*data.Rates, error)
  • func (c *Client) ReceiverNode() (string, error)
  • func (c *Client) Start() error
  • func (c *Client) Stop() (err error)
  • func (c *Client) Versions() ([]string, error)

Types

type API

type API interface {
	NewSyncNotifierClient() (breezservice.SyncNotifierClient, context.Context, context.CancelFunc)
	NewFundManager() (breezservice.FundManagerClient, context.Context, context.CancelFunc)
	NewSwapper(timeout time.Duration) (breezservice.SwapperClient, context.Context, context.CancelFunc)
	NewChannelOpenerClient() (breezservice.ChannelOpenerClient, context.Context, context.CancelFunc)
	NewPushTxNotifierClient() (breezservice.PushTxNotifierClient, context.Context, context.CancelFunc)
	LSPList() (*data.LSPList, error)
}

API is the interface for external breez services.

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Client represents the client interface to breez services

func NewClient

func NewClient(cfg *config.Config) (*Client, error)

NewClient creates a new client struct

func (*Client) LSPList

func (c *Client) LSPList() (*data.LSPList, error)

LSPList returns the list of the LSPs

func (*Client) NewChannelOpenerClient

func (c *Client) NewChannelOpenerClient() (breezservice.ChannelOpenerClient, context.Context, context.CancelFunc)

NewChannelOpenerClient creates a new SyncNotifierClient

func (*Client) NewFundManager

func (c *Client) NewFundManager() (breezservice.FundManagerClient, context.Context, context.CancelFunc)

NewFundManager creates a new FundsManager

func (*Client) NewPushTxNotifierClient

func (c *Client) NewPushTxNotifierClient() (breezservice.PushTxNotifierClient, context.Context, context.CancelFunc)

NewPushTxNotifierClient creates a new PushTxNotifierClient

func (*Client) NewSwapper

func (c *Client) NewSwapper(timeout time.Duration) (breezservice.SwapperClient, context.Context, context.CancelFunc)

NewSwapper creates a new Swapper

func (*Client) NewSyncNotifierClient

func (c *Client) NewSyncNotifierClient() (breezservice.SyncNotifierClient, context.Context, context.CancelFunc)

NewSyncNotifierClient creates a new SyncNotifierClient

func (*Client) Rates

func (c *Client) Rates() (*data.Rates, error)

Rates returns the rates obtained from the server

func (*Client) ReceiverNode

func (c *Client) ReceiverNode() (string, error)

func (*Client) Start

func (c *Client) Start() error

Start the client

func (*Client) Stop

func (c *Client) Stop() (err error)

func (*Client) Versions

func (c *Client) Versions() ([]string, error)

Versions returns the list of Breez app version authorized by the server