useCreateAuctionListing

Create a new english auction

function useCreateAuctionListing<
  TMarketplace extends Marketplace | MarketplaceV3,
>(
  contract: RequiredParam<TMarketplace>,
): UseMutationResult<
  TransactionResultWithId,
  unknown,
  TMarketplace extends Marketplace ? NewAuctionListing : {},
  unknown
>;

Parameters


Returns

a mutation object that can be used to create a new auction listing

type ReturnType = UseMutationResult<
  TransactionResultWithId,
  unknown,
  TMarketplace extends Marketplace ? NewAuctionListing : {},
  unknown
>;

Example

const Component = () => {
  const { contract } = useContract("{{contract_address}}");
  const {
    mutate: createAuctionListing,
    isLoading,
    error,
  } = useCreateAuctionListing(contract);

  if (error) {
    console.error("failed to create auction listing", error);
  }

  return (
    <button
      disabled={isLoading}
      onClick={() => createAuctionListing(auctionListingData)}
    >
      Create Auction Listing!
    </button>
  );
};