@q-dev/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
108 lines (107 loc) • 5.62 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 declare type VotingLockInfoStruct = {
lockedAmount: PromiseOrValue<BigNumberish>;
lockedUntil: PromiseOrValue<BigNumberish>;
pendingUnlockAmount: PromiseOrValue<BigNumberish>;
pendingUnlockTime: PromiseOrValue<BigNumberish>;
};
export declare type VotingLockInfoStructOutput = [
BigNumber,
BigNumber,
BigNumber,
BigNumber
] & {
lockedAmount: BigNumber;
lockedUntil: BigNumber;
pendingUnlockAmount: BigNumber;
pendingUnlockTime: BigNumber;
};
export interface ITokenLockInterface extends utils.Interface {
functions: {
"lock(uint256)": FunctionFragment;
"announceUnlock(uint256)": FunctionFragment;
"unlock(uint256)": FunctionFragment;
"getLockInfo()": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "lock" | "announceUnlock" | "unlock" | "getLockInfo"): FunctionFragment;
encodeFunctionData(functionFragment: "lock", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "announceUnlock", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "unlock", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "getLockInfo", values?: undefined): string;
decodeFunctionResult(functionFragment: "lock", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "announceUnlock", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "unlock", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getLockInfo", data: BytesLike): Result;
events: {};
}
export interface ITokenLock extends BaseContract {
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: ITokenLockInterface;
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: {
lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
announceUnlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
unlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getLockInfo(overrides?: CallOverrides): Promise<[VotingLockInfoStructOutput]>;
};
lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
announceUnlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
unlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getLockInfo(overrides?: CallOverrides): Promise<VotingLockInfoStructOutput>;
callStatic: {
lock(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
announceUnlock(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
unlock(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
getLockInfo(overrides?: CallOverrides): Promise<VotingLockInfoStructOutput>;
};
filters: {};
estimateGas: {
lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
announceUnlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
unlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
getLockInfo(overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
announceUnlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
unlock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
getLockInfo(overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}