@towns-protocol/generated/dev/typings/DropFacet.ts

## How to generate contract types

/* 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 declare namespace DropGroup {
  export type ClaimConditionStruct = {
    currency: PromiseOrValue<string>;
    startTimestamp: PromiseOrValue<BigNumberish>;
    endTimestamp: PromiseOrValue<BigNumberish>;
    penaltyBps: PromiseOrValue<BigNumberish>;
    maxClaimableSupply: PromiseOrValue<BigNumberish>;
    supplyClaimed: PromiseOrValue<BigNumberish>;
    merkleRoot: PromiseOrValue<BytesLike>;
  };

  export type ClaimConditionStructOutput = [
    string,
    number,
    number,
    number,
    BigNumber,
    BigNumber,
    string
  ] & {
    currency: string;
    startTimestamp: number;
    endTimestamp: number;
    penaltyBps: number;
    maxClaimableSupply: BigNumber;
    supplyClaimed: BigNumber;
    merkleRoot: string;
  };
}

export declare namespace DropClaim {
  export type ClaimStruct = {
    conditionId: PromiseOrValue<BigNumberish>;
    account: PromiseOrValue<string>;
    quantity: PromiseOrValue<BigNumberish>;
    points: PromiseOrValue<BigNumberish>;
    proof: PromiseOrValue<BytesLike>[];
  };

  export type ClaimStructOutput = [
    BigNumber,
    string,
    BigNumber,
    BigNumber,
    string[]
  ] & {
    conditionId: BigNumber;
    account: string;
    quantity: BigNumber;
    points: BigNumber;
    proof: string[];
  };
}

export interface DropFacetInterface extends utils.Interface {
  functions: {
    "__DropFacet_init(address)": FunctionFragment;
    "addClaimCondition((address,uint40,uint40,uint16,uint256,uint256,bytes32))": FunctionFragment;
    "claimAndStake((uint256,address,uint256,uint256,bytes32[]),address,uint256,bytes)": FunctionFragment;
    "claimWithPenalty((uint256,address,uint256,uint256,bytes32[]),uint16)": FunctionFragment;
    "getActiveClaimConditionId()": FunctionFragment;
    "getClaimConditionById(uint256)": FunctionFragment;
    "getClaimConditions()": FunctionFragment;
    "getDepositIdByWallet(address,uint256)": FunctionFragment;
    "getSupplyClaimedByWallet(address,uint256)": FunctionFragment;
    "setClaimConditions((address,uint40,uint40,uint16,uint256,uint256,bytes32)[])": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "__DropFacet_init"
      | "addClaimCondition"
      | "claimAndStake"
      | "claimWithPenalty"
      | "getActiveClaimConditionId"
      | "getClaimConditionById"
      | "getClaimConditions"
      | "getDepositIdByWallet"
      | "getSupplyClaimedByWallet"
      | "setClaimConditions"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "__DropFacet_init",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "addClaimCondition",
    values: [DropGroup.ClaimConditionStruct]
  ): string;
  encodeFunctionData(
    functionFragment: "claimAndStake",
    values: [
      DropClaim.ClaimStruct,
      PromiseOrValue<string>,
      PromiseOrValue<BigNumberish>,
      PromiseOrValue<BytesLike>
    ]
  ): string;
  encodeFunctionData(
    functionFragment: "claimWithPenalty",
    values: [DropClaim.ClaimStruct, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getActiveClaimConditionId",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getClaimConditionById",
    values: [PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getClaimConditions",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getDepositIdByWallet",
    values: [PromiseOrValue<string>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "getSupplyClaimedByWallet",
    values: [PromiseOrValue<string>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "setClaimConditions",
    values: [DropGroup.ClaimConditionStruct[]]
  ): string;

  decodeFunctionResult(
    functionFragment: "__DropFacet_init",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "addClaimCondition",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "claimAndStake",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "claimWithPenalty",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getActiveClaimConditionId",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getClaimConditionById",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getClaimConditions",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getDepositIdByWallet",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getSupplyClaimedByWallet",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setClaimConditions",
    data: BytesLike
  ): Result;

  events: {
    "DropFacet_ClaimConditionAdded(uint256,tuple)": EventFragment;
    "DropFacet_ClaimConditionsUpdated(uint256,tuple[])": EventFragment;
    "DropFacet_Claimed_And_Staked(uint256,address,address,uint256)": EventFragment;
    "DropFacet_Claimed_WithPenalty(uint256,address,address,uint256)": EventFragment;
    "Initialized(uint32)": EventFragment;
    "InterfaceAdded(bytes4)": EventFragment;
    "InterfaceRemoved(bytes4)": EventFragment;
    "OwnershipTransferred(address,address)": EventFragment;
  };

  getEvent(
    nameOrSignatureOrTopic: "DropFacet_ClaimConditionAdded"
  ): EventFragment;
  getEvent(
    nameOrSignatureOrTopic: "DropFacet_ClaimConditionsUpdated"
  ): EventFragment;
  getEvent(
    nameOrSignatureOrTopic: "DropFacet_Claimed_And_Staked"
  ): EventFragment;
  getEvent(
    nameOrSignatureOrTopic: "DropFacet_Claimed_WithPenalty"
  ): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "InterfaceAdded"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "InterfaceRemoved"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
}

export interface DropFacet_ClaimConditionAddedEventObject {
  conditionId: BigNumber;
  condition: DropGroup.ClaimConditionStructOutput;
}
export type DropFacet_ClaimConditionAddedEvent = TypedEvent<
  [BigNumber, DropGroup.ClaimConditionStructOutput],
  DropFacet_ClaimConditionAddedEventObject
>;

export type DropFacet_ClaimConditionAddedEventFilter =
  TypedEventFilter<DropFacet_ClaimConditionAddedEvent>;

export interface DropFacet_ClaimConditionsUpdatedEventObject {
  conditionId: BigNumber;
  conditions: DropGroup.ClaimConditionStructOutput[];
}
export type DropFacet_ClaimConditionsUpdatedEvent = TypedEvent<
  [BigNumber, DropGroup.ClaimConditionStructOutput[]],
  DropFacet_ClaimConditionsUpdatedEventObject
>;

export type DropFacet_ClaimConditionsUpdatedEventFilter =
  TypedEventFilter<DropFacet_ClaimConditionsUpdatedEvent>;

export interface DropFacet_Claimed_And_StakedEventObject {
  conditionId: BigNumber;
  claimer: string;
  account: string;
  amount: BigNumber;
}
export type DropFacet_Claimed_And_StakedEvent = TypedEvent<
  [BigNumber, string, string, BigNumber],
  DropFacet_Claimed_And_StakedEventObject
>;

export type DropFacet_Claimed_And_StakedEventFilter =
  TypedEventFilter<DropFacet_Claimed_And_StakedEvent>;

export interface DropFacet_Claimed_WithPenaltyEventObject {
  conditionId: BigNumber;
  claimer: string;
  account: string;
  amount: BigNumber;
}
export type DropFacet_Claimed_WithPenaltyEvent = TypedEvent<
  [BigNumber, string, string, BigNumber],
  DropFacet_Claimed_WithPenaltyEventObject
>;

export type DropFacet_Claimed_WithPenaltyEventFilter =
  TypedEventFilter<DropFacet_Claimed_WithPenaltyEvent>;

export interface InitializedEventObject {
  version: number;
}
export type InitializedEvent = TypedEvent<[number], InitializedEventObject>;

export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;

export interface InterfaceAddedEventObject {
  interfaceId: string;
}
export type InterfaceAddedEvent = TypedEvent<
  [string],
  InterfaceAddedEventObject
>;

export type InterfaceAddedEventFilter = TypedEventFilter<InterfaceAddedEvent>;

export interface InterfaceRemovedEventObject {
  interfaceId: string;
}
export type InterfaceRemovedEvent = TypedEvent<
  [string],
  InterfaceRemovedEventObject
>;

export type InterfaceRemovedEventFilter =
  TypedEventFilter<InterfaceRemovedEvent>;

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

export type OwnershipTransferredEventFilter =
  TypedEventFilter<OwnershipTransferredEvent>;

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

  interface: DropFacetInterface;

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

    addClaimCondition(
      condition: DropGroup.ClaimConditionStruct,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    claimAndStake(
      req: DropClaim.ClaimStruct,
      delegatee: PromiseOrValue<string>,
      deadline: PromiseOrValue<BigNumberish>,
      signature: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    claimWithPenalty(
      req: DropClaim.ClaimStruct,
      expectedPenaltyBps: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

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

    getClaimConditionById(
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<
      [DropGroup.ClaimConditionStructOutput] & {
        condition: DropGroup.ClaimConditionStructOutput;
      }
    >;

    getClaimConditions(
      overrides?: CallOverrides
    ): Promise<[DropGroup.ClaimConditionStructOutput[]]>;

    getDepositIdByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    getSupplyClaimedByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    setClaimConditions(
      conditions: DropGroup.ClaimConditionStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;
  };

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

  addClaimCondition(
    condition: DropGroup.ClaimConditionStruct,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  claimAndStake(
    req: DropClaim.ClaimStruct,
    delegatee: PromiseOrValue<string>,
    deadline: PromiseOrValue<BigNumberish>,
    signature: PromiseOrValue<BytesLike>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  claimWithPenalty(
    req: DropClaim.ClaimStruct,
    expectedPenaltyBps: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

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

  getClaimConditionById(
    conditionId: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<DropGroup.ClaimConditionStructOutput>;

  getClaimConditions(
    overrides?: CallOverrides
  ): Promise<DropGroup.ClaimConditionStructOutput[]>;

  getDepositIdByWallet(
    account: PromiseOrValue<string>,
    conditionId: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  getSupplyClaimedByWallet(
    account: PromiseOrValue<string>,
    conditionId: PromiseOrValue<BigNumberish>,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  setClaimConditions(
    conditions: DropGroup.ClaimConditionStruct[],
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    __DropFacet_init(
      rewardsDistribution: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    addClaimCondition(
      condition: DropGroup.ClaimConditionStruct,
      overrides?: CallOverrides
    ): Promise<void>;

    claimAndStake(
      req: DropClaim.ClaimStruct,
      delegatee: PromiseOrValue<string>,
      deadline: PromiseOrValue<BigNumberish>,
      signature: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    claimWithPenalty(
      req: DropClaim.ClaimStruct,
      expectedPenaltyBps: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    getClaimConditionById(
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<DropGroup.ClaimConditionStructOutput>;

    getClaimConditions(
      overrides?: CallOverrides
    ): Promise<DropGroup.ClaimConditionStructOutput[]>;

    getDepositIdByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getSupplyClaimedByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setClaimConditions(
      conditions: DropGroup.ClaimConditionStruct[],
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "DropFacet_ClaimConditionAdded(uint256,tuple)"(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      condition?: null
    ): DropFacet_ClaimConditionAddedEventFilter;
    DropFacet_ClaimConditionAdded(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      condition?: null
    ): DropFacet_ClaimConditionAddedEventFilter;

    "DropFacet_ClaimConditionsUpdated(uint256,tuple[])"(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      conditions?: null
    ): DropFacet_ClaimConditionsUpdatedEventFilter;
    DropFacet_ClaimConditionsUpdated(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      conditions?: null
    ): DropFacet_ClaimConditionsUpdatedEventFilter;

    "DropFacet_Claimed_And_Staked(uint256,address,address,uint256)"(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      claimer?: PromiseOrValue<string> | null,
      account?: PromiseOrValue<string> | null,
      amount?: null
    ): DropFacet_Claimed_And_StakedEventFilter;
    DropFacet_Claimed_And_Staked(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      claimer?: PromiseOrValue<string> | null,
      account?: PromiseOrValue<string> | null,
      amount?: null
    ): DropFacet_Claimed_And_StakedEventFilter;

    "DropFacet_Claimed_WithPenalty(uint256,address,address,uint256)"(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      claimer?: PromiseOrValue<string> | null,
      account?: PromiseOrValue<string> | null,
      amount?: null
    ): DropFacet_Claimed_WithPenaltyEventFilter;
    DropFacet_Claimed_WithPenalty(
      conditionId?: PromiseOrValue<BigNumberish> | null,
      claimer?: PromiseOrValue<string> | null,
      account?: PromiseOrValue<string> | null,
      amount?: null
    ): DropFacet_Claimed_WithPenaltyEventFilter;

    "Initialized(uint32)"(version?: null): InitializedEventFilter;
    Initialized(version?: null): InitializedEventFilter;

    "InterfaceAdded(bytes4)"(
      interfaceId?: PromiseOrValue<BytesLike> | null
    ): InterfaceAddedEventFilter;
    InterfaceAdded(
      interfaceId?: PromiseOrValue<BytesLike> | null
    ): InterfaceAddedEventFilter;

    "InterfaceRemoved(bytes4)"(
      interfaceId?: PromiseOrValue<BytesLike> | null
    ): InterfaceRemovedEventFilter;
    InterfaceRemoved(
      interfaceId?: PromiseOrValue<BytesLike> | null
    ): InterfaceRemovedEventFilter;

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

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

    addClaimCondition(
      condition: DropGroup.ClaimConditionStruct,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    claimAndStake(
      req: DropClaim.ClaimStruct,
      delegatee: PromiseOrValue<string>,
      deadline: PromiseOrValue<BigNumberish>,
      signature: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    claimWithPenalty(
      req: DropClaim.ClaimStruct,
      expectedPenaltyBps: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

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

    getClaimConditionById(
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    getDepositIdByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getSupplyClaimedByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setClaimConditions(
      conditions: DropGroup.ClaimConditionStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;
  };

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

    addClaimCondition(
      condition: DropGroup.ClaimConditionStruct,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    claimAndStake(
      req: DropClaim.ClaimStruct,
      delegatee: PromiseOrValue<string>,
      deadline: PromiseOrValue<BigNumberish>,
      signature: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    claimWithPenalty(
      req: DropClaim.ClaimStruct,
      expectedPenaltyBps: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

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

    getClaimConditionById(
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    getDepositIdByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getSupplyClaimedByWallet(
      account: PromiseOrValue<string>,
      conditionId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    setClaimConditions(
      conditions: DropGroup.ClaimConditionStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;
  };
}