Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Claims a Bitcoin deposit made to a single-use deposit address for the SparkWallet.

​
Method Signature

async claimDeposit(txid: string): Promise<WalletLeaf[]>

​
Parameters

​
txid
string
required
The transaction ID of the Bitcoin deposit

​
Returns

​
leaves
WalletLeaf[]
required
The wallet leaves resulting from the claim operation

​
Example

const leaves = await wallet.claimDeposit("transaction-hash-here");
console.log("Deposit claimed, leaves:", leaves);