home | help
LIGHTNING-HOOK-RECOVER(7)			       LIGHTNING-HOOK-RECOVER(7)

NAME
     recover -- Hook fired when node starts in recovery mode

DESCRIPTION
     Hook added in v23.08.

     The  recover hook is called whenever the node is started using the --recov-
     ery flag.	It provides the codex32 secret used to derive  the  HSM  secret.
     Plugins can use this to reconnect to peers who keep your peer storage back-
     ups with them and recover state or funds.

     This  hook  is  informational  and  does not allow altering execution flow.
     Plugins are expected to perform recovery-related side effects such  as  re-
     connecting to peers.

HOOK PAYLOAD
     *	codex32  (string):  The  codex32-encoded  secret provided via --recover.
	Used to reconstruct the node's HSM secret.

HOOK RETURN
     *	result (string) (always "continue"): Returning "continue" resumes normal
	execution.

Core Lightning v26.06.1 			       LIGHTNING-HOOK-RECOVER(7)

home | help