@ohgeez/fsushi/typechain-types/contracts/interfaces/IFlashStrategySushiSwapFactory.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 IFlashStrategySushiSwapFactoryInterface
  extends utils.Interface {
  functions: {
    "createFlashStrategySushiSwap(uint256)": FunctionFragment;
    "feeRecipient()": FunctionFragment;
    "flashProtocol()": FunctionFragment;
    "flpTokenFactory()": FunctionFragment;
    "getFlashStrategySushiSwap(uint256)": FunctionFragment;
    "predictFlashStrategySushiSwapAddress(uint256)": FunctionFragment;
    "updateFeeRecipient(address)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "createFlashStrategySushiSwap"
      | "feeRecipient"
      | "flashProtocol"
      | "flpTokenFactory"
      | "getFlashStrategySushiSwap"
      | "predictFlashStrategySushiSwapAddress"
      | "updateFeeRecipient"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "createFlashStrategySushiSwap",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "feeRecipient",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "flashProtocol",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "flpTokenFactory",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getFlashStrategySushiSwap",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "predictFlashStrategySushiSwapAddress",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateFeeRecipient",
    values: [PromiseOrValue<string>]
  ): string;

  decodeFunctionResult(
    functionFragment: "createFlashStrategySushiSwap",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "feeRecipient",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "flashProtocol",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "flpTokenFactory",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getFlashStrategySushiSwap",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "predictFlashStrategySushiSwapAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateFeeRecipient",
    data: BytesLike
  ): Result;

  events: {
    "CreateFlashStrategySushiSwap(uint256,address)": EventFragment;
    "UpdateFeeRecipient(address)": EventFragment;
    "UpdateFlashStakeFeeBPS(uint256)": EventFragment;
    "UpdateStakeFeeBPS(uint256)": EventFragment;
  };

  getEvent(
    nameOrSignatureOrTopic: "CreateFlashStrategySushiSwap"
  ): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateFeeRecipient"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateFlashStakeFeeBPS"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateStakeFeeBPS"): EventFragment;
}

export interface CreateFlashStrategySushiSwapEventObject {
  pid: BigNumber;
  strategy: string;
}
export type CreateFlashStrategySushiSwapEvent = TypedEvent<
  [BigNumber, string],
  CreateFlashStrategySushiSwapEventObject
>;

export type CreateFlashStrategySushiSwapEventFilter =
  TypedEventFilter<CreateFlashStrategySushiSwapEvent>;

export interface UpdateFeeRecipientEventObject {
  feeRecipient: string;
}
export type UpdateFeeRecipientEvent = TypedEvent<
  [string],
  UpdateFeeRecipientEventObject
>;

export type UpdateFeeRecipientEventFilter =
  TypedEventFilter<UpdateFeeRecipientEvent>;

export interface UpdateFlashStakeFeeBPSEventObject {
  fee: BigNumber;
}
export type UpdateFlashStakeFeeBPSEvent = TypedEvent<
  [BigNumber],
  UpdateFlashStakeFeeBPSEventObject
>;

export type UpdateFlashStakeFeeBPSEventFilter =
  TypedEventFilter<UpdateFlashStakeFeeBPSEvent>;

export interface UpdateStakeFeeBPSEventObject {
  fee: BigNumber;
}
export type UpdateStakeFeeBPSEvent = TypedEvent<
  [BigNumber],
  UpdateStakeFeeBPSEventObject
>;

export type UpdateStakeFeeBPSEventFilter =
  TypedEventFilter<UpdateStakeFeeBPSEvent>;

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

  interface: IFlashStrategySushiSwapFactoryInterface;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    updateFeeRecipient(
      _feeRecipient: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "CreateFlashStrategySushiSwap(uint256,address)"(
      pid?: null,
      strategy?: null
    ): CreateFlashStrategySushiSwapEventFilter;
    CreateFlashStrategySushiSwap(
      pid?: null,
      strategy?: null
    ): CreateFlashStrategySushiSwapEventFilter;

    "UpdateFeeRecipient(address)"(
      feeRecipient?: null
    ): UpdateFeeRecipientEventFilter;
    UpdateFeeRecipient(feeRecipient?: null): UpdateFeeRecipientEventFilter;

    "UpdateFlashStakeFeeBPS(uint256)"(
      fee?: null
    ): UpdateFlashStakeFeeBPSEventFilter;
    UpdateFlashStakeFeeBPS(fee?: null): UpdateFlashStakeFeeBPSEventFilter;

    "UpdateStakeFeeBPS(uint256)"(fee?: null): UpdateStakeFeeBPSEventFilter;
    UpdateStakeFeeBPS(fee?: null): UpdateStakeFeeBPSEventFilter;
  };

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

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

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

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

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

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

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

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

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

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

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

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

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

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