@ohgeez/fsushi/typechain-types/contracts/interfaces/IFlashStrategy.ts

fSUSHI is a protocol built on top of [FlashStake](http://flashstake.io/) and [SushiSwap](https://sushi.com) that enables stakers to get instant, upfront yield without waiting for it to accrue.

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */
import type {
  BaseContract,
  BigNumber,
  BigNumberish,
  BytesLike,
  CallOverrides,
  ContractTransaction,
  Overrides,
  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 interface IFlashStrategyInterface extends utils.Interface {
  functions: {
    "burnFToken(uint256,uint256,address)": FunctionFragment;
    "depositPrincipal(uint256)": FunctionFragment;
    "getMaxStakeDuration()": FunctionFragment;
    "getPrincipalAddress()": FunctionFragment;
    "getPrincipalBalance()": FunctionFragment;
    "getYieldBalance()": FunctionFragment;
    "quoteBurnFToken(uint256)": FunctionFragment;
    "quoteMintFToken(uint256,uint256)": FunctionFragment;
    "setFTokenAddress(address)": FunctionFragment;
    "withdrawPrincipal(uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "burnFToken"
      | "depositPrincipal"
      | "getMaxStakeDuration"
      | "getPrincipalAddress"
      | "getPrincipalBalance"
      | "getYieldBalance"
      | "quoteBurnFToken"
      | "quoteMintFToken"
      | "setFTokenAddress"
      | "withdrawPrincipal"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "burnFToken",
    values: [
      PromiseOrValue<BigNumberish>,
      PromiseOrValue<BigNumberish>,
      PromiseOrValue<string>
    ]
  ): string;
  encodeFunctionData(
    functionFragment: "depositPrincipal",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getMaxStakeDuration",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getPrincipalAddress",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getPrincipalBalance",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getYieldBalance",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "quoteBurnFToken",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "quoteMintFToken",
    values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "setFTokenAddress",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "withdrawPrincipal",
    values: [PromiseOrValue<BigNumberish>]
  ): string;

  decodeFunctionResult(functionFragment: "burnFToken", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "depositPrincipal",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMaxStakeDuration",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getPrincipalAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getPrincipalBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getYieldBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "quoteBurnFToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "quoteMintFToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setFTokenAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "withdrawPrincipal",
    data: BytesLike
  ): Result;

  events: {
    "BurnedFToken(address,uint256,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "BurnedFToken"): EventFragment;
}

export interface BurnedFTokenEventObject {
  _address: string;
  _tokenAmount: BigNumber;
  _yieldReturned: BigNumber;
}
export type BurnedFTokenEvent = TypedEvent<
  [string, BigNumber, BigNumber],
  BurnedFTokenEventObject
>;

export type BurnedFTokenEventFilter = TypedEventFilter<BurnedFTokenEvent>;

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

  interface: IFlashStrategyInterface;

  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: {
    burnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      _minimumReturned: PromiseOrValue<BigNumberish>,
      _yieldTo: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    depositPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

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

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

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

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

    quoteBurnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    quoteMintFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      duration: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    setFTokenAddress(
      _fTokenAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    withdrawPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;
  };

  burnFToken(
    _tokenAmount: PromiseOrValue<BigNumberish>,
    _minimumReturned: PromiseOrValue<BigNumberish>,
    _yieldTo: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  depositPrincipal(
    _tokenAmount: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

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

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

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

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

  quoteBurnFToken(
    _tokenAmount: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  quoteMintFToken(
    _tokenAmount: PromiseOrValue<BigNumberish>,
    duration: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  setFTokenAddress(
    _fTokenAddress: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  withdrawPrincipal(
    _tokenAmount: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    burnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      _minimumReturned: PromiseOrValue<BigNumberish>,
      _yieldTo: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    depositPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

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

    quoteBurnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    quoteMintFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      duration: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setFTokenAddress(
      _fTokenAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    withdrawPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "BurnedFToken(address,uint256,uint256)"(
      _address?: PromiseOrValue<string> | null,
      _tokenAmount?: null,
      _yieldReturned?: null
    ): BurnedFTokenEventFilter;
    BurnedFToken(
      _address?: PromiseOrValue<string> | null,
      _tokenAmount?: null,
      _yieldReturned?: null
    ): BurnedFTokenEventFilter;
  };

  estimateGas: {
    burnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      _minimumReturned: PromiseOrValue<BigNumberish>,
      _yieldTo: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    depositPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

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

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

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

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

    quoteBurnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    quoteMintFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      duration: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setFTokenAddress(
      _fTokenAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    withdrawPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    burnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      _minimumReturned: PromiseOrValue<BigNumberish>,
      _yieldTo: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    depositPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

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

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

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

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

    quoteBurnFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    quoteMintFToken(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      duration: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    setFTokenAddress(
      _fTokenAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    withdrawPrincipal(
      _tokenAmount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;
  };
}