Skip to main content

useMinimumNextBid() function

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

Use this to get the minimum next bid for the auction listing from your marketplace contract.

Example

const { data: minimumNextBid, isLoading, error } = useMinimumNextBid(<YourMarketplaceContractInstance>, <listingId>);

Signature:

export declare function useMinimumNextBid(
contract: RequiredParam<Marketplace>,
listingId: RequiredParam<BigNumberish>,
): import("@tanstack/react-query").UseQueryResult<
{
symbol: string;
value: import("ethers").BigNumber;
name: string;
decimals: number;
displayValue: string;
},
unknown
>;

Parameters

ParameterTypeDescription
contractRequiredParam<Marketplace>an instance of a marketplace contract
listingIdRequiredParam<BigNumberish>the listing id to check

Returns:

import("@tanstack/react-query").UseQueryResult<{ symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }, unknown>

a response object that includes the minimum next bid for the auction listing