breez

Documentation

Index

• func NewBreezService(mnemonic, apiKey, inviteCode, workDir string) (result lnclient.LNClient, err error)
• type BreezListener
  • func (listener BreezListener) Log(l breez_sdk.LogEntry)
  • func (BreezListener) OnEvent(e breez_sdk.BreezEvent)
• type BreezService
  • func (bs *BreezService) CloseChannel(ctx context.Context, closeChannelRequest *lnclient.CloseChannelRequest) (*lnclient.CloseChannelResponse, error)
  • func (bs *BreezService) ConnectPeer(ctx context.Context, connectPeerRequest *lnclient.ConnectPeerRequest) error
  • func (bs *BreezService) DisconnectPeer(ctx context.Context, peerId string) error
  • func (bs *BreezService) GetBalance(ctx context.Context) (balance int64, err error)
  • func (bs *BreezService) GetBalances(ctx context.Context) (*lnclient.BalancesResponse, error)
  • func (bs *BreezService) GetInfo(ctx context.Context) (info *lnclient.NodeInfo, err error)
  • func (bs *BreezService) GetLogOutput(ctx context.Context, maxLen int) ([]byte, error)
  • func (bs *BreezService) GetNetworkGraph(nodeIds []string) (lnclient.NetworkGraphResponse, error)
  • func (bs *BreezService) GetNewOnchainAddress(ctx context.Context) (string, error)
  • func (bs *BreezService) GetNodeConnectionInfo(ctx context.Context) (nodeConnectionInfo *lnclient.NodeConnectionInfo, err error)
  • func (bs *BreezService) GetNodeStatus(ctx context.Context) (nodeStatus *lnclient.NodeStatus, err error)
  • func (bs *BreezService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainBalanceResponse, error)
  • func (bs *BreezService) GetStorageDir() (string, error)
  • func (bs *BreezService) GetSupportedNIP47Methods() []string
  • func (bs *BreezService) GetSupportedNIP47NotificationTypes() []string
  • func (bs *BreezService) ListChannels(ctx context.Context) ([]lnclient.Channel, error)
  • func (bs *BreezService) ListPeers(ctx context.Context) ([]lnclient.PeerDetails, error)
  • func (bs *BreezService) ListTransactions(ctx context.Context, from, until, limit, offset uint64, unpaid bool, ...) (transactions []lnclient.Transaction, err error)
  • func (bs *BreezService) LookupInvoice(ctx context.Context, paymentHash string) (transaction *lnclient.Transaction, err error)
  • func (bs *BreezService) MakeInvoice(ctx context.Context, amount int64, description string, descriptionHash string, ...) (transaction *lnclient.Transaction, err error)
  • func (bs *BreezService) OpenChannel(ctx context.Context, openChannelRequest *lnclient.OpenChannelRequest) (*lnclient.OpenChannelResponse, error)
  • func (bs *BreezService) RedeemOnchainFunds(ctx context.Context, toAddress string) (txId string, err error)
  • func (bs *BreezService) ResetRouter(key string) error
  • func (bs *BreezService) SendKeysend(ctx context.Context, amount uint64, destination, preimage string, ...) (preImage string, err error)
  • func (bs *BreezService) SendPaymentProbes(ctx context.Context, invoice string) error
  • func (bs *BreezService) SendPaymentSync(ctx context.Context, payReq string) (*lnclient.PayInvoiceResponse, error)
  • func (bs *BreezService) SendSpontaneousPaymentProbes(ctx context.Context, amountMsat uint64, nodeId string) error
  • func (bs *BreezService) Shutdown() error
  • func (bs *BreezService) SignMessage(ctx context.Context, message string) (string, error)
  • func (bs *BreezService) UpdateChannel(ctx context.Context, updateChannelRequest *lnclient.UpdateChannelRequest) error
  • func (bs *BreezService) UpdateLastWalletSyncRequest()

Functions

func NewBreezService

func NewBreezService(mnemonic, apiKey, inviteCode, workDir string) (result lnclient.LNClient, err error)

Types

type BreezListener

type BreezListener struct {
}

func (BreezListener) Log

func (listener BreezListener) Log(l breez_sdk.LogEntry)

func (BreezListener) OnEvent

func (BreezListener) OnEvent(e breez_sdk.BreezEvent)

type BreezService

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

func (*BreezService) CloseChannel

func (bs *BreezService) CloseChannel(ctx context.Context, closeChannelRequest *lnclient.CloseChannelRequest) (*lnclient.CloseChannelResponse, error)

func (*BreezService) ConnectPeer

func (bs *BreezService) ConnectPeer(ctx context.Context, connectPeerRequest *lnclient.ConnectPeerRequest) error

func (*BreezService) DisconnectPeer

func (bs *BreezService) DisconnectPeer(ctx context.Context, peerId string) error

func (*BreezService) GetBalance

func (bs *BreezService) GetBalance(ctx context.Context) (balance int64, err error)

func (*BreezService) GetBalances

func (bs *BreezService) GetBalances(ctx context.Context) (*lnclient.BalancesResponse, error)

func (*BreezService) GetInfo

func (bs *BreezService) GetInfo(ctx context.Context) (info *lnclient.NodeInfo, err error)

func (*BreezService) GetLogOutput

func (bs *BreezService) GetLogOutput(ctx context.Context, maxLen int) ([]byte, error)

func (*BreezService) GetNetworkGraph

func (bs *BreezService) GetNetworkGraph(nodeIds []string) (lnclient.NetworkGraphResponse, error)

func (*BreezService) GetNewOnchainAddress

func (bs *BreezService) GetNewOnchainAddress(ctx context.Context) (string, error)

func (*BreezService) GetNodeConnectionInfo

func (bs *BreezService) GetNodeConnectionInfo(ctx context.Context) (nodeConnectionInfo *lnclient.NodeConnectionInfo, err error)

func (*BreezService) GetNodeStatus

func (bs *BreezService) GetNodeStatus(ctx context.Context) (nodeStatus *lnclient.NodeStatus, err error)

func (*BreezService) GetOnchainBalance

func (bs *BreezService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainBalanceResponse, error)

func (*BreezService) GetStorageDir

func (bs *BreezService) GetStorageDir() (string, error)

func (*BreezService) GetSupportedNIP47Methods

func (bs *BreezService) GetSupportedNIP47Methods() []string

func (*BreezService) GetSupportedNIP47NotificationTypes

func (bs *BreezService) GetSupportedNIP47NotificationTypes() []string

func (*BreezService) ListChannels

func (bs *BreezService) ListChannels(ctx context.Context) ([]lnclient.Channel, error)

func (*BreezService) ListPeers

func (bs *BreezService) ListPeers(ctx context.Context) ([]lnclient.PeerDetails, error)

func (*BreezService) ListTransactions

func (bs *BreezService) ListTransactions(ctx context.Context, from, until, limit, offset uint64, unpaid bool, invoiceType string) (transactions []lnclient.Transaction, err error)

func (*BreezService) LookupInvoice

func (bs *BreezService) LookupInvoice(ctx context.Context, paymentHash string) (transaction *lnclient.Transaction, err error)

func (*BreezService) MakeInvoice

func (bs *BreezService) MakeInvoice(ctx context.Context, amount int64, description string, descriptionHash string, expiry int64) (transaction *lnclient.Transaction, err error)

func (*BreezService) OpenChannel

func (bs *BreezService) OpenChannel(ctx context.Context, openChannelRequest *lnclient.OpenChannelRequest) (*lnclient.OpenChannelResponse, error)

func (*BreezService) RedeemOnchainFunds

func (bs *BreezService) RedeemOnchainFunds(ctx context.Context, toAddress string) (txId string, err error)

func (*BreezService) ResetRouter

func (bs *BreezService) ResetRouter(key string) error

func (*BreezService) SendKeysend

func (bs *BreezService) SendKeysend(ctx context.Context, amount uint64, destination, preimage string, custom_records []lnclient.TLVRecord) (preImage string, err error)

func (*BreezService) SendPaymentProbes

func (bs *BreezService) SendPaymentProbes(ctx context.Context, invoice string) error

func (*BreezService) SendPaymentSync

func (bs *BreezService) SendPaymentSync(ctx context.Context, payReq string) (*lnclient.PayInvoiceResponse, error)

func (*BreezService) SendSpontaneousPaymentProbes

func (bs *BreezService) SendSpontaneousPaymentProbes(ctx context.Context, amountMsat uint64, nodeId string) error

func (*BreezService) Shutdown

func (bs *BreezService) Shutdown() error

func (*BreezService) SignMessage

func (bs *BreezService) SignMessage(ctx context.Context, message string) (string, error)

func (*BreezService) UpdateChannel

func (bs *BreezService) UpdateChannel(ctx context.Context, updateChannelRequest *lnclient.UpdateChannelRequest) error

func (*BreezService) UpdateLastWalletSyncRequest

func (bs *BreezService) UpdateLastWalletSyncRequest()