useEnglishAuctionWinningBid

Get the winning bid for an english auction

function useEnglishAuctionWinningBid(
  contract: RequiredParam<MarketplaceV3>,
  auctionId: RequiredParam<BigNumberish>,
): UseQueryResult<undefined | Bid, unknown>;

Parameters


Returns

a response object that includes the Bid that is winning the auction

type ReturnType = UseQueryResult<undefined | Bid, unknown>;

Example

const listingId = 0;
const {
  data: winningBid,
  isLoading,
  error,
} = useWinningBid(contract, listingId);