thirdwebDocs
GitHub

tokensClaimedEvent

Creates an event object for the TokensClaimed event.

Example

import { getContractEvents } from "thirdweb";
import { tokensClaimedEvent } from "thirdweb/extensions/erc1155";
 
const events = await getContractEvents({
contract,
events: [
 tokensClaimedEvent({
 claimConditionIndex: ...,
 claimer: ...,
 receiver: ...,
})
],
});
function tokensClaimedEvent(
  filters: Partial<{
    claimConditionIndex: bigint;
    claimer: string;
    receiver: string;
  }>,
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "claimConditionIndex";
      readonly type: "uint256";
    },
    {
      readonly indexed: true;
      readonly name: "claimer";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "receiver";
      readonly type: "address";
    },
    { readonly name: "tokenId"; readonly type: "uint256" },
    { readonly name: "quantityClaimed"; readonly type: "uint256" },
  ];
  readonly name: "TokensClaimed";
  readonly type: "event";
}>;

Parameters

Optional filters to apply to the event.

Type

let filters: Partial<{
  claimConditionIndex: bigint;
  claimer: string;
  receiver: string;
}>;

Returns

let returnType: PreparedEvent<{
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "claimConditionIndex";
      readonly type: "uint256";
    },
    {
      readonly indexed: true;
      readonly name: "claimer";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "receiver";
      readonly type: "address";
    },
    { readonly name: "tokenId"; readonly type: "uint256" },
    { readonly name: "quantityClaimed"; readonly type: "uint256" },
  ];
  readonly name: "TokensClaimed";
  readonly type: "event";
}>;

The prepared event object.