Skip to main content
Gets a quote for claiming a deposit made to a static deposit address for the SparkWallet.

Method Signature

async getClaimStaticDepositQuote(
  txId: string,
  outputIndex?: number
): Promise<{
  txId: string;
  outputIndex: number;
  creditAmountSats: number;
  sspSignature: string;
}>

Parameters

txId
string
required
The Bitcoin transaction ID of the deposit transaction
outputIndex
number
The index of the output

Returns

Promise resolving to an object containing:
txId
string
required
The transaction ID from the quote
outputIndex
number
required
The output index
creditAmountSats
number
required
The amount in satoshis to claim
sspSignature
string
required
The SSP signature required for claiming

Example

const quote = await wallet.getClaimStaticDepositQuote("transaction-hash-here");
console.log("Quote:", quote);