@q-dev/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
115 lines (114 loc) • 7.17 kB
TypeScript
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export interface SystemReserveInterface extends utils.Interface {
functions: {
"availableAmount()": FunctionFragment;
"coolDownPhase()": FunctionFragment;
"systemPaused()": FunctionFragment;
"initialize(address,string[])": FunctionFragment;
"setPauseState(bool)": FunctionFragment;
"withdraw(uint256)": FunctionFragment;
"getEligibleContractKeys()": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "availableAmount" | "coolDownPhase" | "systemPaused" | "initialize" | "setPauseState" | "withdraw" | "getEligibleContractKeys"): FunctionFragment;
encodeFunctionData(functionFragment: "availableAmount", values?: undefined): string;
encodeFunctionData(functionFragment: "coolDownPhase", values?: undefined): string;
encodeFunctionData(functionFragment: "systemPaused", values?: undefined): string;
encodeFunctionData(functionFragment: "initialize", values: [PromiseOrValue<string>, PromiseOrValue<string>[]]): string;
encodeFunctionData(functionFragment: "setPauseState", values: [PromiseOrValue<boolean>]): string;
encodeFunctionData(functionFragment: "withdraw", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "getEligibleContractKeys", values?: undefined): string;
decodeFunctionResult(functionFragment: "availableAmount", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "coolDownPhase", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "systemPaused", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "setPauseState", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "withdraw", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getEligibleContractKeys", data: BytesLike): Result;
events: {};
}
export interface SystemReserve extends BaseContract {
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: SystemReserveInterface;
queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
listeners(eventName?: string): Array<Listener>;
removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
removeAllListeners(eventName?: string): this;
off: OnEvent<this>;
on: OnEvent<this>;
once: OnEvent<this>;
removeListener: OnEvent<this>;
functions: {
availableAmount(overrides?: CallOverrides): Promise<[BigNumber]>;
coolDownPhase(overrides?: CallOverrides): Promise<[BigNumber]>;
systemPaused(overrides?: CallOverrides): Promise<[boolean]>;
initialize(_registry: PromiseOrValue<string>, _keys: PromiseOrValue<string>[], overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
setPauseState(_state: PromiseOrValue<boolean>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
withdraw(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getEligibleContractKeys(overrides?: CallOverrides): Promise<[string[]]>;
};
availableAmount(overrides?: CallOverrides): Promise<BigNumber>;
coolDownPhase(overrides?: CallOverrides): Promise<BigNumber>;
systemPaused(overrides?: CallOverrides): Promise<boolean>;
initialize(_registry: PromiseOrValue<string>, _keys: PromiseOrValue<string>[], overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
setPauseState(_state: PromiseOrValue<boolean>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
withdraw(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getEligibleContractKeys(overrides?: CallOverrides): Promise<string[]>;
callStatic: {
availableAmount(overrides?: CallOverrides): Promise<BigNumber>;
coolDownPhase(overrides?: CallOverrides): Promise<BigNumber>;
systemPaused(overrides?: CallOverrides): Promise<boolean>;
initialize(_registry: PromiseOrValue<string>, _keys: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>;
setPauseState(_state: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<void>;
withdraw(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
getEligibleContractKeys(overrides?: CallOverrides): Promise<string[]>;
};
filters: {};
estimateGas: {
availableAmount(overrides?: CallOverrides): Promise<BigNumber>;
coolDownPhase(overrides?: CallOverrides): Promise<BigNumber>;
systemPaused(overrides?: CallOverrides): Promise<BigNumber>;
initialize(_registry: PromiseOrValue<string>, _keys: PromiseOrValue<string>[], overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
setPauseState(_state: PromiseOrValue<boolean>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
withdraw(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
getEligibleContractKeys(overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
availableAmount(overrides?: CallOverrides): Promise<PopulatedTransaction>;
coolDownPhase(overrides?: CallOverrides): Promise<PopulatedTransaction>;
systemPaused(overrides?: CallOverrides): Promise<PopulatedTransaction>;
initialize(_registry: PromiseOrValue<string>, _keys: PromiseOrValue<string>[], overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
setPauseState(_state: PromiseOrValue<boolean>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
withdraw(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
getEligibleContractKeys(overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}