@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
76 lines • 3.92 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 services_1 = require("../../../services");
const AbstractController_1 = __importDefault(require("../../AbstractController"));
/**
* Get version information of the relay chain Substrate runtime.
*
* Query:
* - (Optional)`at`: Block at which to retrieve runtime version information. Block
* identifier, as the block height or block hash. Defaults to most recent block.
*
* Returns:
* - `at`: Block number and hash at which the call was made.
* - `authoringVersion`: The version of the authorship interface. An authoring node
* will not attempt to author blocks unless this is equal to its native runtime.
* - `chainType`: Type of the chain.
* - `implVersion`: Version of the implementation specification. Non-consensus-breaking
* optimizations are about the only changes that could be made which would
* result in only the `impl_version` changing. The `impl_version` is set to 0
* when `spec_version` is incremented.
* - `specName`: Identifies the spec name for the current runtime.
* - `specVersion`: Version of the runtime specification.
* - `transactionVersion`: All existing dispatches are fully compatible when this
* number doesn't change. This number must change when an existing dispatchable
* (module ID, dispatch ID) is changed, either through an alteration in its
* user-level semantics, a parameter added/removed/changed, a dispatchable
* its index.
* - `properties`: Arbitrary properties defined in the chain spec.
*/
class RcRuntimeSpecController 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/runtime/spec', new services_1.RuntimeSpecService(rcSpecName));
this.getSpec = async ({ query: { at } }, res) => {
var _a;
const rcApi = (_a = apiRegistry_1.ApiPromiseRegistry.getApiByType('relay')[0]) === null || _a === void 0 ? void 0 : _a.api;
if (!rcApi) {
throw new Error('Relay chain API not found, please use SAS_SUBSTRATE_MULTI_CHAIN_URL env variable');
}
const hash = await this.getHashFromAt(at, { api: rcApi });
RcRuntimeSpecController.sanitizedSend(res, await this.service.fetchSpec(hash));
};
this.initRoutes();
}
initRoutes() {
this.safeMountAsyncGetHandlers([['', this.getSpec]]);
}
}
RcRuntimeSpecController.controllerName = 'RcRuntimeSpec';
RcRuntimeSpecController.requiredPallets = [];
exports.default = RcRuntimeSpecController;
//# sourceMappingURL=RcRuntimeSpecController.js.map