@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
142 lines • 7.11 kB
JavaScript
"use strict";
// Copyright 2017-2025 Parity Technologies (UK) Ltd.
// This file is part of Substrate API Sidecar.
//
// Substrate API Sidecar is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const validate_1 = require("../../middleware/validate");
const services_1 = require("../../services");
const AbstractController_1 = __importDefault(require("../AbstractController"));
class BlocksExtrinsicsController extends AbstractController_1.default {
constructor(api, options) {
super(api, '/blocks/:blockId/extrinsics', new services_1.BlocksService(api, options.minCalcFeeRuntime, options.hasQueryFeeApi));
/**
*
* @param _req Express Request
* @param res Express Response
*/
this.getExtrinsicByTimepoint = async ({ params: { blockId, extrinsicIndex }, query: { eventDocs, extrinsicDocs, noFees, useRcBlock, useEvmFormat } }, res) => {
const useRcBlockArg = useRcBlock === 'true';
if (useRcBlockArg) {
// Treat the blockId parameter as a relay chain block identifier
const rcBlockNumber = blockId;
const hash = await this.getAhAtFromRcAt(blockId);
// Return empty array if no Asset Hub block found
if (!hash) {
BlocksExtrinsicsController.sanitizedSend(res, []);
return;
}
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,
checkDecodedXcm: false,
paraId: undefined,
useEvmAddressFormat: useEvmFormat === 'true',
};
const cacheKey = hash.toString() +
Number(options.eventDocs) +
Number(options.extrinsicDocs) +
Number(options.checkFinalized) +
Number(options.noFees) +
Number(options.checkDecodedXcm) +
Number(options.useEvmAddressFormat);
const isBlockCached = this.blockStore.get(cacheKey);
const historicApi = await this.api.at(hash);
const block = isBlockCached ? isBlockCached : await this.service.fetchBlock(hash, historicApi, options);
if (!isBlockCached) {
this.blockStore.set(cacheKey, block);
}
/**
* Verify our param `extrinsicIndex` is an integer represented as a string
*/
this.parseNumberOrThrow(extrinsicIndex, '`exstrinsicIndex` path param is not a number');
/**
* Change extrinsicIndex from a type string to a number before passing it
* into any service.
*/
const index = parseInt(extrinsicIndex, 10);
const extrinsic = this.service.fetchExtrinsicByIndex(block, index);
const apiAt = await this.api.at(hash);
const ahTimestamp = await apiAt.query.timestamp.now();
const enhancedResult = {
...extrinsic,
rcBlockNumber,
ahTimestamp: ahTimestamp.toString(),
};
BlocksExtrinsicsController.sanitizedSend(res, [enhancedResult]);
}
else {
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,
checkDecodedXcm: false,
paraId: undefined,
useEvmAddressFormat: useEvmFormat === 'true',
};
const cacheKey = hash.toString() +
Number(options.eventDocs) +
Number(options.extrinsicDocs) +
Number(options.checkFinalized) +
Number(options.noFees) +
Number(options.checkDecodedXcm) +
Number(options.useEvmAddressFormat);
const isBlockCached = this.blockStore.get(cacheKey);
const historicApi = await this.api.at(hash);
const block = isBlockCached ? isBlockCached : await this.service.fetchBlock(hash, historicApi, options);
if (!isBlockCached) {
this.blockStore.set(cacheKey, block);
}
/**
* Verify our param `extrinsicIndex` is an integer represented as a string
*/
this.parseNumberOrThrow(extrinsicIndex, '`exstrinsicIndex` path param is not a number');
/**
* Change extrinsicIndex from a type string to a number before passing it
* into any service.
*/
const index = parseInt(extrinsicIndex, 10);
const extrinsic = this.service.fetchExtrinsicByIndex(block, index);
BlocksExtrinsicsController.sanitizedSend(res, extrinsic);
}
};
this.initRoutes();
this.blockStore = options.blockStore;
}
initRoutes() {
this.router.use(this.path, validate_1.validateUseRcBlock);
this.safeMountAsyncGetHandlers([['/:extrinsicIndex', this.getExtrinsicByTimepoint]]);
}
}
BlocksExtrinsicsController.controllerName = 'BlocksExtrinsics';
BlocksExtrinsicsController.requiredPallets = [['System', 'Session']];
exports.default = BlocksExtrinsicsController;
//# sourceMappingURL=BlocksExtrinsicsController.js.map