Merge JoinMarket-Org/joinmarket-clientserver#1696: RPC API endpoint to get wallet rescan status

5b47d1c906 RPC API endpoint to get wallet rescan status (Kristaps Kaupe)

Pull request description:

  https://github.com/JoinMarket-Org/joinmarket-clientserver/pull/1461#issuecomment-2079276604

Top commit has no ACKs.

Tree-SHA512: f2a641b8b601985d4b2d88f643f37540a7b247b01616d640c8f244c9762dcb5a8cbcffb8dc9b87889d54a5d0833a7753c7f0a3e77908a7208400d44e8262fe30

docs/api/wallet-rpc.yaml

@@ -240,6 +240,27 @@ paths:
           $ref: '#/components/responses/400-BadRequest'
         '404':
           $ref: '#/components/responses/404-NotFound'
+  /wallet/{walletname}/getrescaninfo:
+    get:
+      security:
+        - bearerAuth: []
+      summary: get the current rescan status
+      operationId: getrescaninfo
+      description: get the current rescan status
+      parameters:
+        - name: walletname
+          in: path
+          description: name of wallet including .jmdat
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          $ref: '#/components/responses/RescanInfo-200-OK'
+        '400':
+          $ref: '#/components/responses/400-BadRequest'
+        '404':
+          $ref: '#/components/responses/404-NotFound'
   /wallet/{walletname}/address/timelock/new/{lockdate}:
     get:
       security:
@@ -805,6 +826,16 @@ components:
         walletname:
           type: string
           example: "wallet.jmdat"
+    RescanInfoResponse:
+      type: object
+      required:
+        - rescanning
+      properties:
+        rescanning:
+          type: boolean
+        progress:
+          type: number
+          example: 0.04665404082350701
     SessionResponse:
       type: object
       required:
@@ -1190,6 +1221,12 @@ components:
         application/json:
           schema:
             $ref: "#/components/schemas/RescanBlockchainResponse"
+    RescanInfo-200-OK:
+      description: "Blockchain rescan status retrieved successfully"
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/RescanInfoResponse"
     Create-201-OK:
       description: "wallet created successfully"
       content:

src/jmclient/wallet_rpc.py

@@ -692,6 +692,29 @@ class JMWalletDaemon(Service):
                 self.services["wallet"].rescanblockchain(blockheight)
                 return make_jmwalletd_response(request, walletname=walletname)
 
+        @app.route('/wallet/<string:walletname>/getrescaninfo', methods=['GET'])
+        def getrescaninfo(self, request, walletname):
+            """ This route lets the user get the current rescan status.
+            """
+            print_req(request)
+            self.check_cookie(request)
+            if not self.services["wallet"]:
+                jlog.warn("getrescaninfo called, but no wallet service active.")
+                raise NoWalletFound()
+            if not self.wallet_name == walletname:
+                jlog.warn("called getrescaninfo with wrong wallet")
+                raise InvalidRequestFormat()
+            else:
+                rescanning, progress = \
+                    self.services["wallet"].get_backend_wallet_rescan_status()
+                if rescanning:
+                    return make_jmwalletd_response(request,
+                        walletname=walletname, rescanning=rescanning,
+                        progress=progress)
+                else:
+                    return make_jmwalletd_response(request,
+                        walletname=walletname, rescanning=rescanning)
+
         @app.route('/getinfo', methods=['GET'])
         def version(self, request):
             """ This route sends information about the backend, including