@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
76 lines • 3.59 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 information about the Substrate node's activity in the peer-to-peer network.
*
* Returns:
* - `nodeRoles`: Roles the node is running.
* - `numPeers`: Number of peers the node is connected to.
* - `isSyncing`: Whether or not the node is syncing. `False` indicates that the
* node is in sync.
* - `shouldHavePeers`: Whether or not the node should be connected to peers. Might
* be false for local chains or when running without discovery.
* - `localPeerId`: Local copy of the `PeerId`.
* - `localListenAddresses`: Multiaddresses that the local node is listening on.
* The addresses include a trailing `/p2p/` with the local PeerId, and are thus
* suitable to be passed to `system_addReservedPeer` or as a bootnode address
* for example.
* - `systemPeers`: array of
* - `peerId`: Peer ID.
* - `roles`: Roles the peer is running.
* - `protocolVersion`: Peer's protocol version.
* - `bestHash`: Hash of the best block on the peers canon chain.
* - `bestNumber`: Height of the best block on the peers canon chain.
*
* References:
* - `NodeRole`: https://github.com/paritytech/substrate/blob/master/client/rpc-api/src/system/helpers.rs#L80
*/
class RcNodeNetworkController 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/network', new services_1.NodeNetworkService(rcSpecName));
/**
* GET information about the Substrate node's activity in the peer-to-peer network.
*
* @param _req Express Request
* @param res Express Response
*/
this.getNodeNetworking = async (_req, res) => {
RcNodeNetworkController.sanitizedSend(res, await this.service.fetchNetwork());
};
this.initRoutes();
}
initRoutes() {
this.safeMountAsyncGetHandlers([['', this.getNodeNetworking]]);
}
}
RcNodeNetworkController.controllerName = 'RcNodeNetwork';
RcNodeNetworkController.requiredPallets = [];
exports.default = RcNodeNetworkController;
//# sourceMappingURL=RcNodeNetworkController.js.map