@knine-sdk/contracts/dist/esm/generated/VestingAbi.d.ts

Contracts for Knine projects. Part of Knine JS SDK

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */

import {
  ethers,
  EventFilter,
  Signer,
  BigNumber,
  BigNumberish,
  PopulatedTransaction,
  BaseContract,
  ContractTransaction,
  Overrides,
  CallOverrides,
} from "ethers";
import { BytesLike } from "@ethersproject/bytes";
import { Listener, Provider } from "@ethersproject/providers";
import { FunctionFragment, EventFragment, Result } from "@ethersproject/abi";
import { TypedEventFilter, TypedEvent, TypedListener } from "./commons";

interface VestingAbiInterface extends ethers.utils.Interface {
  functions: {
    "ADMIN_ROLE()": FunctionFragment;
    "DEFAULT_ADMIN_ROLE()": FunctionFragment;
    "DENOMINATOR()": FunctionFragment;
    "KNINE()": FunctionFragment;
    "STAKING()": FunctionFragment;
    "beforeDeposit(address)": FunctionFragment;
    "changeIsOnlyLocked()": FunctionFragment;
    "changeTestTime(uint256)": FunctionFragment;
    "claim()": FunctionFragment;
    "deposit(uint256)": FunctionFragment;
    "depositInfo(address)": FunctionFragment;
    "deposits(address)": FunctionFragment;
    "emergencyStop()": FunctionFragment;
    "endTime()": FunctionFragment;
    "esKNINE()": FunctionFragment;
    "getRoleAdmin(bytes32)": FunctionFragment;
    "grantRole(bytes32,address)": FunctionFragment;
    "hasRole(bytes32,address)": FunctionFragment;
    "initialize(address,address,address,address,tuple)": FunctionFragment;
    "pause()": FunctionFragment;
    "paused()": FunctionFragment;
    "pendingRewards(address)": FunctionFragment;
    "recalculate(address,uint256)": FunctionFragment;
    "renounceRole(bytes32,address)": FunctionFragment;
    "revokeRole(bytes32,address)": FunctionFragment;
    "setBackingRatio(uint64)": FunctionFragment;
    "setVestingPeriod(uint64)": FunctionFragment;
    "setVestingRatio(uint64)": FunctionFragment;
    "settings()": FunctionFragment;
    "supportsInterface(bytes4)": FunctionFragment;
    "testTime()": FunctionFragment;
    "unpause()": FunctionFragment;
    "withdrawStockTokens(address)": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "ADMIN_ROLE",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "DEFAULT_ADMIN_ROLE",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "DENOMINATOR",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "KNINE", values?: undefined): string;
  encodeFunctionData(functionFragment: "STAKING", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "beforeDeposit",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "changeIsOnlyLocked",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "changeTestTime",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(functionFragment: "claim", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "deposit",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(functionFragment: "depositInfo", values: [string]): string;
  encodeFunctionData(functionFragment: "deposits", values: [string]): string;
  encodeFunctionData(
    functionFragment: "emergencyStop",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "endTime", values?: undefined): string;
  encodeFunctionData(functionFragment: "esKNINE", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "getRoleAdmin",
    values: [BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "grantRole",
    values: [BytesLike, string]
  ): string;
  encodeFunctionData(
    functionFragment: "hasRole",
    values: [BytesLike, string]
  ): string;
  encodeFunctionData(
    functionFragment: "initialize",
    values: [
      string,
      string,
      string,
      string,
      {
        lockedOnly: boolean;
        backingRatio: BigNumberish;
        vestingRatio: BigNumberish;
        vestingPeriod: BigNumberish;
      }
    ]
  ): string;
  encodeFunctionData(functionFragment: "pause", values?: undefined): string;
  encodeFunctionData(functionFragment: "paused", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "pendingRewards",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "recalculate",
    values: [string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "renounceRole",
    values: [BytesLike, string]
  ): string;
  encodeFunctionData(
    functionFragment: "revokeRole",
    values: [BytesLike, string]
  ): string;
  encodeFunctionData(
    functionFragment: "setBackingRatio",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "setVestingPeriod",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "setVestingRatio",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(functionFragment: "settings", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "supportsInterface",
    values: [BytesLike]
  ): string;
  encodeFunctionData(functionFragment: "testTime", values?: undefined): string;
  encodeFunctionData(functionFragment: "unpause", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "withdrawStockTokens",
    values: [string]
  ): string;

  decodeFunctionResult(functionFragment: "ADMIN_ROLE", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "DEFAULT_ADMIN_ROLE",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "DENOMINATOR",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "KNINE", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "STAKING", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "beforeDeposit",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "changeIsOnlyLocked",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "changeTestTime",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "claim", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "deposit", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "depositInfo",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "deposits", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "emergencyStop",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "endTime", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "esKNINE", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "getRoleAdmin",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "grantRole", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "hasRole", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "pause", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "paused", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "pendingRewards",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "recalculate",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "renounceRole",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "revokeRole", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "setBackingRatio",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setVestingPeriod",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setVestingRatio",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "settings", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "supportsInterface",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "testTime", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "unpause", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "withdrawStockTokens",
    data: BytesLike
  ): Result;

  events: {
    "BackingRatioChanged(uint64)": EventFragment;
    "Claimed(address,uint256)": EventFragment;
    "DepositDebtTransfer(address,uint256)": EventFragment;
    "Deposited(address,uint256,uint256,uint64)": EventFragment;
    "EarnedDebtTransfer(address,uint256)": EventFragment;
    "Initialized(uint64)": EventFragment;
    "OnlyLockedChanged(bool)": EventFragment;
    "Paused(address)": EventFragment;
    "Recalculated(address,uint256)": EventFragment;
    "RoleAdminChanged(bytes32,bytes32,bytes32)": EventFragment;
    "RoleGranted(bytes32,address,address)": EventFragment;
    "RoleRevoked(bytes32,address,address)": EventFragment;
    "StockTokensWithdrawed(address,uint256)": EventFragment;
    "Stopped(uint64)": EventFragment;
    "Unpaused(address)": EventFragment;
    "VestingPeriodChanged(uint64)": EventFragment;
    "VestingRatioChanged(uint64)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "BackingRatioChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Claimed"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "DepositDebtTransfer"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Deposited"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "EarnedDebtTransfer"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "OnlyLockedChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Paused"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Recalculated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "RoleAdminChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "RoleGranted"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "RoleRevoked"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "StockTokensWithdrawed"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Stopped"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Unpaused"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "VestingPeriodChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "VestingRatioChanged"): EventFragment;
}

export type BackingRatioChangedEvent = TypedEvent<
  [BigNumber] & { ratio: BigNumber }
>;

export type ClaimedEvent = TypedEvent<
  [string, BigNumber] & { user: string; amount: BigNumber }
>;

export type DepositDebtTransferEvent = TypedEvent<
  [string, BigNumber] & { user: string; debt: BigNumber }
>;

export type DepositedEvent = TypedEvent<
  [string, BigNumber, BigNumber, BigNumber] & {
    user: string;
    amount: BigNumber;
    potentialReward: BigNumber;
    lockEnd: BigNumber;
  }
>;

export type EarnedDebtTransferEvent = TypedEvent<
  [string, BigNumber] & { user: string; debt: BigNumber }
>;

export type InitializedEvent = TypedEvent<[BigNumber] & { version: BigNumber }>;

export type OnlyLockedChangedEvent = TypedEvent<
  [boolean] & { status: boolean }
>;

export type Paused_address_Event = TypedEvent<[string] & { account: string }>;

export type Paused_Event = TypedEvent<[] & {}>;

export type RecalculatedEvent = TypedEvent<
  [string, BigNumber] & { user: string; esKnineExcluded: BigNumber }
>;

export type RoleAdminChangedEvent = TypedEvent<
  [string, string, string] & {
    role: string;
    previousAdminRole: string;
    newAdminRole: string;
  }
>;

export type RoleGrantedEvent = TypedEvent<
  [string, string, string] & { role: string; account: string; sender: string }
>;

export type RoleRevokedEvent = TypedEvent<
  [string, string, string] & { role: string; account: string; sender: string }
>;

export type StockTokensWithdrawedEvent = TypedEvent<
  [string, BigNumber] & { token: string; amount: BigNumber }
>;

export type StoppedEvent = TypedEvent<[BigNumber] & { endTime: BigNumber }>;

export type Unpaused_address_Event = TypedEvent<[string] & { account: string }>;

export type Unpaused_Event = TypedEvent<[] & {}>;

export type VestingPeriodChangedEvent = TypedEvent<
  [BigNumber] & { duration: BigNumber }
>;

export type VestingRatioChangedEvent = TypedEvent<
  [BigNumber] & { ratio: BigNumber }
>;

export class VestingAbi extends BaseContract {
  connect(signerOrProvider: Signer | Provider | string): this;
  attach(addressOrName: string): this;
  deployed(): Promise<this>;

  listeners<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>
  ): Array<TypedListener<EventArgsArray, EventArgsObject>>;
  off<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  on<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  once<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  removeListener<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  removeAllListeners<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
  ): this;

  listeners(eventName?: string): Array<Listener>;
  off(eventName: string, listener: Listener): this;
  on(eventName: string, listener: Listener): this;
  once(eventName: string, listener: Listener): this;
  removeListener(eventName: string, listener: Listener): this;
  removeAllListeners(eventName?: string): this;

  queryFilter<EventArgsArray extends Array<any>, EventArgsObject>(
    event: TypedEventFilter<EventArgsArray, EventArgsObject>,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined
  ): Promise<Array<TypedEvent<EventArgsArray & EventArgsObject>>>;

  interface: VestingAbiInterface;

  functions: {
    ADMIN_ROLE(overrides?: CallOverrides): Promise<[string]>;

    DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<[string]>;

    DENOMINATOR(overrides?: CallOverrides): Promise<[number]>;

    KNINE(overrides?: CallOverrides): Promise<[string]>;

    STAKING(overrides?: CallOverrides): Promise<[string]>;

    beforeDeposit(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        }
      ] & {
        esKnineBalance: BigNumber;
        depositLimit: BigNumber;
        userSettings: [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        };
      }
    >;

    changeIsOnlyLocked(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    changeTestTime(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    claim(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    deposit(
      amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    depositInfo(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber
      ] & {
        inVesting: BigNumber;
        vestingEnds: BigNumber;
        reward: BigNumber;
        lockedInStaking: BigNumber;
        usedForVesting: BigNumber;
        vestingLimit: BigNumber;
        availableForVesting: BigNumber;
        stakingEnds: BigNumber;
      }
    >;

    deposits(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        },
        [BigNumber, BigNumber] & { deposited: BigNumber; earned: BigNumber }
      ] & {
        startTime: BigNumber;
        endTime: BigNumber;
        depositAmount: BigNumber;
        reservedAmount: BigNumber;
        lockedAmount: BigNumber;
        stakedAmount: BigNumber;
        potentialRewards: BigNumber;
        claimed: BigNumber;
        settings: [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        };
        debt: [BigNumber, BigNumber] & {
          deposited: BigNumber;
          earned: BigNumber;
        };
      }
    >;

    emergencyStop(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    endTime(overrides?: CallOverrides): Promise<[BigNumber]>;

    esKNINE(overrides?: CallOverrides): Promise<[string]>;

    getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<[string]>;

    grantRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    hasRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

    initialize(
      _knine: string,
      _esknine: string,
      _staking: string,
      _admin: string,
      _settings: {
        lockedOnly: boolean;
        backingRatio: BigNumberish;
        vestingRatio: BigNumberish;
        vestingPeriod: BigNumberish;
      },
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    pause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    paused(overrides?: CallOverrides): Promise<[boolean]>;

    pendingRewards(
      user: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    recalculate(
      user: string,
      unstakeAmount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    renounceRole(
      role: BytesLike,
      callerConfirmation: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    revokeRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    setBackingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    setVestingPeriod(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    setVestingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    settings(
      overrides?: CallOverrides
    ): Promise<
      [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      }
    >;

    supportsInterface(
      interfaceId: BytesLike,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

    testTime(overrides?: CallOverrides): Promise<[BigNumber]>;

    unpause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    withdrawStockTokens(
      token: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;
  };

  ADMIN_ROLE(overrides?: CallOverrides): Promise<string>;

  DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<string>;

  DENOMINATOR(overrides?: CallOverrides): Promise<number>;

  KNINE(overrides?: CallOverrides): Promise<string>;

  STAKING(overrides?: CallOverrides): Promise<string>;

  beforeDeposit(
    user: string,
    overrides?: CallOverrides
  ): Promise<
    [
      BigNumber,
      BigNumber,
      [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      }
    ] & {
      esKnineBalance: BigNumber;
      depositLimit: BigNumber;
      userSettings: [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      };
    }
  >;

  changeIsOnlyLocked(
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  changeTestTime(
    value: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  claim(
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  deposit(
    amount: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  depositInfo(
    user: string,
    overrides?: CallOverrides
  ): Promise<
    [
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber
    ] & {
      inVesting: BigNumber;
      vestingEnds: BigNumber;
      reward: BigNumber;
      lockedInStaking: BigNumber;
      usedForVesting: BigNumber;
      vestingLimit: BigNumber;
      availableForVesting: BigNumber;
      stakingEnds: BigNumber;
    }
  >;

  deposits(
    arg0: string,
    overrides?: CallOverrides
  ): Promise<
    [
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      BigNumber,
      [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      },
      [BigNumber, BigNumber] & { deposited: BigNumber; earned: BigNumber }
    ] & {
      startTime: BigNumber;
      endTime: BigNumber;
      depositAmount: BigNumber;
      reservedAmount: BigNumber;
      lockedAmount: BigNumber;
      stakedAmount: BigNumber;
      potentialRewards: BigNumber;
      claimed: BigNumber;
      settings: [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      };
      debt: [BigNumber, BigNumber] & {
        deposited: BigNumber;
        earned: BigNumber;
      };
    }
  >;

  emergencyStop(
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  endTime(overrides?: CallOverrides): Promise<BigNumber>;

  esKNINE(overrides?: CallOverrides): Promise<string>;

  getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>;

  grantRole(
    role: BytesLike,
    account: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  hasRole(
    role: BytesLike,
    account: string,
    overrides?: CallOverrides
  ): Promise<boolean>;

  initialize(
    _knine: string,
    _esknine: string,
    _staking: string,
    _admin: string,
    _settings: {
      lockedOnly: boolean;
      backingRatio: BigNumberish;
      vestingRatio: BigNumberish;
      vestingPeriod: BigNumberish;
    },
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  pause(
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  paused(overrides?: CallOverrides): Promise<boolean>;

  pendingRewards(user: string, overrides?: CallOverrides): Promise<BigNumber>;

  recalculate(
    user: string,
    unstakeAmount: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  renounceRole(
    role: BytesLike,
    callerConfirmation: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  revokeRole(
    role: BytesLike,
    account: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  setBackingRatio(
    value: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  setVestingPeriod(
    value: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  setVestingRatio(
    value: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  settings(
    overrides?: CallOverrides
  ): Promise<
    [boolean, BigNumber, BigNumber, BigNumber] & {
      lockedOnly: boolean;
      backingRatio: BigNumber;
      vestingRatio: BigNumber;
      vestingPeriod: BigNumber;
    }
  >;

  supportsInterface(
    interfaceId: BytesLike,
    overrides?: CallOverrides
  ): Promise<boolean>;

  testTime(overrides?: CallOverrides): Promise<BigNumber>;

  unpause(
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  withdrawStockTokens(
    token: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    ADMIN_ROLE(overrides?: CallOverrides): Promise<string>;

    DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<string>;

    DENOMINATOR(overrides?: CallOverrides): Promise<number>;

    KNINE(overrides?: CallOverrides): Promise<string>;

    STAKING(overrides?: CallOverrides): Promise<string>;

    beforeDeposit(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        }
      ] & {
        esKnineBalance: BigNumber;
        depositLimit: BigNumber;
        userSettings: [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        };
      }
    >;

    changeIsOnlyLocked(overrides?: CallOverrides): Promise<void>;

    changeTestTime(
      value: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    claim(overrides?: CallOverrides): Promise<void>;

    deposit(amount: BigNumberish, overrides?: CallOverrides): Promise<void>;

    depositInfo(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber
      ] & {
        inVesting: BigNumber;
        vestingEnds: BigNumber;
        reward: BigNumber;
        lockedInStaking: BigNumber;
        usedForVesting: BigNumber;
        vestingLimit: BigNumber;
        availableForVesting: BigNumber;
        stakingEnds: BigNumber;
      }
    >;

    deposits(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<
      [
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber,
        [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        },
        [BigNumber, BigNumber] & { deposited: BigNumber; earned: BigNumber }
      ] & {
        startTime: BigNumber;
        endTime: BigNumber;
        depositAmount: BigNumber;
        reservedAmount: BigNumber;
        lockedAmount: BigNumber;
        stakedAmount: BigNumber;
        potentialRewards: BigNumber;
        claimed: BigNumber;
        settings: [boolean, BigNumber, BigNumber, BigNumber] & {
          lockedOnly: boolean;
          backingRatio: BigNumber;
          vestingRatio: BigNumber;
          vestingPeriod: BigNumber;
        };
        debt: [BigNumber, BigNumber] & {
          deposited: BigNumber;
          earned: BigNumber;
        };
      }
    >;

    emergencyStop(overrides?: CallOverrides): Promise<void>;

    endTime(overrides?: CallOverrides): Promise<BigNumber>;

    esKNINE(overrides?: CallOverrides): Promise<string>;

    getRoleAdmin(role: BytesLike, overrides?: CallOverrides): Promise<string>;

    grantRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<void>;

    hasRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<boolean>;

    initialize(
      _knine: string,
      _esknine: string,
      _staking: string,
      _admin: string,
      _settings: {
        lockedOnly: boolean;
        backingRatio: BigNumberish;
        vestingRatio: BigNumberish;
        vestingPeriod: BigNumberish;
      },
      overrides?: CallOverrides
    ): Promise<void>;

    pause(overrides?: CallOverrides): Promise<void>;

    paused(overrides?: CallOverrides): Promise<boolean>;

    pendingRewards(user: string, overrides?: CallOverrides): Promise<BigNumber>;

    recalculate(
      user: string,
      unstakeAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    renounceRole(
      role: BytesLike,
      callerConfirmation: string,
      overrides?: CallOverrides
    ): Promise<void>;

    revokeRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<void>;

    setBackingRatio(
      value: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    setVestingPeriod(
      value: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    setVestingRatio(
      value: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    settings(
      overrides?: CallOverrides
    ): Promise<
      [boolean, BigNumber, BigNumber, BigNumber] & {
        lockedOnly: boolean;
        backingRatio: BigNumber;
        vestingRatio: BigNumber;
        vestingPeriod: BigNumber;
      }
    >;

    supportsInterface(
      interfaceId: BytesLike,
      overrides?: CallOverrides
    ): Promise<boolean>;

    testTime(overrides?: CallOverrides): Promise<BigNumber>;

    unpause(overrides?: CallOverrides): Promise<void>;

    withdrawStockTokens(
      token: string,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "BackingRatioChanged(uint64)"(
      ratio?: null
    ): TypedEventFilter<[BigNumber], { ratio: BigNumber }>;

    BackingRatioChanged(
      ratio?: null
    ): TypedEventFilter<[BigNumber], { ratio: BigNumber }>;

    "Claimed(address,uint256)"(
      user?: null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; amount: BigNumber }
    >;

    Claimed(
      user?: null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; amount: BigNumber }
    >;

    "DepositDebtTransfer(address,uint256)"(
      user?: null,
      debt?: null
    ): TypedEventFilter<[string, BigNumber], { user: string; debt: BigNumber }>;

    DepositDebtTransfer(
      user?: null,
      debt?: null
    ): TypedEventFilter<[string, BigNumber], { user: string; debt: BigNumber }>;

    "Deposited(address,uint256,uint256,uint64)"(
      user?: null,
      amount?: null,
      potentialReward?: null,
      lockEnd?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber, BigNumber],
      {
        user: string;
        amount: BigNumber;
        potentialReward: BigNumber;
        lockEnd: BigNumber;
      }
    >;

    Deposited(
      user?: null,
      amount?: null,
      potentialReward?: null,
      lockEnd?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber, BigNumber],
      {
        user: string;
        amount: BigNumber;
        potentialReward: BigNumber;
        lockEnd: BigNumber;
      }
    >;

    "EarnedDebtTransfer(address,uint256)"(
      user?: null,
      debt?: null
    ): TypedEventFilter<[string, BigNumber], { user: string; debt: BigNumber }>;

    EarnedDebtTransfer(
      user?: null,
      debt?: null
    ): TypedEventFilter<[string, BigNumber], { user: string; debt: BigNumber }>;

    "Initialized(uint64)"(
      version?: null
    ): TypedEventFilter<[BigNumber], { version: BigNumber }>;

    Initialized(
      version?: null
    ): TypedEventFilter<[BigNumber], { version: BigNumber }>;

    "OnlyLockedChanged(bool)"(
      status?: null
    ): TypedEventFilter<[boolean], { status: boolean }>;

    OnlyLockedChanged(
      status?: null
    ): TypedEventFilter<[boolean], { status: boolean }>;

    "Paused(address)"(
      account?: null
    ): TypedEventFilter<[string], { account: string }>;

    "Paused()"(): TypedEventFilter<[], {}>;

    "Recalculated(address,uint256)"(
      user?: null,
      esKnineExcluded?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; esKnineExcluded: BigNumber }
    >;

    Recalculated(
      user?: null,
      esKnineExcluded?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; esKnineExcluded: BigNumber }
    >;

    "RoleAdminChanged(bytes32,bytes32,bytes32)"(
      role?: BytesLike | null,
      previousAdminRole?: BytesLike | null,
      newAdminRole?: BytesLike | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; previousAdminRole: string; newAdminRole: string }
    >;

    RoleAdminChanged(
      role?: BytesLike | null,
      previousAdminRole?: BytesLike | null,
      newAdminRole?: BytesLike | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; previousAdminRole: string; newAdminRole: string }
    >;

    "RoleGranted(bytes32,address,address)"(
      role?: BytesLike | null,
      account?: string | null,
      sender?: string | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; account: string; sender: string }
    >;

    RoleGranted(
      role?: BytesLike | null,
      account?: string | null,
      sender?: string | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; account: string; sender: string }
    >;

    "RoleRevoked(bytes32,address,address)"(
      role?: BytesLike | null,
      account?: string | null,
      sender?: string | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; account: string; sender: string }
    >;

    RoleRevoked(
      role?: BytesLike | null,
      account?: string | null,
      sender?: string | null
    ): TypedEventFilter<
      [string, string, string],
      { role: string; account: string; sender: string }
    >;

    "StockTokensWithdrawed(address,uint256)"(
      token?: null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { token: string; amount: BigNumber }
    >;

    StockTokensWithdrawed(
      token?: null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { token: string; amount: BigNumber }
    >;

    "Stopped(uint64)"(
      endTime?: null
    ): TypedEventFilter<[BigNumber], { endTime: BigNumber }>;

    Stopped(
      endTime?: null
    ): TypedEventFilter<[BigNumber], { endTime: BigNumber }>;

    "Unpaused(address)"(
      account?: null
    ): TypedEventFilter<[string], { account: string }>;

    "Unpaused()"(): TypedEventFilter<[], {}>;

    "VestingPeriodChanged(uint64)"(
      duration?: null
    ): TypedEventFilter<[BigNumber], { duration: BigNumber }>;

    VestingPeriodChanged(
      duration?: null
    ): TypedEventFilter<[BigNumber], { duration: BigNumber }>;

    "VestingRatioChanged(uint64)"(
      ratio?: null
    ): TypedEventFilter<[BigNumber], { ratio: BigNumber }>;

    VestingRatioChanged(
      ratio?: null
    ): TypedEventFilter<[BigNumber], { ratio: BigNumber }>;
  };

  estimateGas: {
    ADMIN_ROLE(overrides?: CallOverrides): Promise<BigNumber>;

    DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<BigNumber>;

    DENOMINATOR(overrides?: CallOverrides): Promise<BigNumber>;

    KNINE(overrides?: CallOverrides): Promise<BigNumber>;

    STAKING(overrides?: CallOverrides): Promise<BigNumber>;

    beforeDeposit(user: string, overrides?: CallOverrides): Promise<BigNumber>;

    changeIsOnlyLocked(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    changeTestTime(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    claim(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    deposit(
      amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    depositInfo(user: string, overrides?: CallOverrides): Promise<BigNumber>;

    deposits(arg0: string, overrides?: CallOverrides): Promise<BigNumber>;

    emergencyStop(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    endTime(overrides?: CallOverrides): Promise<BigNumber>;

    esKNINE(overrides?: CallOverrides): Promise<BigNumber>;

    getRoleAdmin(
      role: BytesLike,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    grantRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    hasRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    initialize(
      _knine: string,
      _esknine: string,
      _staking: string,
      _admin: string,
      _settings: {
        lockedOnly: boolean;
        backingRatio: BigNumberish;
        vestingRatio: BigNumberish;
        vestingPeriod: BigNumberish;
      },
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    pause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    paused(overrides?: CallOverrides): Promise<BigNumber>;

    pendingRewards(user: string, overrides?: CallOverrides): Promise<BigNumber>;

    recalculate(
      user: string,
      unstakeAmount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    renounceRole(
      role: BytesLike,
      callerConfirmation: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    revokeRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    setBackingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    setVestingPeriod(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    setVestingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    settings(overrides?: CallOverrides): Promise<BigNumber>;

    supportsInterface(
      interfaceId: BytesLike,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    testTime(overrides?: CallOverrides): Promise<BigNumber>;

    unpause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    withdrawStockTokens(
      token: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    ADMIN_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    DEFAULT_ADMIN_ROLE(
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    DENOMINATOR(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    KNINE(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    STAKING(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    beforeDeposit(
      user: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    changeIsOnlyLocked(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    changeTestTime(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    claim(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    deposit(
      amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    depositInfo(
      user: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    deposits(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    emergencyStop(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    endTime(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    esKNINE(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    getRoleAdmin(
      role: BytesLike,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    grantRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    hasRole(
      role: BytesLike,
      account: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    initialize(
      _knine: string,
      _esknine: string,
      _staking: string,
      _admin: string,
      _settings: {
        lockedOnly: boolean;
        backingRatio: BigNumberish;
        vestingRatio: BigNumberish;
        vestingPeriod: BigNumberish;
      },
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    pause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    paused(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    pendingRewards(
      user: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    recalculate(
      user: string,
      unstakeAmount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    renounceRole(
      role: BytesLike,
      callerConfirmation: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    revokeRole(
      role: BytesLike,
      account: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    setBackingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    setVestingPeriod(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    setVestingRatio(
      value: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    settings(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    supportsInterface(
      interfaceId: BytesLike,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    testTime(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    unpause(
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    withdrawStockTokens(
      token: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;
  };
}