@ohgeez/fsushi/typechain-types/contracts/interfaces/IFSushiRestaurant.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 } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type {
  TypedEventFilter,
  TypedEvent,
  TypedListener,
  OnEvent,
  PromiseOrValue,
} from "../../common";

export interface IFSushiRestaurantInterface extends utils.Interface {
  functions: {
    "checkpoint()": FunctionFragment;
    "checkpointedTotalAssets()": FunctionFragment;
    "checkpointedTotalAssetsDuring(uint256)": FunctionFragment;
    "lastCheckpoint()": FunctionFragment;
    "startWeek()": FunctionFragment;
    "totalAssets()": FunctionFragment;
    "totalAssetsDuring(uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "checkpoint"
      | "checkpointedTotalAssets"
      | "checkpointedTotalAssetsDuring"
      | "lastCheckpoint"
      | "startWeek"
      | "totalAssets"
      | "totalAssetsDuring"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "checkpoint",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "checkpointedTotalAssets",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "checkpointedTotalAssetsDuring",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "lastCheckpoint",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "startWeek", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "totalAssets",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "totalAssetsDuring",
    values: [PromiseOrValue<BigNumberish>]
  ): string;

  decodeFunctionResult(functionFragment: "checkpoint", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "checkpointedTotalAssets",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "checkpointedTotalAssetsDuring",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "lastCheckpoint",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "startWeek", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "totalAssets",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "totalAssetsDuring",
    data: BytesLike
  ): Result;

  events: {};
}

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

  interface: IFSushiRestaurantInterface;

  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: {
    checkpoint(
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

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

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

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

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

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

    totalAssetsDuring(
      week: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;
  };

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

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

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

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

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

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

  totalAssetsDuring(
    week: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  callStatic: {
    checkpoint(overrides?: CallOverrides): Promise<void>;

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

    checkpointedTotalAssetsDuring(
      week: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

    totalAssetsDuring(
      week: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  filters: {};

  estimateGas: {
    checkpoint(
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

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

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

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

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

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

    totalAssetsDuring(
      week: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    checkpoint(
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

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

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

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

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

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

    totalAssetsDuring(
      week: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;
  };
}