wallet.claim

claim(claimId: string): Promise<WalletSubmission>

Sends a claim the API prepared for this wallet. Create the claim first through the API with execution: "client_broadcast" and the wallet’s address as the recipient, then pass its id. The wallet fetches the prepared operation, sends it on the customer’s behalf with the cost covered by Endstate, and resolves once the network has included it. Read settlement from the claim resource; the wallet holds no state about it. The page names only the claim id. The destination was decided when the claim was created, so nothing here can redirect it. Rejects with wallet.sponsorship_unavailable when the operation cannot be covered right now (nothing was sent), with submission.not_executable when the claim was already sent or has expired, with wallet.submit_failed when the wallet could not send, and with wallet.destroyed if the wallet has been destroyed. API errors pass through with their own codes.

Returns

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

Example

const { address } = await wallet.ready();
const claim = await client.session.claims.create({
  to: address,
  execution: "client_broadcast",
});
const { transactionHash } = await wallet.claim(claim.id);

Get started

Core SDK

Web SDK

Reader SDK

Returns

Example

​Returns

​Example

Returns

Example