@ohgeez/fsushi/typechain-types/contracts/interfaces/IFSushiKitchen.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 IFSushiKitchenInterface extends utils.Interface {
  functions: {
    "addPool(uint256)": FunctionFragment;
    "checkpoint(uint256)": FunctionFragment;
    "flashStrategyFactory()": FunctionFragment;
    "relativeWeight(uint256)": FunctionFragment;
    "relativeWeightAt(uint256,uint256)": FunctionFragment;
    "totalWeightPoints()": FunctionFragment;
    "totalWeightPointsAt(uint256)": FunctionFragment;
    "totalWeightPointsLength()": FunctionFragment;
    "updateWeight(uint256,uint256)": FunctionFragment;
    "weightPoints(uint256)": FunctionFragment;
    "weightPointsAt(uint256,uint256)": FunctionFragment;
    "weightPointsLength(uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "addPool"
      | "checkpoint"
      | "flashStrategyFactory"
      | "relativeWeight"
      | "relativeWeightAt"
      | "totalWeightPoints"
      | "totalWeightPointsAt"
      | "totalWeightPointsLength"
      | "updateWeight"
      | "weightPoints"
      | "weightPointsAt"
      | "weightPointsLength"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "addPool",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "checkpoint",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "flashStrategyFactory",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "relativeWeight",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "relativeWeightAt",
    values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "totalWeightPoints",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "totalWeightPointsAt",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "totalWeightPointsLength",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "updateWeight",
    values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "weightPoints",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "weightPointsAt",
    values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "weightPointsLength",
    values: [PromiseOrValue<BigNumberish>]
  ): string;

  decodeFunctionResult(functionFragment: "addPool", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "checkpoint", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "flashStrategyFactory",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "relativeWeight",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "relativeWeightAt",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "totalWeightPoints",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "totalWeightPointsAt",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "totalWeightPointsLength",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateWeight",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "weightPoints",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "weightPointsAt",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "weightPointsLength",
    data: BytesLike
  ): Result;

  events: {
    "AddPool(uint256)": EventFragment;
    "UpdateWeight(uint256,uint256,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "AddPool"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateWeight"): EventFragment;
}

export interface AddPoolEventObject {
  pid: BigNumber;
}
export type AddPoolEvent = TypedEvent<[BigNumber], AddPoolEventObject>;

export type AddPoolEventFilter = TypedEventFilter<AddPoolEvent>;

export interface UpdateWeightEventObject {
  pid: BigNumber;
  weightPoints: BigNumber;
  totalWeightPoints: BigNumber;
}
export type UpdateWeightEvent = TypedEvent<
  [BigNumber, BigNumber, BigNumber],
  UpdateWeightEventObject
>;

export type UpdateWeightEventFilter = TypedEventFilter<UpdateWeightEvent>;

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

  interface: IFSushiKitchenInterface;

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

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

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

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

    relativeWeightAt(
      pid: PromiseOrValue<BigNumberish>,
      timestamp: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

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

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

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

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

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

    weightPointsAt(
      pid: PromiseOrValue<BigNumberish>,
      timestamp: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

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

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

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

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

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

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

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

  totalWeightPointsAt(
    timestamp: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

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

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

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

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

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

  callStatic: {
    addPool(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

    checkpoint(
      pid: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

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

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

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

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

    totalWeightPointsAt(
      timestamp: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    updateWeight(
      pid: PromiseOrValue<BigNumberish>,
      points: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

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

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

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

  filters: {
    "AddPool(uint256)"(
      pid?: PromiseOrValue<BigNumberish> | null
    ): AddPoolEventFilter;
    AddPool(pid?: PromiseOrValue<BigNumberish> | null): AddPoolEventFilter;

    "UpdateWeight(uint256,uint256,uint256)"(
      pid?: PromiseOrValue<BigNumberish> | null,
      weightPoints?: null,
      totalWeightPoints?: null
    ): UpdateWeightEventFilter;
    UpdateWeight(
      pid?: PromiseOrValue<BigNumberish> | null,
      weightPoints?: null,
      totalWeightPoints?: null
    ): UpdateWeightEventFilter;
  };

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

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

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

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

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

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

    totalWeightPointsAt(
      timestamp: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

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

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

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

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

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

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

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

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

    totalWeightPointsAt(
      timestamp: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

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

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

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