https://github.com/hieblmi/go-lnd-router-events
Subscribe to your Lightning Network LND node to receive notifications about routing events
https://github.com/hieblmi/go-lnd-router-events
htlc htlc-events lightning lightning-component lightning-network lnd lnd-node lnd-router
Last synced: 8 months ago
JSON representation
Subscribe to your Lightning Network LND node to receive notifications about routing events
- Host: GitHub
- URL: https://github.com/hieblmi/go-lnd-router-events
- Owner: hieblmi
- Created: 2021-09-21T22:32:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T20:36:38.000Z (almost 4 years ago)
- Last Synced: 2024-11-08T11:57:14.427Z (11 months ago)
- Topics: htlc, htlc-events, lightning, lightning-component, lightning-network, lnd, lnd-node, lnd-router
- Language: Go
- Homepage:
- Size: 63.5 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⚡go-lnd-router-events
This module allows subscribers to get notified about [HTLC](https://rusty.ozlabs.org/?p=462) [SettleEvent](https://api.lightning.community/#routerrpc-settleevent)s and [InvoiceEvent](https://api.lightning.community/?python#subscribeinvoices)s.
A subscripiton to HTLC events retrieve the following statistics from its related preceeding [ForwardEvent](https://api.lightning.community/#routerrpc-forwardevent):
```
* FromPubKey
* FromAlias
* IncomingMSats
* ToAlias
* ToPubKey
* OutgoingMSats
* ChanId_In
* ChanId_Out
* HtlcId_In
* HtlcId_Out
```
A subscripiton to invoice events retrieves the invoice related fields:
```
* IsSettled
* SettleAmount_msat
* Preimage
```
## Installation
```
go get github.com/hieblmi/go-lnd-router-events
```
## How it works
LND's router RPC interface allows to listen to [ForwardEvent](https://api.lightning.community/#routerrpc-forwardevent)s that basically represent an attempt from an initiating peer on a route to push a payment through our node. The successful forward events can be obtained by clients who implement
```
type Observer interface {
Update(event *Event)
GetName() string
}
```
and register their observer, in this case for forward settlements:
```
listener := events.New(&events.Config{
MacaroonPath: config.MacaroonPath,
CertPath: config.CertPath,
RpcHost: config.RpcHost,
})
listener.Register(&LndEventObserver{
Name: "YourObserverName",
}, events.Forward)
listener.Start()
```
The update method then receives successful forward events:
```
func (o *yourObserver) Update(e *events.Event) {
fmt.Println(e.Type)
fmt.Println(e.IncomingMSats)
fmt.Println(e.OutgoingMSats)
}
```
### Little more detail
To retrieve the details of a successful payment we have to match the SettleEvent's ids to the ids of the preceeding ForwardEvent. In this instance this is solved by keeping a map of [key|ForwardEvent] and retrieve a given forward attempt when the respective SettleEvent occurs. The key is calculated by
```
IncomingChannelId + OutgoingChannelId + IncomingHtlcId + OutgoingHtlcId
```
In case the payment through our node isn't successful we will observe a [ForwardFailEvent](https://api.lightning.community/#routerrpc-forwardfailevent) or [LinkFailEvent](https://api.lightning.community/#routerrpc-linkfailevent). In these cases we simply remove the respective ForwardEvent from our map.
### Disclaimer
This stuff is experimental so do use it with care. I am highly appreciative of feedback and ways to improve my understanding of everything Lightning.
If you like what you see you could send me a tip :-)
Download a [LightningAddress](https://lightningaddress.com/) enabled wallet like [Blixt](https://blixtwallet.github.io/) or [BlueWallet](https://bluewallet.io/) and tip to: ⚡tips@allmysats.com