fix: added query to calc fees (#1366)

* added bool to calc fees * changed noFees from env var to query * docs * Update src/services/blocks/BlocksService.ts Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com> * docs --------- Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
paritytech · Dec 21, 2023 · 203a257 · 203a257
1 parent 2a38b2e
commit 203a257
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 6 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
@@ -576,6 +576,13 @@ paths:
         schema:
           type: boolean
           default: false
+      - name: noFees
+        in: query
+        description: When set to `true`, the fee won't be calculated for the extrinsics.
+        required: false
+        schema:
+          type: boolean
+          default: false
       responses:
         "200":
           description: successful operation
@@ -621,6 +628,13 @@ paths:
         schema:
           type: boolean
           default: false
+      - name: noFees
+        in: query
+        description: When set to `true`, the fee won't be calculated for the extrinsics.
+        required: false
+        schema:
+          type: boolean
+          default: false
       - name: finalizedKey
         in: query
         description: When set to false, this will override the chain-config, and omit the
@@ -756,6 +770,13 @@ paths:
         schema:
           type: boolean
           default: false
+      - name: noFees
+        in: query
+        description: When set to `true`, the fee won't be calculated for the extrinsics.
+        required: false
+        schema:
+          type: boolean
+          default: false
       responses:
         "200":
           description: successful operation

diff --git a/src/controllers/blocks/BlocksController.ts b/src/controllers/blocks/BlocksController.ts
@@ -116,7 +116,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 	 * @param _req Express Request
 	 * @param res Express Response
 	 */
-	private getLatestBlock: RequestHandler = async ({ query: { eventDocs, extrinsicDocs, finalized } }, res) => {
+	private getLatestBlock: RequestHandler = async ({ query: { eventDocs, extrinsicDocs, finalized, noFees } }, res) => {
 		const eventDocsArg = eventDocs === 'true';
 		const extrinsicDocsArg = extrinsicDocs === 'true';
 
@@ -138,13 +138,15 @@ export default class BlocksController extends AbstractController<BlocksService>
 			queryFinalizedHead = false;
 			hash = await this.api.rpc.chain.getFinalizedHead();
 		}
+		const noFeesArg = noFees === 'true';
 
 		const options = {
 			eventDocs: eventDocsArg,
 			extrinsicDocs: extrinsicDocsArg,
 			checkFinalized: false,
 			queryFinalizedHead,
 			omitFinalizedTag,
+			noFees: noFeesArg,
 		};
 
 		const historicApi = await this.api.at(hash);
@@ -159,7 +161,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 	 * @param res Express Response
 	 */
 	private getBlockById: RequestHandler<INumberParam> = async (
-		{ params: { number }, query: { eventDocs, extrinsicDocs, finalizedKey } },
+		{ params: { number }, query: { eventDocs, extrinsicDocs, noFees, finalizedKey } },
 		res,
 	): Promise<void> => {
 		const checkFinalized = isHex(number);
@@ -171,6 +173,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 		const finalizeOverride = finalizedKey === 'false';
 
 		const queryFinalizedHead = !this.options.finalizes ? false : true;
+		const noFeesArg = noFees === 'true';
 		let omitFinalizedTag = !this.options.finalizes ? true : false;
 
 		if (finalizeOverride) {
@@ -183,6 +186,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 			checkFinalized,
 			queryFinalizedHead,
 			omitFinalizedTag,
+			noFees: noFeesArg,
 		};
 
 		// HistoricApi to fetch any historic information that doesnt include the current runtime
@@ -225,7 +229,7 @@ export default class BlocksController extends AbstractController<BlocksService>
 	 * @param res Express Response
 	 */
 	private getBlocks: RequestHandler<unknown, unknown, unknown, IRangeQueryParam> = async (
-		{ query: { range, eventDocs, extrinsicDocs } },
+		{ query: { range, eventDocs, extrinsicDocs, noFees } },
 		res,
 	): Promise<void> => {
 		if (!range) throw new BadRequest('range query parameter must be inputted.');
@@ -237,12 +241,14 @@ export default class BlocksController extends AbstractController<BlocksService>
 		const extrinsicDocsArg = extrinsicDocs === 'true';
 		const queryFinalizedHead = !this.options.finalizes ? false : true;
 		const omitFinalizedTag = !this.options.finalizes ? true : false;
+		const noFeesArg = noFees === 'true';
 		const options = {
 			eventDocs: eventDocsArg,
 			extrinsicDocs: extrinsicDocsArg,
 			checkFinalized: false,
 			queryFinalizedHead,
 			omitFinalizedTag,
+			noFees: noFeesArg,
 		};
 
 		const pQueue = new PromiseQueue(4);

diff --git a/src/controllers/blocks/BlocksExtrinsicsController.ts b/src/controllers/blocks/BlocksExtrinsicsController.ts
@@ -42,20 +42,22 @@ export default class BlocksExtrinsicsController extends AbstractController<Block
 	 * @param res Express Response
 	 */
 	private getExtrinsicByTimepoint: RequestHandler<INumberParam> = async (
-		{ params: { blockId, extrinsicIndex }, query: { eventDocs, extrinsicDocs } },
+		{ params: { blockId, extrinsicIndex }, query: { eventDocs, extrinsicDocs, noFees } },
 		res,
 	): Promise<void> => {
 		const hash = await this.getHashForBlock(blockId);
 
 		const eventDocsArg = eventDocs === 'true';
 		const extrinsicDocsArg = extrinsicDocs === 'true';
+		const noFeesArg = noFees === 'true';
 
 		const options = {
 			eventDocs: eventDocsArg,
 			extrinsicDocs: extrinsicDocsArg,
 			checkFinalized: true,
 			queryFinalizedHead: false,
 			omitFinalizedTag: true,
+			noFees: noFeesArg,
 		};
 
 		const historicApi = await this.api.at(hash);

diff --git a/src/services/blocks/BlocksService.spec.ts b/src/services/blocks/BlocksService.spec.ts
@@ -122,6 +122,7 @@ describe('BlocksService', () => {
 				checkFinalized: false,
 				queryFinalizedHead: false,
 				omitFinalizedTag: false,
+				noFees: false,
 			};
 
 			expect(sanitizeNumbers(await blocksService.fetchBlock(blockHash789629, mockHistoricApi, options))).toMatchObject(
@@ -146,6 +147,7 @@ describe('BlocksService', () => {
 				checkFinalized: false,
 				queryFinalizedHead: false,
 				omitFinalizedTag: false,
+				noFees: false,
 			};
 			const tempGetBlock = mockApi.rpc.chain.getBlock;
 			mockApi.rpc.chain.getBlock = (() =>
@@ -170,6 +172,7 @@ describe('BlocksService', () => {
 				checkFinalized: false,
 				queryFinalizedHead: false,
 				omitFinalizedTag: true,
+				noFees: false,
 			};
 
 			const block = await blocksService.fetchBlock(blockHash789629, mockHistoricApi, options);
@@ -357,6 +360,7 @@ describe('BlocksService', () => {
 			checkFinalized: false,
 			queryFinalizedHead: false,
 			omitFinalizedTag: false,
+			noFees: false,
 		};
 
 		it('Returns the correct extrinisics object for block 789629', async () => {
@@ -442,6 +446,7 @@ describe('BlocksService', () => {
 			checkFinalized: false,
 			queryFinalizedHead: false,
 			omitFinalizedTag: false,
+			noFees: false,
 		};
 
 		it('Should correctly store the most recent queried blocks', async () => {

diff --git a/src/services/blocks/BlocksService.ts b/src/services/blocks/BlocksService.ts
@@ -71,6 +71,7 @@ interface FetchBlockOptions {
 	checkFinalized: boolean;
 	queryFinalizedHead: boolean;
 	omitFinalizedTag: boolean;
+	noFees: boolean;
 }
 
 /**
@@ -101,7 +102,7 @@ export class BlocksService extends AbstractService {
 	async fetchBlock(
 		hash: BlockHash,
 		historicApi: ApiDecoration<'promise'>,
-		{ eventDocs, extrinsicDocs, checkFinalized, queryFinalizedHead, omitFinalizedTag }: FetchBlockOptions,
+		{ eventDocs, extrinsicDocs, checkFinalized, queryFinalizedHead, omitFinalizedTag, noFees }: FetchBlockOptions,
 	): Promise<IBlock> {
 		const { api } = this;
 
@@ -168,6 +169,11 @@ export class BlocksService extends AbstractService {
 		const previousBlockHash = await this.fetchPreviousBlockHash(number);
 
 		for (let idx = 0; idx < block.extrinsics.length; ++idx) {
+			if (noFees) {
+				extrinsics[idx].info = {};
+				continue;
+			}
+
 			if (!extrinsics[idx].paysFee || !block.extrinsics[idx].isSigned) {
 				continue;
 			}