@kubectl/caminojs/dist/apis/index/api.d.ts

Camino Platform JS Library

/**
 * @packageDocumentation
 * @module API-Index
 */
import AvalancheCore from "../../camino";
import { JRPCAPI } from "../../common/jrpcapi";
import { GetLastAcceptedResponse, GetContainerByIndexResponse, GetContainerByIDResponse, GetContainerRangeResponse, IsAcceptedResponse } from "./interfaces";
/**
 * Class for interacting with a node's IndexAPI.
 *
 * @category RPCAPIs
 *
 * @remarks This extends the [[JRPCAPI]] class. This class should not be directly called. Instead, use the [[Avalanche.addAPI]] function to register this interface with Avalanche.
 */
export declare class IndexAPI extends JRPCAPI {
    /**
     * Get last accepted tx, vtx or block
     *
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetLastAcceptedResponse.
     */
    getLastAccepted: (encoding?: string, baseURL?: string) => Promise<GetLastAcceptedResponse>;
    /**
     * Get container by index
     *
     * @param index
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetContainerByIndexResponse.
     */
    getContainerByIndex: (index?: string, encoding?: string, baseURL?: string) => Promise<GetContainerByIndexResponse>;
    /**
     * Get contrainer by ID
     *
     * @param id
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetContainerByIDResponse.
     */
    getContainerByID: (id?: string, encoding?: string, baseURL?: string) => Promise<GetContainerByIDResponse>;
    /**
     * Get container range
     *
     * @param startIndex
     * @param numToFetch
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetContainerRangeResponse.
     */
    getContainerRange: (startIndex?: number, numToFetch?: number, encoding?: string, baseURL?: string) => Promise<GetContainerRangeResponse[]>;
    /**
     * Get index by containerID
     *
     * @param id
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetIndexResponse.
     */
    getIndex: (id?: string, encoding?: string, baseURL?: string) => Promise<string>;
    /**
     * Check if container is accepted
     *
     * @param id
     * @param encoding
     * @param baseURL
     *
     * @returns Returns a Promise GetIsAcceptedResponse.
     */
    isAccepted: (id?: string, encoding?: string, baseURL?: string) => Promise<IsAcceptedResponse>;
    /**
     * This class should not be instantiated directly. Instead use the [[Avalanche.addAPI]] method.
     *
     * @param core A reference to the Avalanche class
     * @param baseURL Defaults to the string "/ext/index/X/tx" as the path to rpc's baseURL
     */
    constructor(core: AvalancheCore, baseURL?: string);
}
//# sourceMappingURL=api.d.ts.map