multi: add a rpc endpoint to track the recovery process

Author: yyforyongyu

cmd/lncli/commands.go

@@ -1729,6 +1729,27 @@ func getInfo(ctx *cli.Context) error {
 	return nil
 }
 
+var getRecoveryInfoCommand = cli.Command{
+	Name:   "getrecoveryinfo",
+	Usage:  "Display information about an ongoing recovery attempt.",
+	Action: actionDecorator(getRecoveryInfo),
+}
+
+func getRecoveryInfo(ctx *cli.Context) error {
+	ctxb := context.Background()
+	client, cleanUp := getClient(ctx)
+	defer cleanUp()
+
+	req := &lnrpc.GetRecoveryInfoRequest{}
+	resp, err := client.GetRecoveryInfo(ctxb, req)
+	if err != nil {
+		return err
+	}
+
+	printRespJSON(resp)
+	return nil
+}
+
 var pendingChannelsCommand = cli.Command{
 	Name:     "pendingchannels",
 	Category: "Channels",

cmd/lncli/main.go

@@ -271,6 +271,7 @@ func main() {
 		walletBalanceCommand,
 		channelBalanceCommand,
 		getInfoCommand,
+		getRecoveryInfoCommand,
 		pendingChannelsCommand,
 		sendPaymentCommand,
 		payInvoiceCommand,

docs/recovery.md

@@ -164,7 +164,15 @@ That final line indicates the rescan is complete! If not all funds have
 appeared, then the user may need to _repeat_ the process with a higher recovery
 window. Depending on how old the wallet is (the cipher seed stores the wallet's
 birthday!) and how many addresses were used, the rescan may take anywhere from
-a few minutes to a few hours.
+a few minutes to a few hours. To track the recovery progress, one can use the
+command `lncli getrecoveryinfo`. When finished, the following is returned,
+```
+{
+    "recovery_mode": true,
+    "recovery_finished": true,
+    "progress": 1
+}
+```
 
 If the rescan wasn't able to complete fully (`lnd` was shutdown for example),
 then from `lncli unlock`, it's possible to _restart_ the rescan from where it

lnrpc/README.md

@@ -55,6 +55,8 @@ description):
      * Lists all available connected peers.
   * GetInfo
      * Returns basic data concerning the daemon.
+  * GetRecoveryInfo
+     * Returns information about recovery process.
   * PendingChannels
      * List the number of pending (not fully confirmed) channels.
   * ListChannels

lnrpc/rest-annotations.yaml

@@ -41,6 +41,8 @@ http:
       get: "/v1/peers/subscribe"
     - selector: lnrpc.Lightning.GetInfo
       get: "/v1/getinfo"
+    - selector: lnrpc.Lightning.GetRecoveryInfo
+      get: "/v1/getrecoveryinfo"
     - selector: lnrpc.Lightning.PendingChannels
       get: "/v1/channels/pending"
     - selector: lnrpc.Lightning.ListChannels

lnrpc/routerrpc/router.pb.go

@@ -98,15 +98,16 @@ service Router {
     rpc TrackPayment (TrackPaymentRequest) returns (stream PaymentStatus) {
         option deprecated = true;
     }
-    
+
     /**
     HtlcInterceptor dispatches a bi-directional streaming RPC in which
     Forwarded HTLC requests are sent to the client and the client responds with
     a boolean that tells LND if this htlc should be intercepted.
     In case of interception, the htlc can be either settled, cancelled or
     resumed later by using the ResolveHoldForward endpoint.
     */
-    rpc HtlcInterceptor (stream ForwardHtlcInterceptResponse) returns (stream ForwardHtlcInterceptRequest);
+    rpc HtlcInterceptor (stream ForwardHtlcInterceptResponse)
+        returns (stream ForwardHtlcInterceptRequest);
 }
 
 message SendPaymentRequest {
@@ -589,7 +590,7 @@ message PaymentStatus {
     repeated lnrpc.HTLCAttempt htlcs = 4;
 }
 
-message CircuitKey {    
+message CircuitKey {
     /// The id of the channel that the is part of this circuit.
     uint64 chan_id = 1;
 
@@ -618,14 +619,14 @@ message ForwardHtlcInterceptRequest {
 }
 
 /**
-ForwardHtlcInterceptResponse enables the caller to resolve a previously hold forward.
-The caller can choose either to:
+ForwardHtlcInterceptResponse enables the caller to resolve a previously hold
+forward. The caller can choose either to:
 - `Resume`: Execute the default behavior (usually forward).
 - `Reject`: Fail the htlc backwards.
 - `Settle`: Settle this htlc with a given preimage.
 */
 message ForwardHtlcInterceptResponse {
-    /** 
+    /**
     The key of this forwarded htlc. It defines the incoming channel id and
     the index in this channel.
     */
@@ -638,9 +639,8 @@ message ForwardHtlcInterceptResponse {
     bytes preimage = 3;
 }
 
-enum ResolveHoldForwardAction {    
+enum ResolveHoldForwardAction {
     SETTLE = 0;
     FAIL = 1;
-    RESUME = 2;    
+    RESUME = 2;
 }
-