@ohgeez/fsushi/typechain-types/contracts/FarmingLPTokenFactory.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 FarmingLPTokenFactoryInterface extends utils.Interface {
  functions: {
    "createFarmingLPToken(uint256)": FunctionFragment;
    "getFarmingLPToken(uint256)": FunctionFragment;
    "masterChef()": FunctionFragment;
    "migrator()": FunctionFragment;
    "owner()": FunctionFragment;
    "predictFarmingLPTokenAddress(uint256)": FunctionFragment;
    "renounceOwnership()": FunctionFragment;
    "router()": FunctionFragment;
    "transferOwnership(address)": FunctionFragment;
    "updateMigrator(address)": FunctionFragment;
    "updateYieldVault(address)": FunctionFragment;
    "yieldVault()": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "createFarmingLPToken"
      | "getFarmingLPToken"
      | "masterChef"
      | "migrator"
      | "owner"
      | "predictFarmingLPTokenAddress"
      | "renounceOwnership"
      | "router"
      | "transferOwnership"
      | "updateMigrator"
      | "updateYieldVault"
      | "yieldVault"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "createFarmingLPToken",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getFarmingLPToken",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "masterChef",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "migrator", values?: undefined): string;
  encodeFunctionData(functionFragment: "owner", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "predictFarmingLPTokenAddress",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "renounceOwnership",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "router", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "transferOwnership",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateMigrator",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateYieldVault",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "yieldVault",
    values?: undefined
  ): string;

  decodeFunctionResult(
    functionFragment: "createFarmingLPToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getFarmingLPToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "masterChef", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "migrator", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "predictFarmingLPTokenAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "renounceOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "router", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "transferOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateMigrator",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateYieldVault",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "yieldVault", data: BytesLike): Result;

  events: {
    "CreateFarmingLPToken(uint256,address)": EventFragment;
    "OwnershipTransferred(address,address)": EventFragment;
    "UpdateMigrator(address)": EventFragment;
    "UpdateVault(address)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "CreateFarmingLPToken"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateMigrator"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "UpdateVault"): EventFragment;
}

export interface CreateFarmingLPTokenEventObject {
  pid: BigNumber;
  token: string;
}
export type CreateFarmingLPTokenEvent = TypedEvent<
  [BigNumber, string],
  CreateFarmingLPTokenEventObject
>;

export type CreateFarmingLPTokenEventFilter =
  TypedEventFilter<CreateFarmingLPTokenEvent>;

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

export type OwnershipTransferredEventFilter =
  TypedEventFilter<OwnershipTransferredEvent>;

export interface UpdateMigratorEventObject {
  migrator: string;
}
export type UpdateMigratorEvent = TypedEvent<
  [string],
  UpdateMigratorEventObject
>;

export type UpdateMigratorEventFilter = TypedEventFilter<UpdateMigratorEvent>;

export interface UpdateVaultEventObject {
  vault: string;
}
export type UpdateVaultEvent = TypedEvent<[string], UpdateVaultEventObject>;

export type UpdateVaultEventFilter = TypedEventFilter<UpdateVaultEvent>;

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

  interface: FarmingLPTokenFactoryInterface;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    updateMigrator(
      _migrator: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    updateYieldVault(
      vault: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    yieldVault(overrides?: CallOverrides): Promise<string>;
  };

  filters: {
    "CreateFarmingLPToken(uint256,address)"(
      pid?: PromiseOrValue<BigNumberish> | null,
      token?: PromiseOrValue<string> | null
    ): CreateFarmingLPTokenEventFilter;
    CreateFarmingLPToken(
      pid?: PromiseOrValue<BigNumberish> | null,
      token?: PromiseOrValue<string> | null
    ): CreateFarmingLPTokenEventFilter;

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

    "UpdateMigrator(address)"(
      migrator?: PromiseOrValue<string> | null
    ): UpdateMigratorEventFilter;
    UpdateMigrator(
      migrator?: PromiseOrValue<string> | null
    ): UpdateMigratorEventFilter;

    "UpdateVault(address)"(
      vault?: PromiseOrValue<string> | null
    ): UpdateVaultEventFilter;
    UpdateVault(vault?: PromiseOrValue<string> | null): UpdateVaultEventFilter;
  };

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

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

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

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

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

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

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

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

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

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

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

    yieldVault(overrides?: CallOverrides): Promise<BigNumber>;
  };

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

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

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

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

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

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

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

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

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

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

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

    yieldVault(overrides?: CallOverrides): Promise<PopulatedTransaction>;
  };
}