@vechain/vebetterdao-contracts/typechain-types/contracts/interfaces/IXAllocationPool.ts

Open-source repository that houses the smart contracts powering the decentralized VeBetterDAO on the VeChain Thor blockchain.

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */
import type {
  BaseContract,
  BigNumberish,
  BytesLike,
  FunctionFragment,
  Result,
  Interface,
  EventFragment,
  AddressLike,
  ContractRunner,
  ContractMethod,
  Listener,
} from "ethers";
import type {
  TypedContractEvent,
  TypedDeferredTopicFilter,
  TypedEventLog,
  TypedLogDescription,
  TypedListener,
  TypedContractMethod,
} from "../../common";

export interface IXAllocationPoolInterface extends Interface {
  getFunction(
    nameOrSignature:
      | "allFundsClaimed"
      | "baseAllocationAmount"
      | "claimableAmount"
      | "currentRoundEarnings"
      | "getAppShares"
      | "getMaxAppAllocation"
      | "isQuadraticFundingDisabledForCurrentRound"
      | "isQuadraticFundingDisabledForRound"
      | "roundEarnings"
      | "toggleQuadraticFunding"
      | "unallocatedFunds"
      | "version"
  ): FunctionFragment;

  getEvent(
    nameOrSignatureOrTopic:
      | "AllocationRewardsClaimed"
      | "EmissionsContractSet"
      | "QuadraticFundingToggled"
      | "TreasuryContractSet"
      | "UnallocatedFundsReceiverSet"
      | "X2EarnAppsContractSet"
      | "XAllocationVotingSet"
  ): EventFragment;

  encodeFunctionData(
    functionFragment: "allFundsClaimed",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "baseAllocationAmount",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "claimableAmount",
    values: [BigNumberish, BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "currentRoundEarnings",
    values: [BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "getAppShares",
    values: [BigNumberish, BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "getMaxAppAllocation",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "isQuadraticFundingDisabledForCurrentRound",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "isQuadraticFundingDisabledForRound",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "roundEarnings",
    values: [BigNumberish, BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "toggleQuadraticFunding",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "unallocatedFunds",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(functionFragment: "version", values?: undefined): string;

  decodeFunctionResult(
    functionFragment: "allFundsClaimed",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "baseAllocationAmount",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "claimableAmount",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "currentRoundEarnings",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getAppShares",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMaxAppAllocation",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "isQuadraticFundingDisabledForCurrentRound",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "isQuadraticFundingDisabledForRound",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "roundEarnings",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "toggleQuadraticFunding",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "unallocatedFunds",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "version", data: BytesLike): Result;
}

export namespace AllocationRewardsClaimedEvent {
  export type InputTuple = [
    appId: BytesLike,
    roundId: BigNumberish,
    totalAmount: BigNumberish,
    recipient: AddressLike,
    caller: AddressLike,
    unallocatedAmount: BigNumberish,
    teamAllocationAmount: BigNumberish,
    rewardsAllocationAmount: BigNumberish
  ];
  export type OutputTuple = [
    appId: string,
    roundId: bigint,
    totalAmount: bigint,
    recipient: string,
    caller: string,
    unallocatedAmount: bigint,
    teamAllocationAmount: bigint,
    rewardsAllocationAmount: bigint
  ];
  export interface OutputObject {
    appId: string;
    roundId: bigint;
    totalAmount: bigint;
    recipient: string;
    caller: string;
    unallocatedAmount: bigint;
    teamAllocationAmount: bigint;
    rewardsAllocationAmount: bigint;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace EmissionsContractSetEvent {
  export type InputTuple = [
    oldContractAddress: AddressLike,
    newContractAddress: AddressLike
  ];
  export type OutputTuple = [
    oldContractAddress: string,
    newContractAddress: string
  ];
  export interface OutputObject {
    oldContractAddress: string;
    newContractAddress: string;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace QuadraticFundingToggledEvent {
  export type InputTuple = [isDisabled: boolean];
  export type OutputTuple = [isDisabled: boolean];
  export interface OutputObject {
    isDisabled: boolean;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace TreasuryContractSetEvent {
  export type InputTuple = [
    oldContractAddress: AddressLike,
    newContractAddress: AddressLike
  ];
  export type OutputTuple = [
    oldContractAddress: string,
    newContractAddress: string
  ];
  export interface OutputObject {
    oldContractAddress: string;
    newContractAddress: string;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace UnallocatedFundsReceiverSetEvent {
  export type InputTuple = [
    oldContractAddress: AddressLike,
    newContractAddress: AddressLike
  ];
  export type OutputTuple = [
    oldContractAddress: string,
    newContractAddress: string
  ];
  export interface OutputObject {
    oldContractAddress: string;
    newContractAddress: string;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace X2EarnAppsContractSetEvent {
  export type InputTuple = [
    oldContractAddress: AddressLike,
    newContractAddress: AddressLike
  ];
  export type OutputTuple = [
    oldContractAddress: string,
    newContractAddress: string
  ];
  export interface OutputObject {
    oldContractAddress: string;
    newContractAddress: string;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export namespace XAllocationVotingSetEvent {
  export type InputTuple = [
    oldContractAddress: AddressLike,
    newContractAddress: AddressLike
  ];
  export type OutputTuple = [
    oldContractAddress: string,
    newContractAddress: string
  ];
  export interface OutputObject {
    oldContractAddress: string;
    newContractAddress: string;
  }
  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
  export type Filter = TypedDeferredTopicFilter<Event>;
  export type Log = TypedEventLog<Event>;
  export type LogDescription = TypedLogDescription<Event>;
}

export interface IXAllocationPool extends BaseContract {
  connect(runner?: ContractRunner | null): IXAllocationPool;
  waitForDeployment(): Promise<this>;

  interface: IXAllocationPoolInterface;

  queryFilter<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined
  ): Promise<Array<TypedEventLog<TCEvent>>>;
  queryFilter<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined
  ): Promise<Array<TypedEventLog<TCEvent>>>;

  on<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    listener: TypedListener<TCEvent>
  ): Promise<this>;
  on<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    listener: TypedListener<TCEvent>
  ): Promise<this>;

  once<TCEvent extends TypedContractEvent>(
    event: TCEvent,
    listener: TypedListener<TCEvent>
  ): Promise<this>;
  once<TCEvent extends TypedContractEvent>(
    filter: TypedDeferredTopicFilter<TCEvent>,
    listener: TypedListener<TCEvent>
  ): Promise<this>;

  listeners<TCEvent extends TypedContractEvent>(
    event: TCEvent
  ): Promise<Array<TypedListener<TCEvent>>>;
  listeners(eventName?: string): Promise<Array<Listener>>;
  removeAllListeners<TCEvent extends TypedContractEvent>(
    event?: TCEvent
  ): Promise<this>;

  allFundsClaimed: TypedContractMethod<
    [roundId: BigNumberish],
    [boolean],
    "view"
  >;

  baseAllocationAmount: TypedContractMethod<
    [roundId: BigNumberish],
    [bigint],
    "view"
  >;

  claimableAmount: TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [
      [bigint, bigint, bigint, bigint] & {
        totalAmount: bigint;
        unallocatedAmount: bigint;
        teamAllocationAmount: bigint;
        x2EarnRewardsPoolAmount: bigint;
      }
    ],
    "view"
  >;

  currentRoundEarnings: TypedContractMethod<
    [appId: BytesLike],
    [bigint],
    "view"
  >;

  getAppShares: TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [[bigint, bigint]],
    "view"
  >;

  getMaxAppAllocation: TypedContractMethod<
    [roundId: BigNumberish],
    [bigint],
    "view"
  >;

  isQuadraticFundingDisabledForCurrentRound: TypedContractMethod<
    [],
    [boolean],
    "view"
  >;

  isQuadraticFundingDisabledForRound: TypedContractMethod<
    [roundId: BigNumberish],
    [boolean],
    "view"
  >;

  roundEarnings: TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [
      [bigint, bigint, bigint, bigint] & {
        totalAmount: bigint;
        unallocatedAmount: bigint;
        teamAllocationAmount: bigint;
        x2EarnRewardsPoolAmount: bigint;
      }
    ],
    "view"
  >;

  toggleQuadraticFunding: TypedContractMethod<[], [void], "nonpayable">;

  unallocatedFunds: TypedContractMethod<
    [roundId: BigNumberish],
    [bigint],
    "view"
  >;

  version: TypedContractMethod<[], [string], "view">;

  getFunction<T extends ContractMethod = ContractMethod>(
    key: string | FunctionFragment
  ): T;

  getFunction(
    nameOrSignature: "allFundsClaimed"
  ): TypedContractMethod<[roundId: BigNumberish], [boolean], "view">;
  getFunction(
    nameOrSignature: "baseAllocationAmount"
  ): TypedContractMethod<[roundId: BigNumberish], [bigint], "view">;
  getFunction(
    nameOrSignature: "claimableAmount"
  ): TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [
      [bigint, bigint, bigint, bigint] & {
        totalAmount: bigint;
        unallocatedAmount: bigint;
        teamAllocationAmount: bigint;
        x2EarnRewardsPoolAmount: bigint;
      }
    ],
    "view"
  >;
  getFunction(
    nameOrSignature: "currentRoundEarnings"
  ): TypedContractMethod<[appId: BytesLike], [bigint], "view">;
  getFunction(
    nameOrSignature: "getAppShares"
  ): TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [[bigint, bigint]],
    "view"
  >;
  getFunction(
    nameOrSignature: "getMaxAppAllocation"
  ): TypedContractMethod<[roundId: BigNumberish], [bigint], "view">;
  getFunction(
    nameOrSignature: "isQuadraticFundingDisabledForCurrentRound"
  ): TypedContractMethod<[], [boolean], "view">;
  getFunction(
    nameOrSignature: "isQuadraticFundingDisabledForRound"
  ): TypedContractMethod<[roundId: BigNumberish], [boolean], "view">;
  getFunction(
    nameOrSignature: "roundEarnings"
  ): TypedContractMethod<
    [roundId: BigNumberish, appId: BytesLike],
    [
      [bigint, bigint, bigint, bigint] & {
        totalAmount: bigint;
        unallocatedAmount: bigint;
        teamAllocationAmount: bigint;
        x2EarnRewardsPoolAmount: bigint;
      }
    ],
    "view"
  >;
  getFunction(
    nameOrSignature: "toggleQuadraticFunding"
  ): TypedContractMethod<[], [void], "nonpayable">;
  getFunction(
    nameOrSignature: "unallocatedFunds"
  ): TypedContractMethod<[roundId: BigNumberish], [bigint], "view">;
  getFunction(
    nameOrSignature: "version"
  ): TypedContractMethod<[], [string], "view">;

  getEvent(
    key: "AllocationRewardsClaimed"
  ): TypedContractEvent<
    AllocationRewardsClaimedEvent.InputTuple,
    AllocationRewardsClaimedEvent.OutputTuple,
    AllocationRewardsClaimedEvent.OutputObject
  >;
  getEvent(
    key: "EmissionsContractSet"
  ): TypedContractEvent<
    EmissionsContractSetEvent.InputTuple,
    EmissionsContractSetEvent.OutputTuple,
    EmissionsContractSetEvent.OutputObject
  >;
  getEvent(
    key: "QuadraticFundingToggled"
  ): TypedContractEvent<
    QuadraticFundingToggledEvent.InputTuple,
    QuadraticFundingToggledEvent.OutputTuple,
    QuadraticFundingToggledEvent.OutputObject
  >;
  getEvent(
    key: "TreasuryContractSet"
  ): TypedContractEvent<
    TreasuryContractSetEvent.InputTuple,
    TreasuryContractSetEvent.OutputTuple,
    TreasuryContractSetEvent.OutputObject
  >;
  getEvent(
    key: "UnallocatedFundsReceiverSet"
  ): TypedContractEvent<
    UnallocatedFundsReceiverSetEvent.InputTuple,
    UnallocatedFundsReceiverSetEvent.OutputTuple,
    UnallocatedFundsReceiverSetEvent.OutputObject
  >;
  getEvent(
    key: "X2EarnAppsContractSet"
  ): TypedContractEvent<
    X2EarnAppsContractSetEvent.InputTuple,
    X2EarnAppsContractSetEvent.OutputTuple,
    X2EarnAppsContractSetEvent.OutputObject
  >;
  getEvent(
    key: "XAllocationVotingSet"
  ): TypedContractEvent<
    XAllocationVotingSetEvent.InputTuple,
    XAllocationVotingSetEvent.OutputTuple,
    XAllocationVotingSetEvent.OutputObject
  >;

  filters: {
    "AllocationRewardsClaimed(bytes32,uint256,uint256,address,address,uint256,uint256,uint256)": TypedContractEvent<
      AllocationRewardsClaimedEvent.InputTuple,
      AllocationRewardsClaimedEvent.OutputTuple,
      AllocationRewardsClaimedEvent.OutputObject
    >;
    AllocationRewardsClaimed: TypedContractEvent<
      AllocationRewardsClaimedEvent.InputTuple,
      AllocationRewardsClaimedEvent.OutputTuple,
      AllocationRewardsClaimedEvent.OutputObject
    >;

    "EmissionsContractSet(address,address)": TypedContractEvent<
      EmissionsContractSetEvent.InputTuple,
      EmissionsContractSetEvent.OutputTuple,
      EmissionsContractSetEvent.OutputObject
    >;
    EmissionsContractSet: TypedContractEvent<
      EmissionsContractSetEvent.InputTuple,
      EmissionsContractSetEvent.OutputTuple,
      EmissionsContractSetEvent.OutputObject
    >;

    "QuadraticFundingToggled(bool)": TypedContractEvent<
      QuadraticFundingToggledEvent.InputTuple,
      QuadraticFundingToggledEvent.OutputTuple,
      QuadraticFundingToggledEvent.OutputObject
    >;
    QuadraticFundingToggled: TypedContractEvent<
      QuadraticFundingToggledEvent.InputTuple,
      QuadraticFundingToggledEvent.OutputTuple,
      QuadraticFundingToggledEvent.OutputObject
    >;

    "TreasuryContractSet(address,address)": TypedContractEvent<
      TreasuryContractSetEvent.InputTuple,
      TreasuryContractSetEvent.OutputTuple,
      TreasuryContractSetEvent.OutputObject
    >;
    TreasuryContractSet: TypedContractEvent<
      TreasuryContractSetEvent.InputTuple,
      TreasuryContractSetEvent.OutputTuple,
      TreasuryContractSetEvent.OutputObject
    >;

    "UnallocatedFundsReceiverSet(address,address)": TypedContractEvent<
      UnallocatedFundsReceiverSetEvent.InputTuple,
      UnallocatedFundsReceiverSetEvent.OutputTuple,
      UnallocatedFundsReceiverSetEvent.OutputObject
    >;
    UnallocatedFundsReceiverSet: TypedContractEvent<
      UnallocatedFundsReceiverSetEvent.InputTuple,
      UnallocatedFundsReceiverSetEvent.OutputTuple,
      UnallocatedFundsReceiverSetEvent.OutputObject
    >;

    "X2EarnAppsContractSet(address,address)": TypedContractEvent<
      X2EarnAppsContractSetEvent.InputTuple,
      X2EarnAppsContractSetEvent.OutputTuple,
      X2EarnAppsContractSetEvent.OutputObject
    >;
    X2EarnAppsContractSet: TypedContractEvent<
      X2EarnAppsContractSetEvent.InputTuple,
      X2EarnAppsContractSetEvent.OutputTuple,
      X2EarnAppsContractSetEvent.OutputObject
    >;

    "XAllocationVotingSet(address,address)": TypedContractEvent<
      XAllocationVotingSetEvent.InputTuple,
      XAllocationVotingSetEvent.OutputTuple,
      XAllocationVotingSetEvent.OutputObject
    >;
    XAllocationVotingSet: TypedContractEvent<
      XAllocationVotingSetEvent.InputTuple,
      XAllocationVotingSetEvent.OutputTuple,
      XAllocationVotingSetEvent.OutputObject
    >;
  };
}