thirdwebDocs
GitHub

newAuctionEvent

Creates an event object for the NewAuction event.

Example

import { getContractEvents } from "thirdweb";
import { newAuctionEvent } from "thirdweb/extensions/marketplace";
 
const events = await getContractEvents({
contract,
events: [
 newAuctionEvent({
 auctionCreator: ...,
 auctionId: ...,
 assetContract: ...,
})
],
});
function newAuctionEvent(
  filters: Partial<{
    assetContract: string;
    auctionCreator: string;
    auctionId: bigint;
  }>,
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "auctionCreator";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "auctionId";
      readonly type: "uint256";
    },
    {
      readonly indexed: true;
      readonly name: "assetContract";
      readonly type: "address";
    },
    {
      readonly components: readonly [
        { readonly name: "auctionId"; readonly type: "uint256" },
        { readonly name: "tokenId"; readonly type: "uint256" },
        { readonly name: "quantity"; readonly type: "uint256" },
        {
          readonly name: "minimumBidAmount";
          readonly type: "uint256";
        },
        {
          readonly name: "buyoutBidAmount";
          readonly type: "uint256";
        },
        {
          readonly name: "timeBufferInSeconds";
          readonly type: "uint64";
        },
        { readonly name: "bidBufferBps"; readonly type: "uint64" },
        { readonly name: "startTimestamp"; readonly type: "uint64" },
        { readonly name: "endTimestamp"; readonly type: "uint64" },
        { readonly name: "auctionCreator"; readonly type: "address" },
        { readonly name: "assetContract"; readonly type: "address" },
        { readonly name: "currency"; readonly type: "address" },
        { readonly name: "tokenType"; readonly type: "uint8" },
        { readonly name: "status"; readonly type: "uint8" },
      ];
      readonly name: "auction";
      readonly type: "tuple";
    },
  ];
  readonly name: "NewAuction";
  readonly type: "event";
}>;

Parameters

Optional filters to apply to the event.

Type

let filters: Partial<{
  assetContract: string;
  auctionCreator: string;
  auctionId: bigint;
}>;

Returns

let returnType: PreparedEvent<{
  readonly inputs: readonly [
    {
      readonly indexed: true;
      readonly name: "auctionCreator";
      readonly type: "address";
    },
    {
      readonly indexed: true;
      readonly name: "auctionId";
      readonly type: "uint256";
    },
    {
      readonly indexed: true;
      readonly name: "assetContract";
      readonly type: "address";
    },
    {
      readonly components: readonly [
        { readonly name: "auctionId"; readonly type: "uint256" },
        { readonly name: "tokenId"; readonly type: "uint256" },
        { readonly name: "quantity"; readonly type: "uint256" },
        {
          readonly name: "minimumBidAmount";
          readonly type: "uint256";
        },
        {
          readonly name: "buyoutBidAmount";
          readonly type: "uint256";
        },
        {
          readonly name: "timeBufferInSeconds";
          readonly type: "uint64";
        },
        { readonly name: "bidBufferBps"; readonly type: "uint64" },
        { readonly name: "startTimestamp"; readonly type: "uint64" },
        { readonly name: "endTimestamp"; readonly type: "uint64" },
        { readonly name: "auctionCreator"; readonly type: "address" },
        { readonly name: "assetContract"; readonly type: "address" },
        { readonly name: "currency"; readonly type: "address" },
        { readonly name: "tokenType"; readonly type: "uint8" },
        { readonly name: "status"; readonly type: "uint8" },
      ];
      readonly name: "auction";
      readonly type: "tuple";
    },
  ];
  readonly name: "NewAuction";
  readonly type: "event";
}>;

The prepared event object.