@augumented-finance/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;
    "cooldown()": FunctionFragment;
    "exchangeRate()": FunctionFragment;
    "getCooldown(address)": FunctionFragment;
    "isRedeemable()": FunctionFragment;
    "redeem(address,uint256)": FunctionFragment;
    "redeemUnderlying(address,uint256)": FunctionFragment;
    "slashUnderlying(address,uint256,uint256)": FunctionFragment;
    "stake(address,uint256)": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "UNDERLYING_ASSET_ADDRESS",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "cooldown", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "exchangeRate",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "getCooldown", values: [string]): string;
  encodeFunctionData(
    functionFragment: "isRedeemable",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "redeem",
    values: [string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "redeemUnderlying",
    values: [string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "slashUnderlying",
    values: [string, BigNumberish, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "stake",
    values: [string, BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "UNDERLYING_ASSET_ADDRESS",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "cooldown", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "exchangeRate",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getCooldown",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "isRedeemable",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "redeem", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "redeemUnderlying",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "slashUnderlying",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "stake", data: BytesLike): Result;

  events: {};
}

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;
    }>;

    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?: Overrides
    ): Promise<ContractTransaction>;

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

    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>;

    slashUnderlying(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "slashUnderlying(address,uint256,uint256)"(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

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

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

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

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

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

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

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

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

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

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

  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>;

  slashUnderlying(
    destination: string,
    minAmount: BigNumberish,
    maxAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "slashUnderlying(address,uint256,uint256)"(
    destination: string,
    minAmount: BigNumberish,
    maxAmount: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

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

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

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

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

    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>;

    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>;

    slashUnderlying(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "slashUnderlying(address,uint256,uint256)"(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

  filters: {};

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

    "UNDERLYING_ASSET_ADDRESS()"(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?: Overrides): Promise<BigNumber>;

    "getCooldown(address)"(
      arg0: string,
      overrides?: Overrides
    ): 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>;

    slashUnderlying(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "slashUnderlying(address,uint256,uint256)"(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

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

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

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

    "UNDERLYING_ASSET_ADDRESS()"(
      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?: Overrides
    ): Promise<PopulatedTransaction>;

    "getCooldown(address)"(
      arg0: string,
      overrides?: Overrides
    ): 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>;

    slashUnderlying(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "slashUnderlying(address,uint256,uint256)"(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

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

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