@augmentedfinance/protocol-v1/dist/types/IManagedStakeToken.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 IManagedStakeTokenInterface extends ethers.utils.Interface {
  functions: {
    "isPaused()": FunctionFragment;
    "setCooldown(uint32,uint32)": FunctionFragment;
    "setMaxSlashablePercentage(uint16)": FunctionFragment;
    "setPaused(bool)": FunctionFragment;
    "setRedeemable(bool)": FunctionFragment;
    "slashUnderlying(address,uint256,uint256)": FunctionFragment;
  };

  encodeFunctionData(functionFragment: "isPaused", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "setCooldown",
    values: [BigNumberish, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "setMaxSlashablePercentage",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(functionFragment: "setPaused", values: [boolean]): string;
  encodeFunctionData(
    functionFragment: "setRedeemable",
    values: [boolean]
  ): string;
  encodeFunctionData(
    functionFragment: "slashUnderlying",
    values: [string, BigNumberish, BigNumberish]
  ): string;

  decodeFunctionResult(functionFragment: "isPaused", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "setCooldown",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setMaxSlashablePercentage",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "setPaused", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "setRedeemable",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "slashUnderlying",
    data: BytesLike
  ): Result;

  events: {
    "CooldownUpdated(uint32,uint32)": EventFragment;
    "EmergencyPaused(address,bool)": EventFragment;
    "MaxSlashUpdated(uint16)": EventFragment;
    "RedeemableUpdated(bool)": EventFragment;
    "Slashed(address,uint256,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "CooldownUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "EmergencyPaused"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "MaxSlashUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "RedeemableUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Slashed"): EventFragment;
}

export class IManagedStakeToken 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: IManagedStakeTokenInterface;

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

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

    setCooldown(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "setCooldown(uint32,uint32)"(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    setMaxSlashablePercentage(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "setMaxSlashablePercentage(uint16)"(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    setPaused(
      paused: boolean,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "setPaused(bool)"(
      paused: boolean,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    setRedeemable(
      redeemable: boolean,
      overrides?: Overrides
    ): Promise<ContractTransaction>;

    "setRedeemable(bool)"(
      redeemable: boolean,
      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>;
  };

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

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

  setCooldown(
    cooldownPeriod: BigNumberish,
    unstakePeriod: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "setCooldown(uint32,uint32)"(
    cooldownPeriod: BigNumberish,
    unstakePeriod: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  setMaxSlashablePercentage(
    percentage: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "setMaxSlashablePercentage(uint16)"(
    percentage: BigNumberish,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  setPaused(
    paused: boolean,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "setPaused(bool)"(
    paused: boolean,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  setRedeemable(
    redeemable: boolean,
    overrides?: Overrides
  ): Promise<ContractTransaction>;

  "setRedeemable(bool)"(
    redeemable: boolean,
    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>;

  callStatic: {
    isPaused(overrides?: CallOverrides): Promise<boolean>;

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

    setCooldown(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    "setCooldown(uint32,uint32)"(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    setMaxSlashablePercentage(
      percentage: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    "setMaxSlashablePercentage(uint16)"(
      percentage: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

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

    "setPaused(bool)"(
      paused: boolean,
      overrides?: CallOverrides
    ): Promise<void>;

    setRedeemable(
      redeemable: boolean,
      overrides?: CallOverrides
    ): Promise<void>;

    "setRedeemable(bool)"(
      redeemable: boolean,
      overrides?: CallOverrides
    ): Promise<void>;

    slashUnderlying(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      amount: BigNumber;
      erc20Transfer: boolean;
      0: BigNumber;
      1: boolean;
    }>;

    "slashUnderlying(address,uint256,uint256)"(
      destination: string,
      minAmount: BigNumberish,
      maxAmount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      amount: BigNumber;
      erc20Transfer: boolean;
      0: BigNumber;
      1: boolean;
    }>;
  };

  filters: {
    CooldownUpdated(cooldownPeriod: null, unstakePeriod: null): EventFilter;

    EmergencyPaused(by: string | null, paused: null): EventFilter;

    MaxSlashUpdated(maxSlash: null): EventFilter;

    RedeemableUpdated(redeemable: null): EventFilter;

    Slashed(to: null, amount: null, totalBeforeSlash: null): EventFilter;
  };

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

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

    setCooldown(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "setCooldown(uint32,uint32)"(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    setMaxSlashablePercentage(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "setMaxSlashablePercentage(uint16)"(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<BigNumber>;

    setPaused(paused: boolean, overrides?: Overrides): Promise<BigNumber>;

    "setPaused(bool)"(
      paused: boolean,
      overrides?: Overrides
    ): Promise<BigNumber>;

    setRedeemable(
      redeemable: boolean,
      overrides?: Overrides
    ): Promise<BigNumber>;

    "setRedeemable(bool)"(
      redeemable: boolean,
      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>;
  };

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

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

    setCooldown(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "setCooldown(uint32,uint32)"(
      cooldownPeriod: BigNumberish,
      unstakePeriod: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    setMaxSlashablePercentage(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "setMaxSlashablePercentage(uint16)"(
      percentage: BigNumberish,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    setPaused(
      paused: boolean,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "setPaused(bool)"(
      paused: boolean,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    setRedeemable(
      redeemable: boolean,
      overrides?: Overrides
    ): Promise<PopulatedTransaction>;

    "setRedeemable(bool)"(
      redeemable: boolean,
      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>;
  };
}