useCancelVault

function useCancelVault(): {
  cancelVault: (args: { requestId: string }) => Promise<WalletSubmission>;
  status: "idle" | "pending" | "success" | "error";
  data: WalletSubmission | null;
  error: Error | null;
  reset: () => void;
};

cancelVault({ requestId }) sends the owner’s cancel from their wallet, with the cost covered by Endstate. With a tap session it then reads eligibility until Endstate no longer names the request, and resolves once it does, so useCanVault offers the vault again. It needs no tap session, only the wallet that approved the request; without one it resolves once the network included the cancel. If Endstate has not seen the cancel within two minutes, or the read fails, it still resolves and useCanVault keeps its last answer.

Example

"use client";
import { useCancelVault } from "@endstate-sdk/web/react";

// requestId is the id vault() returned, or canVault's requestId after a reload.
function CancelButton({ requestId }: { requestId: string }) {
  const { cancelVault, status } = useCancelVault();
  return (
    <button
      disabled={status === "pending" || status === "success"}
      onClick={() => cancelVault({ requestId })}
    >
      Cancel the vault request
    </button>
  );
}

Returns

(args: { requestId: string }) => Promise<WalletSubmission>

Resolves with { transactionHash, address, resourceId }. Rejects with submission.not_executable when the request is already closed, and with auth.forbidden when this wallet did not approve it.

"idle" | "pending" | "success" | "error"

The outcome of the latest call for the current tap, wallet and sign-in.

WalletSubmission | null

The latest cancel the wallet sent.

Error | null

The failure that moved status to "error".

() => void

Returns the hook to "idle".

Get started

Core SDK

Web SDK

Reader SDK

Example

Returns

​Example

​Returns

Example

Returns