@q-dev/q-js-sdk/lib/ethers-contracts/Vesting.d.ts

Typescript Library to interact with Q System Contracts

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 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 VestingInterface extends utils.Interface {
    functions: {
        "depositOnBehalfOf(address,uint256,uint256)": FunctionFragment;
        "getMinimumBalance(address,uint256)": FunctionFragment;
        "getTimeLocks(address)": FunctionFragment;
        "purgeTimeLocks(address)": FunctionFragment;
        "initialize(address)": FunctionFragment;
        "lock(uint256)": FunctionFragment;
        "withdraw(uint256)": FunctionFragment;
        "announceUnlock(uint256)": FunctionFragment;
        "unlock(uint256)": FunctionFragment;
        "getLockInfo()": FunctionFragment;
        "balanceOf(address)": FunctionFragment;
        "withdrawableBalanceOf(address)": FunctionFragment;
    };
    getFunction(nameOrSignatureOrTopic: "depositOnBehalfOf" | "getMinimumBalance" | "getTimeLocks" | "purgeTimeLocks" | "initialize" | "lock" | "withdraw" | "announceUnlock" | "unlock" | "getLockInfo" | "balanceOf" | "withdrawableBalanceOf"): FunctionFragment;
    encodeFunctionData(functionFragment: "depositOnBehalfOf", values: [
        PromiseOrValue<string>,
        PromiseOrValue<BigNumberish>,
        PromiseOrValue<BigNumberish>
    ]): string;
    encodeFunctionData(functionFragment: "getMinimumBalance", values: [PromiseOrValue<string>, PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "getTimeLocks", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "purgeTimeLocks", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "initialize", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "lock", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "withdraw", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "announceUnlock", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "unlock", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "getLockInfo", values?: undefined): string;
    encodeFunctionData(functionFragment: "balanceOf", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "withdrawableBalanceOf", values: [PromiseOrValue<string>]): string;
    decodeFunctionResult(functionFragment: "depositOnBehalfOf", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getMinimumBalance", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getTimeLocks", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "purgeTimeLocks", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "lock", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdraw", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "announceUnlock", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "unlock", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getLockInfo", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "balanceOf", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "withdrawableBalanceOf", 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 Vesting extends BaseContract {
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: VestingInterface;
    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>;
        getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
        getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[TimeLockEntryStructOutput[]]>;
        purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        initialize(_registry: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        withdraw(_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]>;
        balanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber]>;
        withdrawableBalanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber]>;
    };
    depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
    getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<TimeLockEntryStructOutput[]>;
    purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    initialize(_registry: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    withdraw(_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>;
    balanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    withdrawableBalanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    callStatic: {
        depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
        getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<TimeLockEntryStructOutput[]>;
        purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        initialize(_registry: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        lock(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
        withdraw(_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>;
        balanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        withdrawableBalanceOf(_account: PromiseOrValue<string>, 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>;
        getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        initialize(_registry: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        withdraw(_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>;
        balanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        withdrawableBalanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
    };
    populateTransaction: {
        depositOnBehalfOf(_account: PromiseOrValue<string>, _releaseStart: PromiseOrValue<BigNumberish>, _releaseEnd: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        getMinimumBalance(_account: PromiseOrValue<string>, _timestamp: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getTimeLocks(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        purgeTimeLocks(_account: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        initialize(_registry: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        lock(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        withdraw(_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>;
        balanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        withdrawableBalanceOf(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
    };
}