@substrate/api-sidecar/build/src/controllers/accounts/AccountsBalanceInfoController.d.ts

REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.

import { AccountsBalanceInfoService } from '../../services';
import AbstractController from '../AbstractController';
/**
 * GET balance information for an address.
 *
 * Paths:
 * - `address`: The address to query.
 *
 * Query:
 * - (Optional)`at`: Block at which to retrieve runtime version information at. Block
 * 		identifier, as the block height or block hash. Defaults to most recent block.
 * - (Optional) `useRcBlock`: When true, treats the `at` parameter as a relay chain block
 * 		to find corresponding Asset Hub blocks. Only supported for Asset Hub endpoints.
 *
 * Returns:
 * - When using `useRcBlock=true`: An array of response objects, one for each Asset Hub block found
 *   in the specified relay chain block. Returns empty array `[]` if no Asset Hub blocks found.
 * - When using `useRcBlock=false` or omitted: A single response object.
 *
 * Response object structure:
 * - `at`: Block number and hash at which the call was made.
 * - `nonce`: Account nonce.
 * - `free`: Free balance of the account. Not equivalent to _spendable_ balance. This is the only
 *   balance that matters in terms of most operations on tokens.
 * - `reserved`: Reserved balance of the account.
 * - `miscFrozen`: The amount that `free` may not drop below when withdrawing for anything except
 *   transaction fee payment.
 * - `feeFrozen`: The amount that `free` may not drop below when withdrawing specifically for
 *   transaction fee payment.
 * - `locks`: Array of locks on a balance. There can be many of these on an account and they
 *   "overlap", so the same balance is frozen by multiple locks. Contains:
 *   - `id`: An identifier for this lock. Only one lock may be in existence for each identifier.
 *   - `amount`: The amount below which the free balance may not drop with this lock in effect.
 *   - `reasons`: If true, then the lock remains in effect even for payment of transaction fees.
 * - `rcBlockHash`: The relay chain block hash used for the query. Only present when `useRcBlock=true`.
 * - `rcBlockNumber`: The relay chain block number used for the query. Only present when `useRcBlock=true`.
 * - `ahTimestamp`: The Asset Hub block timestamp. Only present when `useRcBlock=true`.
 *
 * Substrate Reference:
 * - FRAME System: https://crates.parity.io/frame_system/index.html
 * - Balances Pallet: https://crates.parity.io/pallet_balances/index.html
 * - `AccountInfo`: https://crates.parity.io/frame_system/struct.AccountInfo.html
 * - `AccountData`: https://crates.parity.io/pallet_balances/struct.AccountData.html
 * - `BalanceLock`: https://crates.parity.io/pallet_balances/struct.BalanceLock.html
 */
export default class AccountsBalanceController extends AbstractController<AccountsBalanceInfoService> {
    static controllerName: string;
    static requiredPallets: string[][];
    constructor(api: string);
    protected initRoutes(): void;
    /**
     * Get the latest account balance summary of `address`.
     *
     * @param req Express Request
     * @param res Express Response
     */
    private getAccountBalanceInfo;
}