cln

Documentation

Index

• Variables
• type ClnClient
  • func NewClnClient(config *config.ClnConfig) (*ClnClient, error)
  • func (c *ClnClient) GetChannel(peerID []byte, channelPoint wire.OutPoint) (*lightning.GetChannelResult, error)
  • func (c *ClnClient) GetClosedChannels(nodeID string, channelPoints map[string]uint64) (map[string]uint64, error)
  • func (c *ClnClient) GetInfo() (*lightning.GetInfoResult, error)
  • func (c *ClnClient) GetPeerId(scid *lightning.ShortChannelID) ([]byte, error)
  • func (c *ClnClient) IsConnected(destination []byte) (bool, error)
  • func (c *ClnClient) ListChannels() ([]*lightning.Channel, error)
  • func (c *ClnClient) OpenChannel(req *lightning.OpenChannelRequest) (*wire.OutPoint, error)
  • func (c *ClnClient) WaitChannelActive(peerID []byte, deadline time.Time) error
  • func (c *ClnClient) WaitOnline(peerID []byte, deadline time.Time) error
• type ClnHtlcInterceptor
  • func NewClnHtlcInterceptor(conf *config.NodeConfig, client *ClnClient, ...) (*ClnHtlcInterceptor, error)
  • func (i *ClnHtlcInterceptor) Start() error
  • func (i *ClnHtlcInterceptor) Stop() error
  • func (i *ClnHtlcInterceptor) WaitStarted()
• type CustomMsgClient
  • func NewCustomMsgClient(conf *config.ClnConfig, client *ClnClient) *CustomMsgClient
  • func (c *CustomMsgClient) Recv() (*lightning.CustomMessage, error)
  • func (c *CustomMsgClient) Send(msg *lightning.CustomMessage) error
  • func (c *CustomMsgClient) Start() error
  • func (i *CustomMsgClient) Stop() error
  • func (i *CustomMsgClient) WaitStarted()
• type ForwardSync
  • func NewForwardSync(nodeid []byte, client *ClnClient, store history.Store) *ForwardSync
  • func (s *ForwardSync) ForwardsSynchronize(ctx context.Context)

Variables

var (
	OPEN_STATUSES = []int32{
		int32(rpc.ListpeerchannelsChannels_CHANNELD_NORMAL),
	}
	PENDING_STATUSES = []int32{
		int32(rpc.ListpeerchannelsChannels_OPENINGD),
		int32(rpc.ListpeerchannelsChannels_CHANNELD_AWAITING_LOCKIN),
		int32(rpc.ListpeerchannelsChannels_DUALOPEND_OPEN_INIT),
		int32(rpc.ListpeerchannelsChannels_DUALOPEND_AWAITING_LOCKIN),
		int32(rpc.ListpeerchannelsChannels_CHANNELD_AWAITING_SPLICE),
		int32(rpc.ListpeerchannelsChannels_DUALOPEND_OPEN_COMMITTED),
		int32(rpc.ListpeerchannelsChannels_DUALOPEND_OPEN_COMMIT_READY),
	}
	CLOSING_STATUSES = []int32{
		int32(rpc.ListpeerchannelsChannels_CHANNELD_SHUTTING_DOWN),
		int32(rpc.ListpeerchannelsChannels_CLOSINGD_SIGEXCHANGE),
		int32(rpc.ListpeerchannelsChannels_CLOSINGD_COMPLETE),
		int32(rpc.ListpeerchannelsChannels_AWAITING_UNILATERAL),
		int32(rpc.ListpeerchannelsChannels_FUNDING_SPEND_SEEN),
		int32(rpc.ListpeerchannelsChannels_ONCHAIN),
	}
)

Types

type ClnClient

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

func NewClnClient

func NewClnClient(config *config.ClnConfig) (*ClnClient, error)

func (*ClnClient) GetChannel

func (c *ClnClient) GetChannel(peerID []byte, channelPoint wire.OutPoint) (*lightning.GetChannelResult, error)

func (*ClnClient) GetClosedChannels

func (c *ClnClient) GetClosedChannels(
	nodeID string,
	channelPoints map[string]uint64,
) (map[string]uint64, error)

func (*ClnClient) GetInfo

func (c *ClnClient) GetInfo() (*lightning.GetInfoResult, error)

func (*ClnClient) GetPeerId

func (c *ClnClient) GetPeerId(scid *lightning.ShortChannelID) ([]byte, error)

func (*ClnClient) IsConnected

func (c *ClnClient) IsConnected(destination []byte) (bool, error)

func (*ClnClient) ListChannels

func (c *ClnClient) ListChannels() ([]*lightning.Channel, error)

func (*ClnClient) OpenChannel

func (c *ClnClient) OpenChannel(req *lightning.OpenChannelRequest) (*wire.OutPoint, error)

func (*ClnClient) WaitChannelActive

func (c *ClnClient) WaitChannelActive(peerID []byte, deadline time.Time) error

func (*ClnClient) WaitOnline

func (c *ClnClient) WaitOnline(peerID []byte, deadline time.Time) error

type ClnHtlcInterceptor

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

func NewClnHtlcInterceptor

func NewClnHtlcInterceptor(conf *config.NodeConfig, client *ClnClient, interceptor common.InterceptHandler) (*ClnHtlcInterceptor, error)

func (*ClnHtlcInterceptor) Start

func (i *ClnHtlcInterceptor) Start() error

func (*ClnHtlcInterceptor) Stop

func (i *ClnHtlcInterceptor) Stop() error

func (*ClnHtlcInterceptor) WaitStarted

func (i *ClnHtlcInterceptor) WaitStarted()

type CustomMsgClient

type CustomMsgClient struct {
	lightning.CustomMsgClient
	// contains filtered or unexported fields
}

func NewCustomMsgClient

func NewCustomMsgClient(conf *config.ClnConfig, client *ClnClient) *CustomMsgClient

func (*CustomMsgClient) Recv

func (c *CustomMsgClient) Recv() (*lightning.CustomMessage, error)

func (*CustomMsgClient) Send

func (c *CustomMsgClient) Send(msg *lightning.CustomMessage) error

func (*CustomMsgClient) Start

func (c *CustomMsgClient) Start() error

func (*CustomMsgClient) Stop

func (i *CustomMsgClient) Stop() error

func (*CustomMsgClient) WaitStarted

func (i *CustomMsgClient) WaitStarted()

type ForwardSync

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

func NewForwardSync

func NewForwardSync(nodeid []byte, client *ClnClient, store history.Store) *ForwardSync

func (*ForwardSync) ForwardsSynchronize

func (s *ForwardSync) ForwardsSynchronize(ctx context.Context)