@dfinity/cketh/dist/types/orchestrator.canister.d.ts

A library for interfacing with ckETH.

import { Canister, type QueryParams } from "@dfinity/utils";
import type { _SERVICE as CkETHOrchestratorService, OrchestratorInfo } from "../candid/orchestrator";
import type { CkETHOrchestratorCanisterOptions } from "./types/canister.options";
/**
 * Class representing the CkETH Orchestrator Canister, which manages the Ledger and Index canisters of ckERC20 tokens.
 * @extends {Canister<CkETHOrchestratorService>}
 * @see {@link https://github.com/dfinity/ic/tree/master/rs/ethereum/ledger-suite-orchestrator|Source Code}
 */
export declare class CkETHOrchestratorCanister extends Canister<CkETHOrchestratorService> {
    /**
     * Creates an instance of CkETHOrchestratorCanister.
     * @param {CkETHOrchestratorCanisterOptions<CkETHOrchestratorService>} options - Options for creating the canister.
     * @returns {CkETHOrchestratorCanister} A new instance of CkETHOrchestratorCanister.
     */
    static create(options: CkETHOrchestratorCanisterOptions<CkETHOrchestratorService>): CkETHOrchestratorCanister;
    /**
     * Retrieves orchestrator information, which contains the list of existing ckERC20 Ledger and Index canisters.
     * @param {QueryParams} [params={}] - The query parameters.
     * @param {boolean} [params.certified] - Whether to execute a certified (update) call.
     * @returns {Promise<OrchestratorInfo>} A promise that resolves to the orchestrator information.
     */
    getOrchestratorInfo: ({ certified, }?: QueryParams) => Promise<OrchestratorInfo>;
}