@augmentedfinance/protocol-v1/dist/types/IRewardExplainer.d.ts

Augmented Protocol smart contracts

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */

import {
  ethers,
  EventFilter,
  Signer,
  BigNumber,
  BigNumberish,
  PopulatedTransaction,
} from "ethers";
import {
  Contract,
  ContractTransaction,
  CallOverrides,
} from "@ethersproject/contracts";
import { BytesLike } from "@ethersproject/bytes";
import { Listener, Provider } from "@ethersproject/providers";
import { FunctionFragment, EventFragment, Result } from "@ethersproject/abi";

interface IRewardExplainerInterface extends ethers.utils.Interface {
  functions: {
    "explainReward(address,uint32)": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "explainReward",
    values: [string, BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "explainReward",
    data: BytesLike
  ): Result;

  events: {};
}

export class IRewardExplainer extends Contract {
  connect(signerOrProvider: Signer | Provider | string): this;
  attach(addressOrName: string): this;
  deployed(): Promise<this>;

  on(event: EventFilter | string, listener: Listener): this;
  once(event: EventFilter | string, listener: Listener): this;
  addListener(eventName: EventFilter | string, listener: Listener): this;
  removeAllListeners(eventName: EventFilter | string): this;
  removeListener(eventName: any, listener: Listener): this;

  interface: IRewardExplainerInterface;

  functions: {
    explainReward(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      0: {
        amountClaimable: BigNumber;
        amountExtra: BigNumber;
        maxBoost: BigNumber;
        boostLimit: BigNumber;
        latestClaimAt: number;
        allocations: {
          amount: BigNumber;
          extra: BigNumber;
          pool: string;
          since: number;
          factor: number;
          rewardType: number;
          0: BigNumber;
          1: BigNumber;
          2: string;
          3: number;
          4: number;
          5: number;
        }[];
        0: BigNumber;
        1: BigNumber;
        2: BigNumber;
        3: BigNumber;
        4: number;
        5: {
          amount: BigNumber;
          extra: BigNumber;
          pool: string;
          since: number;
          factor: number;
          rewardType: number;
          0: BigNumber;
          1: BigNumber;
          2: string;
          3: number;
          4: number;
          5: number;
        }[];
      };
    }>;

    "explainReward(address,uint32)"(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      0: {
        amountClaimable: BigNumber;
        amountExtra: BigNumber;
        maxBoost: BigNumber;
        boostLimit: BigNumber;
        latestClaimAt: number;
        allocations: {
          amount: BigNumber;
          extra: BigNumber;
          pool: string;
          since: number;
          factor: number;
          rewardType: number;
          0: BigNumber;
          1: BigNumber;
          2: string;
          3: number;
          4: number;
          5: number;
        }[];
        0: BigNumber;
        1: BigNumber;
        2: BigNumber;
        3: BigNumber;
        4: number;
        5: {
          amount: BigNumber;
          extra: BigNumber;
          pool: string;
          since: number;
          factor: number;
          rewardType: number;
          0: BigNumber;
          1: BigNumber;
          2: string;
          3: number;
          4: number;
          5: number;
        }[];
      };
    }>;
  };

  explainReward(
    holder: string,
    at: BigNumberish,
    overrides?: CallOverrides
  ): Promise<{
    amountClaimable: BigNumber;
    amountExtra: BigNumber;
    maxBoost: BigNumber;
    boostLimit: BigNumber;
    latestClaimAt: number;
    allocations: {
      amount: BigNumber;
      extra: BigNumber;
      pool: string;
      since: number;
      factor: number;
      rewardType: number;
      0: BigNumber;
      1: BigNumber;
      2: string;
      3: number;
      4: number;
      5: number;
    }[];
    0: BigNumber;
    1: BigNumber;
    2: BigNumber;
    3: BigNumber;
    4: number;
    5: {
      amount: BigNumber;
      extra: BigNumber;
      pool: string;
      since: number;
      factor: number;
      rewardType: number;
      0: BigNumber;
      1: BigNumber;
      2: string;
      3: number;
      4: number;
      5: number;
    }[];
  }>;

  "explainReward(address,uint32)"(
    holder: string,
    at: BigNumberish,
    overrides?: CallOverrides
  ): Promise<{
    amountClaimable: BigNumber;
    amountExtra: BigNumber;
    maxBoost: BigNumber;
    boostLimit: BigNumber;
    latestClaimAt: number;
    allocations: {
      amount: BigNumber;
      extra: BigNumber;
      pool: string;
      since: number;
      factor: number;
      rewardType: number;
      0: BigNumber;
      1: BigNumber;
      2: string;
      3: number;
      4: number;
      5: number;
    }[];
    0: BigNumber;
    1: BigNumber;
    2: BigNumber;
    3: BigNumber;
    4: number;
    5: {
      amount: BigNumber;
      extra: BigNumber;
      pool: string;
      since: number;
      factor: number;
      rewardType: number;
      0: BigNumber;
      1: BigNumber;
      2: string;
      3: number;
      4: number;
      5: number;
    }[];
  }>;

  callStatic: {
    explainReward(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      amountClaimable: BigNumber;
      amountExtra: BigNumber;
      maxBoost: BigNumber;
      boostLimit: BigNumber;
      latestClaimAt: number;
      allocations: {
        amount: BigNumber;
        extra: BigNumber;
        pool: string;
        since: number;
        factor: number;
        rewardType: number;
        0: BigNumber;
        1: BigNumber;
        2: string;
        3: number;
        4: number;
        5: number;
      }[];
      0: BigNumber;
      1: BigNumber;
      2: BigNumber;
      3: BigNumber;
      4: number;
      5: {
        amount: BigNumber;
        extra: BigNumber;
        pool: string;
        since: number;
        factor: number;
        rewardType: number;
        0: BigNumber;
        1: BigNumber;
        2: string;
        3: number;
        4: number;
        5: number;
      }[];
    }>;

    "explainReward(address,uint32)"(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<{
      amountClaimable: BigNumber;
      amountExtra: BigNumber;
      maxBoost: BigNumber;
      boostLimit: BigNumber;
      latestClaimAt: number;
      allocations: {
        amount: BigNumber;
        extra: BigNumber;
        pool: string;
        since: number;
        factor: number;
        rewardType: number;
        0: BigNumber;
        1: BigNumber;
        2: string;
        3: number;
        4: number;
        5: number;
      }[];
      0: BigNumber;
      1: BigNumber;
      2: BigNumber;
      3: BigNumber;
      4: number;
      5: {
        amount: BigNumber;
        extra: BigNumber;
        pool: string;
        since: number;
        factor: number;
        rewardType: number;
        0: BigNumber;
        1: BigNumber;
        2: string;
        3: number;
        4: number;
        5: number;
      }[];
    }>;
  };

  filters: {};

  estimateGas: {
    explainReward(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "explainReward(address,uint32)"(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    explainReward(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    "explainReward(address,uint32)"(
      holder: string,
      at: BigNumberish,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;
  };
}