@ohgeez/fsushi/typechain-types/contracts/SousChef.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 SousChefInterface extends utils.Interface {
  functions: {
    "checkpoint()": FunctionFragment;
    "createBill(uint256)": FunctionFragment;
    "fSushi()": FunctionFragment;
    "flashStrategyFactory()": FunctionFragment;
    "getBill(uint256)": FunctionFragment;
    "kitchen()": FunctionFragment;
    "lastCheckpoint()": FunctionFragment;
    "mintFSushi(uint256,address,uint256)": FunctionFragment;
    "owner()": FunctionFragment;
    "predictBillAddress(uint256)": FunctionFragment;
    "renounceOwnership()": FunctionFragment;
    "restaurant()": FunctionFragment;
    "startWeek()": FunctionFragment;
    "transferOwnership(address)": FunctionFragment;
    "updateKitchen(address)": FunctionFragment;
    "updateRestaurant(address)": FunctionFragment;
    "weeklyRewards(uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "checkpoint"
      | "createBill"
      | "fSushi"
      | "flashStrategyFactory"
      | "getBill"
      | "kitchen"
      | "lastCheckpoint"
      | "mintFSushi"
      | "owner"
      | "predictBillAddress"
      | "renounceOwnership"
      | "restaurant"
      | "startWeek"
      | "transferOwnership"
      | "updateKitchen"
      | "updateRestaurant"
      | "weeklyRewards"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "checkpoint",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "createBill",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(functionFragment: "fSushi", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "flashStrategyFactory",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getBill",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(functionFragment: "kitchen", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "lastCheckpoint",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "mintFSushi",
    values: [
      PromiseOrValue<BigNumberish>,
      PromiseOrValue<string>,
      PromiseOrValue<BigNumberish>
    ]
  ): string;
  encodeFunctionData(functionFragment: "owner", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "predictBillAddress",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "renounceOwnership",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "restaurant",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "startWeek", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "transferOwnership",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateKitchen",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateRestaurant",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "weeklyRewards",
    values: [PromiseOrValue<BigNumberish>]
  ): string;

  decodeFunctionResult(functionFragment: "checkpoint", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "createBill", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "fSushi", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "flashStrategyFactory",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getBill", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "kitchen", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "lastCheckpoint",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "mintFSushi", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "predictBillAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "renounceOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "restaurant", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "startWeek", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "transferOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateKitchen",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateRestaurant",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "weeklyRewards",
    data: BytesLike
  ): Result;

  events: {
    "Checkpoint()": EventFragment;
    "CreateBill(uint256,address)": EventFragment;
    "OwnershipTransferred(address,address)": EventFragment;
    "UpdateKitchen(address)": EventFragment;
    "UpdateRestaurant(address)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "Checkpoint"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "CreateBill"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateKitchen"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateRestaurant"): EventFragment;
}

export interface CheckpointEventObject {}
export type CheckpointEvent = TypedEvent<[], CheckpointEventObject>;

export type CheckpointEventFilter = TypedEventFilter<CheckpointEvent>;

export interface CreateBillEventObject {
  pid: BigNumber;
  bill: string;
}
export type CreateBillEvent = TypedEvent<
  [BigNumber, string],
  CreateBillEventObject
>;

export type CreateBillEventFilter = TypedEventFilter<CreateBillEvent>;

export interface OwnershipTransferredEventObject {
  previousOwner: string;
  newOwner: string;
}
export type OwnershipTransferredEvent = TypedEvent<
  [string, string],
  OwnershipTransferredEventObject
>;

export type OwnershipTransferredEventFilter =
  TypedEventFilter<OwnershipTransferredEvent>;

export interface UpdateKitchenEventObject {
  kitchen: string;
}
export type UpdateKitchenEvent = TypedEvent<[string], UpdateKitchenEventObject>;

export type UpdateKitchenEventFilter = TypedEventFilter<UpdateKitchenEvent>;

export interface UpdateRestaurantEventObject {
  restaurant: string;
}
export type UpdateRestaurantEvent = TypedEvent<
  [string],
  UpdateRestaurantEventObject
>;

export type UpdateRestaurantEventFilter =
  TypedEventFilter<UpdateRestaurantEvent>;

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

  interface: SousChefInterface;

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

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

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

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

    getBill(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[string]>;

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

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

    mintFSushi(
      pid: PromiseOrValue<BigNumberish>,
      to: PromiseOrValue<string>,
      amount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

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

    predictBillAddress(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[string] & { bill: string }>;

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

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

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

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

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

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

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

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

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

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

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

  getBill(
    arg0: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<string>;

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

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

  mintFSushi(
    pid: PromiseOrValue<BigNumberish>,
    to: PromiseOrValue<string>,
    amount: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

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

  predictBillAddress(
    pid: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<string>;

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

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

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

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

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

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

  weeklyRewards(
    arg0: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

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

    createBill(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

    getBill(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

    mintFSushi(
      pid: PromiseOrValue<BigNumberish>,
      to: PromiseOrValue<string>,
      amount: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

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

    predictBillAddress(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

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

    transferOwnership(
      newOwner: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    updateKitchen(
      _kitchen: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    updateRestaurant(
      _restaurant: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    weeklyRewards(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  filters: {
    "Checkpoint()"(): CheckpointEventFilter;
    Checkpoint(): CheckpointEventFilter;

    "CreateBill(uint256,address)"(
      pid?: PromiseOrValue<BigNumberish> | null,
      bill?: PromiseOrValue<string> | null
    ): CreateBillEventFilter;
    CreateBill(
      pid?: PromiseOrValue<BigNumberish> | null,
      bill?: PromiseOrValue<string> | null
    ): CreateBillEventFilter;

    "OwnershipTransferred(address,address)"(
      previousOwner?: PromiseOrValue<string> | null,
      newOwner?: PromiseOrValue<string> | null
    ): OwnershipTransferredEventFilter;
    OwnershipTransferred(
      previousOwner?: PromiseOrValue<string> | null,
      newOwner?: PromiseOrValue<string> | null
    ): OwnershipTransferredEventFilter;

    "UpdateKitchen(address)"(
      kitchen?: PromiseOrValue<string> | null
    ): UpdateKitchenEventFilter;
    UpdateKitchen(
      kitchen?: PromiseOrValue<string> | null
    ): UpdateKitchenEventFilter;

    "UpdateRestaurant(address)"(
      restaurant?: PromiseOrValue<string> | null
    ): UpdateRestaurantEventFilter;
    UpdateRestaurant(
      restaurant?: PromiseOrValue<string> | null
    ): UpdateRestaurantEventFilter;
  };

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

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

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

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

    getBill(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

    mintFSushi(
      pid: PromiseOrValue<BigNumberish>,
      to: PromiseOrValue<string>,
      amount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

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

    predictBillAddress(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

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

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

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

    weeklyRewards(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

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

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

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

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

    getBill(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

    mintFSushi(
      pid: PromiseOrValue<BigNumberish>,
      to: PromiseOrValue<string>,
      amount: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

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

    predictBillAddress(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

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

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

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

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

    weeklyRewards(
      arg0: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;
  };
}