@gooddollar/goodprotocol/types/contracts/Interfaces.sol/IGoodStaking.ts

GoodDollar Protocol

/* 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 } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type {
  TypedEventFilter,
  TypedEvent,
  TypedListener,
  OnEvent,
} from "../../common";

export interface IGoodStakingInterface extends utils.Interface {
  functions: {
    "collectUBIInterest(address)": FunctionFragment;
    "currentGains(bool,bool)": FunctionFragment;
    "getGasCostForInterestTransfer()": FunctionFragment;
    "getRewardEarned(address)": FunctionFragment;
    "iToken()": FunctionFragment;
    "rewardsMinted(address,uint256,uint256,uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "collectUBIInterest"
      | "currentGains"
      | "getGasCostForInterestTransfer"
      | "getRewardEarned"
      | "iToken"
      | "rewardsMinted"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "collectUBIInterest",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "currentGains",
    values: [boolean, boolean]
  ): string;
  encodeFunctionData(
    functionFragment: "getGasCostForInterestTransfer",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getRewardEarned",
    values: [string]
  ): string;
  encodeFunctionData(functionFragment: "iToken", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "rewardsMinted",
    values: [string, BigNumberish, BigNumberish, BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "collectUBIInterest",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "currentGains",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getGasCostForInterestTransfer",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getRewardEarned",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "iToken", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "rewardsMinted",
    data: BytesLike
  ): Result;

  events: {};
}

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

  interface: IGoodStakingInterface;

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

    currentGains(
      _returnTokenBalanceInUSD: boolean,
      _returnTokenGainsInUSD: boolean,
      overrides?: CallOverrides
    ): Promise<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>;

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

    getRewardEarned(
      user: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

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

    rewardsMinted(
      user: string,
      rewardsPerBlock: BigNumberish,
      blockStart: BigNumberish,
      blockEnd: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;
  };

  collectUBIInterest(
    recipient: string,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  currentGains(
    _returnTokenBalanceInUSD: boolean,
    _returnTokenGainsInUSD: boolean,
    overrides?: CallOverrides
  ): Promise<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>;

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

  getRewardEarned(user: string, overrides?: CallOverrides): Promise<BigNumber>;

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

  rewardsMinted(
    user: string,
    rewardsPerBlock: BigNumberish,
    blockStart: BigNumberish,
    blockEnd: BigNumberish,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  callStatic: {
    collectUBIInterest(
      recipient: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber, BigNumber, BigNumber]>;

    currentGains(
      _returnTokenBalanceInUSD: boolean,
      _returnTokenGainsInUSD: boolean,
      overrides?: CallOverrides
    ): Promise<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>;

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

    getRewardEarned(
      user: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    rewardsMinted(
      user: string,
      rewardsPerBlock: BigNumberish,
      blockStart: BigNumberish,
      blockEnd: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  filters: {};

  estimateGas: {
    collectUBIInterest(
      recipient: string,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    currentGains(
      _returnTokenBalanceInUSD: boolean,
      _returnTokenGainsInUSD: boolean,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    getRewardEarned(
      user: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    rewardsMinted(
      user: string,
      rewardsPerBlock: BigNumberish,
      blockStart: BigNumberish,
      blockEnd: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    collectUBIInterest(
      recipient: string,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    currentGains(
      _returnTokenBalanceInUSD: boolean,
      _returnTokenGainsInUSD: boolean,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    getRewardEarned(
      user: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    rewardsMinted(
      user: string,
      rewardsPerBlock: BigNumberish,
      blockStart: BigNumberish,
      blockEnd: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;
  };
}