claimInstantStaticDeposit

Claims an instant static deposit using a quote from getInstantStaticDepositQuote and one of its fulfillment plans.

This method supports both 0-conf plans and plans that require one or more confirmations. The SDK signs the correct claim statement based on the selected plan.

Method Signature

async claimInstantStaticDeposit({
  quote,
  plan,
  transactionId,
  outputIndex,
}: {
  quote: StaticDepositQuote;
  plan: InstantStaticDepositPlan;
  transactionId: string;
  outputIndex: number;
}): Promise<{ claimId: string }>

Parameters

quote

StaticDepositQuote

required

The quote object returned by getInstantStaticDepositQuote.

plan

InstantStaticDepositPlan

required

The fulfillment plan to claim. Select a plan with confirmations === 0 for the 0-conf path.

transactionId

string

required

The Bitcoin transaction ID of the deposit transaction.

outputIndex

number

required

The output index that pays the Spark static deposit address.

Returns

claimId

string

required

The identifier for the instant static deposit claim.

Example

const quoteResult =
  await wallet.getInstantStaticDepositQuote(
    transactionId,
    outputIndex,
    partnerId
  );

const zeroConfPlan = quoteResult.fulfillmentPlans.find(
  (plan) => plan.confirmations === 0
);

if (!zeroConfPlan) {
  throw new Error("0-conf is not available for this deposit");
}

const claim = await wallet.claimInstantStaticDeposit({
  quote: quoteResult.quote,
  plan: zeroConfPlan,
  transactionId: quoteResult.quote.transactionId,
  outputIndex: quoteResult.quote.outputIndex,
});

console.log("Claim ID:", claim.claimId);

⌘I

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

claimInstantStaticDeposit

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example