@q-dev/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
125 lines (124 loc) • 7.72 kB
TypeScript
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PayableOverrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export declare type TimeLockEntryStruct = {
amount: PromiseOrValue<BigNumberish>;
releaseStart: PromiseOrValue<BigNumberish>;
releaseEnd: PromiseOrValue<BigNumberish>;
};
export declare type TimeLockEntryStructOutput = [BigNumber, BigNumber, BigNumber] & {
amount: BigNumber;
releaseStart: BigNumber;
releaseEnd: BigNumber;
};
export interface ATimeLockBaseInterface extends utils.Interface {
functions: {
"depositOnBehalfOf(address,uint256,uint256)": FunctionFragment;
"purgeTimeLocks(address)": FunctionFragment;
"getTimeLocks(address)": FunctionFragment;
"getMinimumBalance(address,uint256)": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "depositOnBehalfOf" | "purgeTimeLocks" | "getTimeLocks" | "getMinimumBalance"): FunctionFragment;
encodeFunctionData(functionFragment: "depositOnBehalfOf", values: [
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<BigNumberish>
]): string;
encodeFunctionData(functionFragment: "purgeTimeLocks", values: [PromiseOrValue<string>]): string;
encodeFunctionData(functionFragment: "getTimeLocks", values: [PromiseOrValue<string>]): string;
encodeFunctionData(functionFragment: "getMinimumBalance", values: [PromiseOrValue<string>, PromiseOrValue<BigNumberish>]): string;
decodeFunctionResult(functionFragment: "depositOnBehalfOf", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "purgeTimeLocks", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getTimeLocks", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getMinimumBalance", data: BytesLike): Result;
events: {
"NewTimeLock(address,tuple)": EventFragment;
"Purged(address,tuple)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "NewTimeLock"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Purged"): EventFragment;
}
export interface NewTimeLockEventObject {
_account: string;
_timelock: TimeLockEntryStructOutput;
}
export declare type NewTimeLockEvent = TypedEvent<[
string,
TimeLockEntryStructOutput
], NewTimeLockEventObject>;
export declare type NewTimeLockEventFilter = TypedEventFilter<NewTimeLockEvent>;
export interface PurgedEventObject {
_account: string;
_timelock: TimeLockEntryStructOutput;
}
export declare type PurgedEvent = TypedEvent<[
string,
TimeLockEntryStructOutput
], PurgedEventObject>;
export declare type PurgedEventFilter = TypedEventFilter<PurgedEvent>;
export interface ATimeLockBase extends BaseContract {
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: ATimeLockBaseInterface;
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: {
depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[TimeLockEntryStructOutput[]]>;
getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
};
depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<TimeLockEntryStructOutput[]>;
getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
callStatic: {
depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<TimeLockEntryStructOutput[]>;
getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
};
filters: {
"NewTimeLock(address,tuple)"(_account?: PromiseOrValue<string> | null, _timelock?: null): NewTimeLockEventFilter;
NewTimeLock(_account?: PromiseOrValue<string> | null, _timelock?: null): NewTimeLockEventFilter;
"Purged(address,tuple)"(_account?: PromiseOrValue<string> | null, _timelock?: null): PurgedEventFilter;
Purged(_account?: PromiseOrValue<string> | null, _timelock?: null): PurgedEventFilter;
};
estimateGas: {
depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}