@gear-js/api/lib/GearApi.d.ts

A JavaScript library that provides functionality to connect GEAR Component APIs.

import { ApiPromise, WsProvider } from '@polkadot/api';
import type { u64, u128 } from '@polkadot/types';
import type { Event } from '@polkadot/types/interfaces';
import { GearBalance, GearBlock, GearBuiltin, GearCode, GearEthBridge, GearMailbox, GearMessage, GearProgram, GearProgramState, GearProgramStorage, GearVoucher, GearWaitlist } from './api';
import { GearEvents } from './events';
import type { ExtrinsicFailedData, GearApiOptions, InflationInfo } from './types';
export declare class GearApi extends ApiPromise {
    readonly program: GearProgram;
    /** @deprecated */
    readonly programState: GearProgramState;
    readonly programStorage: GearProgramStorage;
    readonly message: GearMessage;
    readonly balance: GearBalance;
    readonly gearEvents: GearEvents;
    readonly blocks: GearBlock;
    readonly mailbox: GearMailbox;
    readonly code: GearCode;
    readonly waitlist: GearWaitlist;
    readonly voucher: GearVoucher;
    readonly ethBridge: GearEthBridge;
    readonly builtin: GearBuiltin;
    readonly provider: WsProvider;
    private _rpcMethods;
    constructor(options?: GearApiOptions);
    static create(options?: GearApiOptions): Promise<GearApi>;
    totalIssuance(): Promise<string>;
    chain(): Promise<string>;
    nodeName(): Promise<string>;
    nodeVersion(): Promise<string>;
    get specVersion(): number;
    get specName(): string;
    get existentialDeposit(): u128;
    get blockGasLimit(): u64;
    get mailboxTreshold(): u64;
    get waitlistCost(): u64;
    get valuePerGas(): u128;
    inflationInfo(): Promise<InflationInfo>;
    wasmBlobVersion(): Promise<string>;
    /**
     * Method provides opportunity to get informations about error occurs in ExtrinsicFailed event
     * @param event
     * @returns
     */
    getExtrinsicFailedError(event: Event): ExtrinsicFailedData;
    get rpcMethods(): string[];
}