fix: add finalizedKey query param to /blocks/{blockId} (#1362)

* add build to inspect * fix: add `finalized` query param to `/blocks/{blockId}` * docs * change key to finalizedKey
paritytech · Nov 29, 2023 · ecd1518 · ecd1518
1 parent 87d2092
commit ecd1518
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/docs/dist/app.bundle.js b/docs/dist/app.bundle.js
diff --git a/docs/src/openapi-v1.yaml b/docs/src/openapi-v1.yaml
@@ -621,6 +621,14 @@ paths:
         schema:
           type: boolean
           default: false
+      - name: finalizedKey
+        in: query
+        description: When set to false, this will override the chain-config, and omit the
+          finalized key in the response. This can increase performance slightly by avoiding an additional 
+          RPC call to the node.
+        required: false
+        schema:
+          type: boolean
       responses:
         "200":
           description: successful operation

diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
     "main": "node ./build/src/main.js",
     "dev": "ts-node-dev --respawn --transpile-only ./src/main.ts",
     "deploy": "yarn build && npm publish",
-    "inspect": "node --inspect=127.0.0.1:8081 ./build/src/main.js",
+    "inspect": "yarn build && node --inspect=127.0.0.1:8081 ./build/src/main.js",
     "build": "substrate-exec-rimraf build/ && substrate-exec-tsc && echo Build Finished",
     "build:calc": "bash ./calc/build.sh",
     "build:docker": "docker build -t substrate-api-sidecar .",

diff --git a/src/controllers/blocks/BlocksController.ts b/src/controllers/blocks/BlocksController.ts
@@ -159,7 +159,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 	 * @param res Express Response
 	 */
 	private getBlockById: RequestHandler<INumberParam> = async (
-		{ params: { number }, query: { eventDocs, extrinsicDocs } },
+		{ params: { number }, query: { eventDocs, extrinsicDocs, finalizedKey } },
 		res,
 	): Promise<void> => {
 		const checkFinalized = isHex(number);
@@ -168,9 +168,14 @@ export default class BlocksController extends AbstractController<BlocksService>
 
 		const eventDocsArg = eventDocs === 'true';
 		const extrinsicDocsArg = extrinsicDocs === 'true';
+		const finalizeOverride = finalizedKey === 'false';
 
 		const queryFinalizedHead = !this.options.finalizes ? false : true;
-		const omitFinalizedTag = !this.options.finalizes ? true : false;
+		let omitFinalizedTag = !this.options.finalizes ? true : false;
+
+		if (finalizeOverride) {
+			omitFinalizedTag = true;
+		}
 
 		const options = {
 			eventDocs: eventDocsArg,