lightning_api

Nov 18, 2022

Changes in this version

+ const GETINFO

+ const LISTCHANNELS

+ const LISTFUNDS

+ const LISTNODES

+ var ErrInvalidResponse = errors.New("invalid response")

+ var ErrNoChan = errors.New("channel not found")

+ var ErrNoNode = errors.New("node not found")

+ func ConvertAmount(s string) uint64

+ func ConvertFeatures(features string) map[string]NodeFeatureApi

+ func FromLndChanId(chanId uint64) string

+ func SumCapacityExtended(channels []NodeChannelApiExtended) uint64

+ func SumCapacitySimple(channels []NodeChannelApi) uint64

+ func ToLndChanId(id string) (uint64, error)

type ApiType

+ const CLN_SOCKET

+ type ClnFeatures struct

+ Channel string

+ Init string

+ Invoice string

+ Node string

+ type ClnFundsChan struct

+ Capacity uint64

+ Connected bool

+ FundingOutput int

+ FundingTxId string

+ OurAmount uint64

+ PeerId string

+ ShortChannelId string

+ State string

+ type ClnFundsChanResp struct

+ Channels []ClnFundsChan

+ type ClnInfo struct

+ Addresses []ClnListNodeAddr

+ Alias string

+ Color string

+ Features ClnFeatures

+ Network string

+ PubKey string

+ type ClnListChan struct

+ Active bool

+ Capacity uint64

+ Delay uint64

+ Destination string

+ FeeBase uint64

+ FeePpm uint64

+ LastUpdate entities.JsonTime

+ MaxHtlc string

+ MinHtlc string

+ Public bool

+ ShortChannelId string

+ Source string

+ type ClnListChanResp struct

+ Channels []ClnListChan

+ type ClnListNode struct

+ Addresses []ClnListNodeAddr

+ Alias string

+ Color string

+ Features string

+ LastUpdate *entities.JsonTime

+ PubKey string

+ type ClnListNodeAddr struct

+ Address string

+ Port int

+ Type string

+ type ClnListNodeResp struct

+ Nodes []ClnListNode

+ type ClnSetChan struct

+ FeeBase string

+ FeePpm string

+ LongChanId string

+ MaxHtlc string

+ MiHtlc string

+ PeerId string

+ ShortChannelId string

+ type ClnSetChanResp struct

+ Settings []ClnSetChan

+ type ClnSocketLightningApi struct

+ Client *rpc.Client

+ Timeout time.Duration

+ func (l *ClnSocketLightningApi) CallWithTimeout(serviceMethod string, args any, reply any) error

+ func (l *ClnSocketLightningApi) Cleanup()

+ func (l *ClnSocketLightningApi) DescribeGraph(ctx context.Context, unannounced bool) (*DescribeGraphApi, error)

+ func (l *ClnSocketLightningApi) GetChanInfo(ctx context.Context, chanId uint64) (*NodeChannelApi, error)

+ func (l *ClnSocketLightningApi) GetChannels(ctx context.Context) (*ChannelsApi, error)

+ func (l *ClnSocketLightningApi) GetInfo(ctx context.Context) (*InfoApi, error)

+ func (l *ClnSocketLightningApi) GetInternalChannels(pubKey string) (map[string][]ClnListChan, error)

+ func (l *ClnSocketLightningApi) GetInternalChannelsAll() (map[string][]ClnListChan, error)

+ func (l *ClnSocketLightningApi) GetNodeInfo(ctx context.Context, pubKey string, channels bool) (*NodeInfoApi, error)

+ func (l *ClnSocketLightningApi) GetNodeInfoFull(ctx context.Context, channels bool, unannounced bool) (*NodeInfoApiExtended, error)

type DescribeGraphNodeApi

+ func ConvertNodeInfo(node ClnListNode) *DescribeGraphNodeApi

type LightingApiCalls

+ func NewClnSocketLightningApi(getData GetDataCall) LightingApiCalls

+ func NewClnSocketLightningApiRaw(socketType string, address string) LightingApiCalls

type NodeAddressApi

+ func ConvertAddresses(addr []ClnListNodeAddr) []NodeAddressApi

type NodeChannelApiExtended

+ func ConvertChannelInternal(chans []ClnListChan, id uint64) (*NodeChannelApiExtended, error)

Oct 21, 2022

Changes in this version

type CertificateVerification

+ const SKIP_HOST_VERIFICATION

Oct 17, 2022

Changes in this version

type ChannelOverride

+ AliasScids []string

+ ZeroConfConfirmedScid string

Oct 15, 2022

Changes in this version

+ type CertificateVerification int

+ const ALLOW_WHEN_PUBKEY_SAME

+ const INSECURE

+ const PUBLIC_CA

+ const PUBLIC_CA_OR_CERT

+ const STRICT

Sep 15, 2022

Changes in this version

type DescribeGraphNodeApi

+ LastUpdate entities.JsonTime

type NodeChannelApi

+ LastUpdate entities.JsonTime

Sep 11, 2022

Changes in this version

+ type NodeChannelApiExtended struct

+ Private bool

+ type NodeInfoApiExtended struct

+ Channels []NodeChannelApiExtended

Aug 26, 2022

Changes in this version

type DescribeGraphNodeApi

+ Addresses []NodeAddressApi

+ Color string

+ Features map[string]NodeFeatureApi

+ type GetNodeInfoOverride struct

+ Channels []*GraphEdgeOverride

+ Node *GraphNodeOverride

+ NumChannels int64

+ TotalCapacity string

type HttpApi

+ func (h *HttpApi) HttpGetChanInfo(ctx context.Context, req *http.Request, trans *http.Transport, chanId uint64) (*GraphEdgeOverride, error)

+ func (h *HttpApi) HttpGetNodeInfo(ctx context.Context, req *http.Request, trans *http.Transport, pubKey string, ...) (*GetNodeInfoOverride, error)

type LightingApiCalls

+ GetChanInfo func(ctx context.Context, chanId uint64) (*NodeChannelApi, error)

+ GetNodeInfo func(ctx context.Context, pubKey string, channels bool) (*NodeInfoApi, error)

+ GetNodeInfoFull func(ctx context.Context, channels, unannounced bool) (*NodeInfoApi, error)

type LightningApi

+ GetNodeInfoFullThreshUseDescribeGraph int

type LndGrpcLightningApi

+ func (l *LndGrpcLightningApi) GetChanInfo(ctx context.Context, chanId uint64) (*NodeChannelApi, error)

+ func (l *LndGrpcLightningApi) GetNodeInfo(ctx context.Context, pubKey string, channels bool) (*NodeInfoApi, error)

+ func (l *LndGrpcLightningApi) GetNodeInfoFull(ctx context.Context, channels, unnanounced bool) (*NodeInfoApi, error)

type LndRestLightningApi

+ func (l *LndRestLightningApi) GetChanInfo(ctx context.Context, chanId uint64) (*NodeChannelApi, error)

+ func (l *LndRestLightningApi) GetNodeInfo(ctx context.Context, pubKey string, channels bool) (*NodeInfoApi, error)

+ func (l *LndRestLightningApi) GetNodeInfoFull(ctx context.Context, channels, unnanounced bool) (*NodeInfoApi, error)

+ type NodeAddressApi struct

+ Addr string

+ Network string

+ type NodeChannelApi struct

+ Capacity uint64

+ ChanPoint string

+ ChannelId uint64

+ Node1Policy *RoutingPolicyApi

+ Node1Pub string

+ Node2Policy *RoutingPolicyApi

+ Node2Pub string

+ type NodeFeatureApi struct

+ IsKnown bool

+ IsRequired bool

+ Name string

+ type NodeInfoApi struct

+ Channels []NodeChannelApi

+ Node DescribeGraphNodeApi

+ NumChannels uint32

+ TotalCapacity uint64

Aug 18, 2022

Changes in this version

+ func GetClient(getData GetDataCall) (lnrpc.LightningClient, func(), error)

+ func GetConnection(getData GetDataCall) (*grpc.ClientConn, error)

+ func IsMacaroonValid(mac *macaroon.Macaroon) (bool, time.Duration)

+ type ApiType int

+ const LND_GRPC

+ const LND_REST

+ func GetApiType(t *int) (*ApiType, error)

+ type ChannelApi struct

+ Active bool

+ Capacity uint64

+ ChanId uint64

+ CommitFee uint64

+ Initiator bool

+ LocalBalance uint64

+ NumUpdates uint64

+ PendingHtlcs []HtlcApi

+ Private bool

+ RemoteBalance uint64

+ RemotePubkey string

+ TotalSatoshisReceived uint64

+ TotalSatoshisSent uint64

+ type ChannelConstraintsOverride struct

+ ChanReserveSat string

+ DustLimitSat string

+ MaxPendingAmtMsat string

+ MinHtlcMsat string

+ type ChannelOverride struct

+ Capacity string

+ ChanId string

+ CommitFee string

+ CommitWeight string

+ CommitmentType string

+ FeePerKw string

+ Lifetime string

+ LocalBalance string

+ LocalChanReserveSat string

+ LocalConstraints *ChannelConstraintsOverride

+ NumUpdates string

+ PendingHtlcs []*HtlcOverride

+ PushAmountSat string

+ RemoteBalance string

+ RemoteChanReserveSat string

+ RemoteConstraints *ChannelConstraintsOverride

+ TotalSatoshisReceived string

+ TotalSatoshisSent string

+ UnsettledBalance string

+ Uptime string

+ type Channels struct

+ Channels []*ChannelOverride

+ type ChannelsApi struct

+ Channels []ChannelApi

+ type DescribeGraphApi struct

+ Channels []DescribeGraphChannelApi

+ Nodes []DescribeGraphNodeApi

+ type DescribeGraphChannelApi struct

+ Capacity uint64

+ ChanPoint string

+ ChannelId uint64

+ Node1Policy *RoutingPolicyApi

+ Node1Pub string

+ Node2Policy *RoutingPolicyApi

+ Node2Pub string

+ type DescribeGraphNodeApi struct

+ Alias string

+ PubKey string

+ type GetDataCall func() (*entities.Data, error)

+ type GetDoFunc func(req *http.Request) (*http.Response, error)

+ type GetInfoResponseOverride struct

+ BestHeaderTimestamp string

+ type Graph struct

+ GraphEdgesOverride []*GraphEdgeOverride

+ GraphNodeOverride []*GraphNodeOverride

+ type GraphEdgeOverride struct

+ Capacity string

+ ChannelId string

+ Node1Policy *RoutingPolicyOverride

+ Node2Policy *RoutingPolicyOverride

+ type GraphNodeOverride struct

+ type HtlcApi struct

+ Amount uint64

+ ForwardingChannel uint64

+ ForwardingHtlcIndex uint64

+ Incoming bool

+ type HtlcOverride struct

+ Amount string

+ ForwardingChannel string

+ ForwardingHtlcIndex string

+ HashLock string

+ HtlcIndex string

+ type HttpApi struct

+ DoFunc GetDoFunc

+ func NewHttpApi() *HttpApi

+ func (h *HttpApi) Do(req *http.Request) (*http.Response, error)

+ func (h *HttpApi) GetHttpRequest(getData GetDataCall) (*http.Request, *http.Transport, error)

+ func (h *HttpApi) HttpGetChannels(ctx context.Context, req *http.Request, trans *http.Transport) (*Channels, error)

+ func (h *HttpApi) HttpGetGraph(ctx context.Context, req *http.Request, trans *http.Transport, ...) (*Graph, error)

+ func (h *HttpApi) HttpGetInfo(ctx context.Context, req *http.Request, trans *http.Transport) (*GetInfoResponseOverride, error)

+ func (h *HttpApi) SetTransport(transport *http.Transport)

+ type InfoApi struct

+ Alias string

+ Chain string

+ IdentityPubkey string

+ Network string

+ type LightingApiCalls interface

+ Cleanup func()

+ DescribeGraph func(ctx context.Context, unannounced bool) (*DescribeGraphApi, error)

+ GetChannels func(ctx context.Context) (*ChannelsApi, error)

+ GetInfo func(ctx context.Context) (*InfoApi, error)

+ func NewApi(apiType ApiType, getData GetDataCall) LightingApiCalls

+ func NewLndGrpcLightningApi(getData GetDataCall) LightingApiCalls

+ func NewLndRestLightningApi(getData GetDataCall) LightingApiCalls

+ type LightningApi struct

+ type LndGrpcLightningApi struct

+ CleanupFunc func()

+ Client lnrpc.LightningClient

+ func (l *LndGrpcLightningApi) Cleanup()

+ func (l *LndGrpcLightningApi) DescribeGraph(ctx context.Context, unannounced bool) (*DescribeGraphApi, error)

+ func (l *LndGrpcLightningApi) GetChannels(ctx context.Context) (*ChannelsApi, error)

+ func (l *LndGrpcLightningApi) GetInfo(ctx context.Context) (*InfoApi, error)

+ type LndRestLightningApi struct

+ HttpApi *HttpApi

+ Request *http.Request

+ Transport *http.Transport

+ func (l *LndRestLightningApi) Cleanup()

+ func (l *LndRestLightningApi) DescribeGraph(ctx context.Context, unannounced bool) (*DescribeGraphApi, error)

+ func (l *LndRestLightningApi) GetChannels(ctx context.Context) (*ChannelsApi, error)

+ func (l *LndRestLightningApi) GetInfo(ctx context.Context) (*InfoApi, error)

+ type RoutingPolicyApi struct

+ BaseFee uint64

+ Disabled bool

+ FeeRate uint64

+ LastUpdate time.Time

+ MaxHtlc uint64

+ MinHtlc uint64

+ TimeLockDelta uint32

+ type RoutingPolicyOverride struct

+ FeeBaseMsat string

+ FeeRateMilliMsat string

+ MaxHtlcMsat string

+ MinHtlc string