Skip to content

Commit 7782e3d

Browse files
include LSPS5 on lightning-liquidity README
1 parent 20bcf4f commit 7782e3d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lightning-liquidity/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,15 @@ inbound Lightning liquidity for which they are willing and able to pay in bitcoi
1414
on-boarding of clients as the channel opening fees are deducted from the
1515
incoming payment, i.e., no funds are required client-side to initiate this
1616
flow.
17+
- [bLIP-55 / LSPS5] lets a client register HTTPS webhooks with its LSP so the LSP can send signed push
18+
notifications (for example "payment incoming") that wake the app when it is offline, which is essential
19+
for mobile wallets that get suspended in the background.
1720

18-
To get started, you'll want to setup a `LiquidityManager` and configure it to be the `CustomMessageHandler` of your LDK node. You can then call `LiquidityManager::lsps1_client_handler` / `LiquidityManager::lsps2_client_handler`, or `LiquidityManager::lsps2_service_handler`, to access the respective client-side or service-side handlers.
21+
To get started, you'll want to setup a `LiquidityManager` and configure it to be the `CustomMessageHandler` of your LDK node. You can then call `LiquidityManager::lsps1_client_handler` / `LiquidityManager::lsps2_client_handler`, `LiquidityManager::lsps2_service_handler`, `LiquidityManager::lsps5_service_handler` or `LiquidityManager::lsps5_client_handler` to access the respective client-side or service-side handlers.
1922

2023
`LiquidityManager` uses an eventing system to notify the user about important updates to the protocol flow. To this end, you will need to handle events emitted via one of the event handling methods provided by `LiquidityManager`, e.g., `LiquidityManager::next_event`.
2124

2225
[bLIP-50 / LSPS0]: https://github.com/lightning/blips/blob/master/blip-0050.md
2326
[bLIP-51 / LSPS1]: https://github.com/lightning/blips/blob/master/blip-0051.md
2427
[bLIP-52 / LSPS2]: https://github.com/lightning/blips/blob/master/blip-0052.md
28+
[bLIP-55 / LSPS5]: https://github.com/lightning/blips/blob/master/blip-0055.md

0 commit comments

Comments
 (0)