useEnglishAuctionWinningBid() function

This feature is currently in beta and may change based on feedback that we receive.

Use this to get a the winning bid for an auction listing from your marketplace v3 contract.

Example

const { data: winningBid, isLoading, error } = useWinningBid(<YourMarketplaceV3ContractInstance>, <listingId>);

Signature:

export declare function useEnglishAuctionWinningBid(
  contract: RequiredParam<MarketplaceV3>,
  auctionId: RequiredParam<BigNumberish>,
): import("@tanstack/react-query").UseQueryResult<
  import("@thirdweb-dev/sdk").Bid | undefined,
  unknown
>;

Parameters

Parameter	Type	Description
contract	RequiredParam<MarketplaceV3>	an instance of a marketplace contract
auctionId	RequiredParam<BigNumberish>	the auction id to check

Returns:

import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk").Bid | undefined, unknown>

a response object that includes the that is winning the auction