aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 23:24:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add documentation for --recover flag.

Browse Source
This commit is contained in:
adi2011
2023-07-31 09:06:36 +09:30
committed by Rusty Russell
parent 51f72c1d1d
commit 97bc3ae20a
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/developers-guide/plugin-development/hooks.md
View File

@@ -57,6 +57,19 @@ The returned result must contain a `result` member which is either the string `d
Note that `peer_connected` is a chained hook. The first plugin that decides to `disconnect` with or without an `error_message` will lead to the subsequent plugins not being called anymore.
### `recover`
This hook is called whenever the node is started using the --recovery flag. So basically whenever a user wants to recover their node with a codex32 secret, they can use --recover=<codex32secret> to use that secret as their HSM Secret.
The payload consists of the following information:
```json
{
"codex32": "ms10leetsllhdmn9m42vcsamx24zrxgs3qrl7ahwvhw4fnzrhve25gvezzyqqtum9pgv99ycma"
}
```
This hook is intended to be used for recovering the node and funds by connecting to some known peers who keep your peer storage backups with them.
### `commitment_revocation`
This hook is called whenever a channel state is updated, and the old state was revoked. State updates in Lightning consist of the following steps: