@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
93 lines • 4.99 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 vesting information for an address on the relay chain.
*
* Paths:
* - `address`: Address to query.
*
* Query params:
* - (Optional)`at`: Block at which to retrieve vesting information at. Block
* identifier, as the block height or block hash. Defaults to most recent block.
* - (Optional)`includeClaimable`: When set to 'true', calculates and includes vested
* amounts for each vesting schedule plus the claimable amount. Defaults to 'false'.
*
* Returns:
* - `at`: Block number and hash at which the call was made.
* - `vesting`: Array of vesting schedules for an account.
* - `locked`: Number of tokens locked at start.
* - `perBlock`: Number of tokens that gets unlocked every block after `startingBlock`.
* - `startingBlock`: Starting block for unlocking(vesting).
* - `vested`: (Only when `includeClaimable=true`) Amount that has vested based on time elapsed.
* - `vestedBalance`: (Only when `includeClaimable=true`) Total vested across all schedules.
* - `vestingTotal`: (Only when `includeClaimable=true`) Total locked across all schedules.
* - `vestedClaimable`: (Only when `includeClaimable=true`) Actual amount that can be claimed now.
* - `blockNumberForCalculation`: (Only when `includeClaimable=true`) The block number used for calculations.
* - `blockNumberSource`: (Only when `includeClaimable=true`) Which chain's block number was used ('relay' or 'self').
*
* Note: For relay chain pre-migration queries, vested amounts are calculated using the relay
* chain's own block number. Post-migration, vesting has moved to Asset Hub.
*
* Substrate Reference:
* - Vesting Pallet: https://crates.parity.io/pallet_vesting/index.html
* - `VestingInfo`: https://crates.parity.io/pallet_vesting/struct.VestingInfo.html
*/
class RcAccountsVestingInfoController 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/accounts/:address/vesting-info', new services_1.AccountsVestingInfoService(rcSpecName));
/**
* Get vesting information for an account on the relay chain.
*
* @param req Express Request
* @param res Express Response
*/
this.getAccountVestingInfo = async ({ params: { address }, query: { at, includeClaimable } }, 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 shouldIncludeClaimable = includeClaimable === 'true';
const hash = await this.getHashFromAt(at, { api: rcApi });
const result = await this.service.fetchAccountVestingInfo(hash, address, shouldIncludeClaimable);
RcAccountsVestingInfoController.sanitizedSend(res, result);
};
this.initRoutes();
}
initRoutes() {
this.router.use(this.path, middleware_1.validateAddress);
this.safeMountAsyncGetHandlers([['', this.getAccountVestingInfo]]);
}
}
RcAccountsVestingInfoController.controllerName = 'RcAccountsVestingInfo';
RcAccountsVestingInfoController.requiredPallets = [['Vesting'], ['CalamariVesting']];
exports.default = RcAccountsVestingInfoController;
//# sourceMappingURL=RcAccountsVestingInfoController.js.map