client

Documentation

Index

• type ChannelsBalanceStats
• type LightningClient
  • func NewLightningClient(rpcclient lnrpc.LightningClient) (*LightningClient, error)
  • func (client *LightningClient) GetChannelsBalanceStats() (*ChannelsBalanceStats, error)
  • func (client *LightningClient) GetInfoStats() (*NodeStats, error)
  • func (client *LightningClient) GetPendingChannelsStats() (*PendingChannelsStats, error)
  • func (client *LightningClient) GetStats() (*lnrpc.GetInfoResponse, error)
  • func (client *LightningClient) GetWalletStats() (*WalletStats, error)
• type NodeStats
• type PendingChannelsStats
• type WalletStats

Types

type ChannelsBalanceStats

type ChannelsBalanceStats struct {
	TotalBalance int64
}

type LightningClient

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

LightningClient allows you to fetch Lightning node metrics from rpc.

func NewLightningClient

func NewLightningClient(rpcclient lnrpc.LightningClient) (*LightningClient, error)

NewLightningClient creates an LightningClient.

func (*LightningClient) GetChannelsBalanceStats

func (client *LightningClient) GetChannelsBalanceStats() (*ChannelsBalanceStats, error)

GetChannelsBalanceStats get pending channels status

func (*LightningClient) GetInfoStats

func (client *LightningClient) GetInfoStats() (*NodeStats, error)

GetInfoStats gets general node info

func (*LightningClient) GetPendingChannelsStats

func (client *LightningClient) GetPendingChannelsStats() (*PendingChannelsStats, error)

GetPendingChannelsStats get pending channels status

func (*LightningClient) GetStats

func (client *LightningClient) GetStats() (*lnrpc.GetInfoResponse, error)

GetStats fetches the node metrics.

func (*LightningClient) GetWalletStats

func (client *LightningClient) GetWalletStats() (*WalletStats, error)

GetWalletStats get wallet balances

type NodeStats

type NodeStats struct {
	Peers            uint32
	PendingChannels  uint32
	ActiveChannels   uint32
	InactiveChannels uint32
	BlockHeight      uint32
	SyncedToChain    uint8
}

type PendingChannelsStats

type PendingChannelsStats struct {
	TotalLimboBalance           int64
	PendingOpenChannels         int
	PendingClosingChannels      int
	PendingForceClosingChannels int
	WaitingCloseChannels        int
}

type WalletStats

type WalletStats struct {
	TotalBallance      int64
	ConfirmedBalance   int64
	UnconfirmedBalance int64
}