@ohgeez/fsushi/typechain-types/contracts/FSushiAirdropsVotingEscrow.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 FSushiAirdropsVotingEscrowInterface extends utils.Interface {
  functions: {
    "claim(address)": FunctionFragment;
    "fSushi()": FunctionFragment;
    "lastCheckpoint()": FunctionFragment;
    "lastCheckpointOf(address)": FunctionFragment;
    "startWeek()": FunctionFragment;
    "votingEscrow()": FunctionFragment;
    "votingEscrowInterval()": FunctionFragment;
    "votingEscrowTotalSupply(uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "claim"
      | "fSushi"
      | "lastCheckpoint"
      | "lastCheckpointOf"
      | "startWeek"
      | "votingEscrow"
      | "votingEscrowInterval"
      | "votingEscrowTotalSupply"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "claim",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(functionFragment: "fSushi", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "lastCheckpoint",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "lastCheckpointOf",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(functionFragment: "startWeek", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "votingEscrow",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "votingEscrowInterval",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "votingEscrowTotalSupply",
    values: [PromiseOrValue<BigNumberish>]
  ): string;

  decodeFunctionResult(functionFragment: "claim", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "fSushi", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "lastCheckpoint",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "lastCheckpointOf",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "startWeek", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "votingEscrow",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "votingEscrowInterval",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "votingEscrowTotalSupply",
    data: BytesLike
  ): Result;

  events: {
    "Claim(address,uint256,address,uint256,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "Claim"): EventFragment;
}

export interface ClaimEventObject {
  account: string;
  amount: BigNumber;
  beneficiary: string;
  fromWeek: BigNumber;
  untilWeek: BigNumber;
}
export type ClaimEvent = TypedEvent<
  [string, BigNumber, string, BigNumber, BigNumber],
  ClaimEventObject
>;

export type ClaimEventFilter = TypedEventFilter<ClaimEvent>;

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

  interface: FSushiAirdropsVotingEscrowInterface;

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

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

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

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

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

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

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

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

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

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

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

  lastCheckpointOf(
    arg0: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

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

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

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

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

  callStatic: {
    claim(
      beneficiary: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

    lastCheckpointOf(
      arg0: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

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

  filters: {
    "Claim(address,uint256,address,uint256,uint256)"(
      account?: PromiseOrValue<string> | null,
      amount?: null,
      beneficiary?: PromiseOrValue<string> | null,
      fromWeek?: null,
      untilWeek?: null
    ): ClaimEventFilter;
    Claim(
      account?: PromiseOrValue<string> | null,
      amount?: null,
      beneficiary?: PromiseOrValue<string> | null,
      fromWeek?: null,
      untilWeek?: null
    ): ClaimEventFilter;
  };

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

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

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

    lastCheckpointOf(
      arg0: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

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

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

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

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

    lastCheckpointOf(
      arg0: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

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

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