useCancelListing

Defined in react-core/src/evm/hooks/async/marketplace.ts#L907

Cancel a listing

function useCancelListing(
  contract: RequiredParam<Marketplace>,
): UseMutationResult<
  Omit<
    {
      data: () => Promise<unknown>;
      receipt: providers.TransactionReceipt;
    },
    "data"
  >,
  unknown,
  Pick<AuctionListing | DirectListing, "type" | "id">,
  unknown
>;

Documentation

Parameters

Returns

a mutation object that can be used to cancel a listing

type ReturnType = UseMutationResult<
  Omit<
    {
      data: () => Promise<unknown>;
      receipt: providers.TransactionReceipt;
    },
    "data"
  >,
  unknown,
  Pick<AuctionListing | DirectListing, "type" | "id">,
  unknown
>;

Example

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

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

  return (
    <button disabled={isLoading} onClick={cancelListing}>
      Cancel Auction Listing!
    </button>
  );
};