@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
66 lines • 3.33 kB
JavaScript
;
// 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 apiRegistry_1 = require("../../../apiRegistry");
const middleware_1 = require("../../../middleware");
const services_1 = require("../../../services");
const AbstractController_1 = __importDefault(require("../../AbstractController"));
/**
* GET pending extrinsics from the Substrate node.
*
* Returns:
* - `pool`: array of
* - `hash`: H256 hash of the extrinsic.
* - `encodedExtrinsic`: Scale encoded extrinsic.
* - `tip`: Tip included into the extrinsic. Available when the `includeFee` query param is set to true.
* - `priority`: Priority of the transaction. Calculated by tip * (max_block_{weight|length} / bounded_{weight|length}).
* Available when the `includeFee` query param is set to true.
* - `partialFee`: PartialFee for a transaction. Available when the `includeFee` query param is set to true.
*/
class RcNodeTransactionPoolController extends AbstractController_1.default {
constructor(_api) {
var _a;
const rcApiSpecName = (_a = apiRegistry_1.ApiPromiseRegistry.getSpecNameByType('relay')) === null || _a === void 0 ? void 0 : _a.values();
const rcSpecName = rcApiSpecName ? Array.from(rcApiSpecName)[0] : undefined;
if (!rcSpecName) {
throw new Error('Relay chain API spec name is not defined.');
}
super(rcSpecName, '/rc/node/transaction-pool', new services_1.NodeTransactionPoolService(rcSpecName));
/**
* GET pending extrinsics from the Substrate node.
*
* @param req Express Request, accepts the query param `includeFee`
* @param res Express Response
*/
this.getNodeTransactionPool = async ({ query: { includeFee } }, res) => {
const shouldIncludeFee = includeFee === 'true';
RcNodeTransactionPoolController.sanitizedSend(res, await this.service.fetchTransactionPool(shouldIncludeFee));
};
this.initRoutes();
}
initRoutes() {
this.router.use(this.path, (0, middleware_1.validateBoolean)(['includeFee']));
this.safeMountAsyncGetHandlers([['', this.getNodeTransactionPool]]);
}
}
RcNodeTransactionPoolController.controllerName = 'RcNodeTransactionPool';
RcNodeTransactionPoolController.requiredPallets = [];
exports.default = RcNodeTransactionPoolController;
//# sourceMappingURL=RcNodeTransactionPoolController.js.map