ethers.js/packages/cli/lib.esm/cli.d.ts
2021-05-17 16:19:36 -04:00

83 lines
3.0 KiB
TypeScript

import { ethers } from "ethers";
export declare function dump(header: string, info: any): void;
declare class WrappedSigner extends ethers.Signer {
readonly addressPromise: Promise<string>;
readonly provider: ethers.providers.Provider;
readonly plugin: Plugin;
constructor(addressPromise: Promise<string>, signerFunc: () => Promise<ethers.Signer>, plugin: Plugin);
connect(provider?: ethers.providers.Provider): ethers.Signer;
getAddress(): Promise<string>;
signMessage(message: string | ethers.utils.Bytes): Promise<string>;
populateTransaction(transactionRequest: ethers.providers.TransactionRequest): Promise<ethers.providers.TransactionRequest>;
signTransaction(transactionRequest: ethers.providers.TransactionRequest): Promise<string>;
sendTransaction(transactionRequest: ethers.providers.TransactionRequest): Promise<ethers.providers.TransactionResponse>;
unlock(): Promise<void>;
}
export declare class ArgParser {
readonly _args: Array<string>;
readonly _consumed: Array<boolean>;
constructor(args: Array<string>);
_finalizeArgs(): Array<string>;
_checkCommandIndex(): number;
consumeFlag(name: string): boolean;
consumeMultiOptions(names: Array<string>): Array<{
name: string;
value: string;
}>;
consumeOptions(name: string): Array<string>;
consumeOption(name: string): string;
}
export interface Help {
name: string;
help: string;
}
export interface PluginType {
new (...args: any[]): Plugin;
getHelp?: () => Help;
getOptionHelp?: () => Array<Help>;
}
export declare abstract class Plugin {
network: ethers.providers.Network;
provider: ethers.providers.Provider;
accounts: ReadonlyArray<WrappedSigner>;
mnemonicPassword: boolean;
mnemonicPath: string;
_xxxMnemonicPasswordHard: boolean;
gasLimit: ethers.BigNumber;
gasPrice: ethers.BigNumber;
nonce: number;
yes: boolean;
wait: boolean;
constructor();
static getHelp(): Help;
static getOptionHelp(): Array<Help>;
prepareOptions(argParser: ArgParser, verifyOnly?: boolean): Promise<void>;
prepareArgs(args: Array<string>): Promise<void>;
run(): Promise<void>;
getAddress(addressOrName: string, message?: string, allowZero?: boolean): Promise<string>;
dump(header: string, info: any): void;
throwUsageError(message?: string): never;
throwError(message: string): never;
}
export declare type Options = {
account?: boolean;
provider?: boolean;
transaction?: boolean;
version?: string;
};
export declare class CLI {
readonly defaultCommand: string;
readonly plugins: {
[command: string]: PluginType;
};
readonly standAlone: PluginType;
readonly options: Options;
constructor(defaultCommand?: string, options?: Options);
static getAppName(): string;
addPlugin(command: string, plugin: PluginType): void;
setPlugin(plugin: PluginType): void;
showUsage(message?: string, status?: number): never;
run(args: Array<string>): Promise<void>;
}
export {};
//# sourceMappingURL=cli.d.ts.map