@augmentedfinance/protocol-v1/dist/types/IStakeToken.d.ts

Augmented Protocol smart contracts

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

import {
  ethers,
  EventFilter,
  Signer,
  BigNumber,
  BigNumberish,
  PopulatedTransaction,
} from "ethers";
import {
  Contract,
  ContractTransaction,
  Overrides,
  CallOverrides,
} from "@ethersproject/contracts";
import { BytesLike } from "@ethersproject/bytes";
import { Listener, Provider } from "@ethersproject/providers";
import { FunctionFragment, EventFragment, Result } from "@ethersproject/abi";

interface IStakeTokenInterface extends ethers.utils.Interface {
  functions: {
    "UNDERLYING_ASSET_ADDRESS()": FunctionFragment;
    "balanceAndCooldownOf(address)": FunctionFragment;
    "balanceOfUnderlying(address)": FunctionFragment;
    "cooldown()": FunctionFragment;
    "exchangeRate()": FunctionFragment;
    "getCooldown(address)": FunctionFragment;
    "getIncentivesController()": FunctionFragment;
    "getMaxSlashablePercentage()": FunctionFragment;
    "isRedeemable()": FunctionFragment;
    "redeem(address,uint256)": FunctionFragment;
    "redeemUnderlying(address,uint256)": FunctionFragment;
    "rewardedBalanceOf(address)": FunctionFragment;
    "setIncentivesController(address)": FunctionFragment;
    "stake(address,uint256,uint256)": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "UNDERLYING_ASSET_ADDRESS",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "balanceAndCooldownOf",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "balanceOfUnderlying",
    values: [string]
  ): string;
  encodeFunctionData(functionFragment: "cooldown", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "exchangeRate",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "getCooldown", values: [string]): string;
  encodeFunctionData(
    functionFragment: "getIncentivesController",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getMaxSlashablePercentage",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "isRedeemable",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "redeem",
    values: [string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "redeemUnderlying",
    values: [string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "rewardedBalanceOf",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "setIncentivesController",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "stake",
    values: [string, BigNumberish, BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "UNDERLYING_ASSET_ADDRESS",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "balanceAndCooldownOf",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "balanceOfUnderlying",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "cooldown", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "exchangeRate",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getCooldown",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getIncentivesController",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMaxSlashablePercentage",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "isRedeemable",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "redeem", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "redeemUnderlying",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "rewardedBalanceOf",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setIncentivesController",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "stake", data: BytesLike): Result;

  events: {
    "CooldownStarted(address,uint32)": EventFragment;
    "Redeemed(address,address,uint256,uint256)": EventFragment;
    "Staked(address,address,uint256,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "CooldownStarted"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Redeemed"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Staked"): EventFragment;
}

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

  on(event: EventFilter | string, listener: Listener): this;
  once(event: EventFilter | string, listener: Listener): this;
  addListener(eventName: EventFilter | string, listener: Listener): this;
  removeAllListeners(eventName: EventFilter | string): this;
  removeListener(eventName: any, listener: Listener): this;

  interface: IStakeTokenInterface;

  functions: {
    UNDERLYING_ASSET_ADDRESS(overrides?: CallOverrides): Promise<{
      0: string;
    }>;

    "UNDERLYING_ASSET_ADDRESS()"(overrides?: CallOverrides): Promise<{
      0: string;
    }>;

    balanceAndCooldownOf(
      holder: string,
      overrides?: CallOverrides
    ): Promise<{
      balance: BigNumber;
      windowStart: number;
      windowEnd: number;
      0: BigNumber;
      1: number;
      2: number;
    }>;

    "balanceAndCooldownOf(address)"(
      holder: string,
      overrides?: CallOverrides
    ): Promise<{
      balance: BigNumber;
      windowStart: number;
      windowEnd: number;
      0: BigNumber;
      1: number;
      2: number;
    }>;

    balanceOfUnderlying(
      account: string,
      overrides?: CallOverrides
    ): Promise<{
      0: BigNumber;
    }>;

    "balanceOfUnderlying(address)"(
      account: string,
      overrides?: CallOverrides
    ): Promise<{
      0: BigNumber;
    }>;

    cooldown(overrides?: Overrides): Promise<ContractTransaction>;

    "cooldown()"(overrides?: Overrides): Promise<ContractTransaction>;

    exchangeRate(overrides?: CallOverrides): Promise<{
      0: BigNumber;
    }>;

    "exchangeRate()"(overrides?: CallOverrides): Promise<{
      0: BigNumber;
    }>;

    getCooldown(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<{
      0: number;
    }>;

    "getCooldown(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<{
      0: number;
    }>;

    getIncentivesController(overrides?: CallOverrides): Promise<{
      0: string;
    }>;

    "getIncentivesController()"(overrides?: CallOverrides): Promise<{
      0: string;
    }>;

    getMaxSlashablePercentage(overrides?: CallOverrides): Promise<{
      0: number;
    }>;

    "getMaxSlashablePercentage()"(overrides?: CallOverrides): Promise<{
      0: number;
    }>;

    isRedeemable(overrides?: CallOverrides): Promise<{
      0: boolean;
    }>;

    "isRedeemable()"(overrides?: CallOverrides): Promise<{
      0: boolean;
    }>;

    redeem(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "redeem(address,uint256)"(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    redeemUnderlying(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "redeemUnderlying(address,uint256)"(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    rewardedBalanceOf(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<{
      0: BigNumber;
    }>;

    "rewardedBalanceOf(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<{
      0: BigNumber;
    }>;

    setIncentivesController(
      arg0: string,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "setIncentivesController(address)"(
      arg0: string,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    stake(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "stake(address,uint256,uint256)"(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;
  };

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

  "UNDERLYING_ASSET_ADDRESS()"(overrides?: CallOverrides): Promise<string>;

  balanceAndCooldownOf(
    holder: string,
    overrides?: CallOverrides
  ): Promise<{
    balance: BigNumber;
    windowStart: number;
    windowEnd: number;
    0: BigNumber;
    1: number;
    2: number;
  }>;

  "balanceAndCooldownOf(address)"(
    holder: string,
    overrides?: CallOverrides
  ): Promise<{
    balance: BigNumber;
    windowStart: number;
    windowEnd: number;
    0: BigNumber;
    1: number;
    2: number;
  }>;

  balanceOfUnderlying(
    account: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  "balanceOfUnderlying(address)"(
    account: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  cooldown(overrides?: Overrides): Promise<ContractTransaction>;

  "cooldown()"(overrides?: Overrides): Promise<ContractTransaction>;

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

  "exchangeRate()"(overrides?: CallOverrides): Promise<BigNumber>;

  getCooldown(arg0: string, overrides?: CallOverrides): Promise<number>;

  "getCooldown(address)"(
    arg0: string,
    overrides?: CallOverrides
  ): Promise<number>;

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

  "getIncentivesController()"(overrides?: CallOverrides): Promise<string>;

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

  "getMaxSlashablePercentage()"(overrides?: CallOverrides): Promise<number>;

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

  "isRedeemable()"(overrides?: CallOverrides): Promise<boolean>;

  redeem(
    to: string,
    maxStakeAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "redeem(address,uint256)"(
    to: string,
    maxStakeAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  redeemUnderlying(
    to: string,
    maxUnderlyingAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "redeemUnderlying(address,uint256)"(
    to: string,
    maxUnderlyingAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

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

  "rewardedBalanceOf(address)"(
    arg0: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  setIncentivesController(
    arg0: string,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "setIncentivesController(address)"(
    arg0: string,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  stake(
    to: string,
    underlyingAmount: BigNumberish,
    referral: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "stake(address,uint256,uint256)"(
    to: string,
    underlyingAmount: BigNumberish,
    referral: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

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

    "UNDERLYING_ASSET_ADDRESS()"(overrides?: CallOverrides): Promise<string>;

    balanceAndCooldownOf(
      holder: string,
      overrides?: CallOverrides
    ): Promise<{
      balance: BigNumber;
      windowStart: number;
      windowEnd: number;
      0: BigNumber;
      1: number;
      2: number;
    }>;

    "balanceAndCooldownOf(address)"(
      holder: string,
      overrides?: CallOverrides
    ): Promise<{
      balance: BigNumber;
      windowStart: number;
      windowEnd: number;
      0: BigNumber;
      1: number;
      2: number;
    }>;

    balanceOfUnderlying(
      account: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "balanceOfUnderlying(address)"(
      account: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    "cooldown()"(overrides?: CallOverrides): Promise<void>;

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

    "exchangeRate()"(overrides?: CallOverrides): Promise<BigNumber>;

    getCooldown(arg0: string, overrides?: CallOverrides): Promise<number>;

    "getCooldown(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<number>;

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

    "getIncentivesController()"(overrides?: CallOverrides): Promise<string>;

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

    "getMaxSlashablePercentage()"(overrides?: CallOverrides): Promise<number>;

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

    "isRedeemable()"(overrides?: CallOverrides): Promise<boolean>;

    redeem(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "redeem(address,uint256)"(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    redeemUnderlying(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "redeemUnderlying(address,uint256)"(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    "rewardedBalanceOf(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setIncentivesController(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<void>;

    "setIncentivesController(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<void>;

    stake(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "stake(address,uint256,uint256)"(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  filters: {
    CooldownStarted(account: string | null, at: null): EventFilter;

    Redeemed(
      from: string | null,
      to: string | null,
      amount: null,
      underlyingAmount: null
    ): EventFilter;

    Staked(
      from: string | null,
      to: string | null,
      amount: null,
      referal: BigNumberish | null
    ): EventFilter;
  };

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

    "UNDERLYING_ASSET_ADDRESS()"(overrides?: CallOverrides): Promise<BigNumber>;

    balanceAndCooldownOf(
      holder: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "balanceAndCooldownOf(address)"(
      holder: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    balanceOfUnderlying(
      account: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "balanceOfUnderlying(address)"(
      account: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    cooldown(overrides?: Overrides): Promise<BigNumber>;

    "cooldown()"(overrides?: Overrides): Promise<BigNumber>;

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

    "exchangeRate()"(overrides?: CallOverrides): Promise<BigNumber>;

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

    "getCooldown(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    "getIncentivesController()"(overrides?: CallOverrides): Promise<BigNumber>;

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

    "getMaxSlashablePercentage()"(
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    "isRedeemable()"(overrides?: CallOverrides): Promise<BigNumber>;

    redeem(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "redeem(address,uint256)"(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    redeemUnderlying(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "redeemUnderlying(address,uint256)"(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

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

    "rewardedBalanceOf(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setIncentivesController(
      arg0: string,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "setIncentivesController(address)"(
      arg0: string,
      overrides?: Overrides
    ): Promise<BigNumber>;

    stake(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "stake(address,uint256,uint256)"(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;
  };

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

    "UNDERLYING_ASSET_ADDRESS()"(
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    balanceAndCooldownOf(
      holder: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    "balanceAndCooldownOf(address)"(
      holder: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    balanceOfUnderlying(
      account: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    "balanceOfUnderlying(address)"(
      account: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    cooldown(overrides?: Overrides): Promise<PopulatedTransaction>;

    "cooldown()"(overrides?: Overrides): Promise<PopulatedTransaction>;

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

    "exchangeRate()"(overrides?: CallOverrides): Promise<PopulatedTransaction>;

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

    "getCooldown(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    "getIncentivesController()"(
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    "getMaxSlashablePercentage()"(
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    "isRedeemable()"(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    redeem(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "redeem(address,uint256)"(
      to: string,
      maxStakeAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    redeemUnderlying(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "redeemUnderlying(address,uint256)"(
      to: string,
      maxUnderlyingAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

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

    "rewardedBalanceOf(address)"(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    setIncentivesController(
      arg0: string,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "setIncentivesController(address)"(
      arg0: string,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    stake(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "stake(address,uint256,uint256)"(
      to: string,
      underlyingAmount: BigNumberish,
      referral: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;
  };
}