wallet.cancelVault

cancelVault(requestId: string): Promise<WalletSubmission>

Sends the owner’s cancel of the vault request vault() opened, named by its id. The wallet fetches the prepared cancel, sends it with the cost covered by Endstate, and resolves once the network has included it. The request reads cancelled once Endstate sees it. Only the wallet that approved the request can send it. Rejects with submission.not_executable when the request is already closed, with vault.request_not_found for an unknown id, with auth.forbidden when this wallet did not approve the request, with wallet.sponsorship_unavailable when the send cannot be covered right now (nothing was sent), and with wallet.destroyed if the wallet has been destroyed.

Returns

interface WalletSubmission {
  transactionHash: string; // the network transaction that carried it
  address: string;         // the wallet address that sent it
  resourceId: string;      // the vault request id
}

Example

const request = await wallet.vault({ session, vaultId });
await wallet.cancelVault(request.id);

Get started

Core SDK

Web SDK

Reader SDK

Returns

Example

​Returns

​Example

Returns

Example