Skip to main content
Methods for depositing Bitcoin to Spark and withdrawing back to Bitcoin L1.

​
Deposit Methods

​
getSingleUseDepositAddress()

Generates a new single-use deposit address for receiving bitcoin funds. Note that this function returns a bitcoin address, not a Spark Address. Once used, this address should not be used again. For Layer 1 Bitcoin deposits, Spark generates Pay to Taproot (P2TR) addresses. These addresses start with “bc1p” and can be used to receive Bitcoin from any wallet. 
async getSingleUseDepositAddress(): Promise<string>
Returns:
  • Promise<string>: A Bitcoin address for depositing funds

​
getUnusedDepositAddresses()

Gets all unused deposit addresses for the wallet. 
async getUnusedDepositAddresses(): Promise<string[]>
Returns:
  • Promise<string[]>: Array of unused deposit addresses

​
getStaticDepositAddress()

Returns a Bitcoin address that users can deposit funds to as many times as they like. Currently Spark only supports one static deposit address per wallet. If you try to create a second address, it will return your existing static deposit address. 
async getStaticDepositAddress(): Promise<string>
Returns:
  • Promise<string>: A reusable Bitcoin address for depositing funds

​
claimDeposit(txId: string)

Claims a Bitcoin deposit made to a single-use deposit address. 
async claimDeposit(txId: string): Promise<WalletLeaf[]>
Parameters:
  • txId: The transaction ID of the Bitcoin deposit.
Returns:
  • Promise<WalletLeaf[]>: The wallet leaves resulting from the claim operation.

​
getClaimStaticDepositQuote(txId: string, outputIndex?: number)

Gets a quote for claiming a deposit made to a static deposit address. This method returns the transaction details, output index, credit amount in satoshis, and the SSP signature required for claiming. 
async getClaimStaticDepositQuote(
  txId: string,
  outputIndex?: number
): Promise<{
  txId: string;
  outputIndex: number;
  creditAmountSats: number;
  sspSignature: string;
}>
Parameters:
  • txId: The Bitcoin transaction ID of the deposit transaction.
  • outputIndex: (Optional) The index of the output
Returns:
  • Promise<object>: Object containing transaction details and claiming information

​
claimStaticDeposit(params)

Claims a deposit made to a static deposit address using the quote information from getClaimStaticDepositQuote. 
async claimStaticDeposit({
  transactionId,
  creditAmountSats,
  sspSignature,
  outputIndex,
}: {
  transactionId: string;
  creditAmountSats: number;
  sspSignature: string;
  outputIndex?: number;
}): Promise<ClaimStaticDepositOutput | null>
Parameters:
  • params: Object containing:
    • transactionId: The Bitcoin transaction ID from the quote
    • creditAmountSats: The amount of sats from the quote
    • sspSignature: The SSP signature from the quote
    • outputIndex: (Optional) The index of the output
Returns:
  • Promise<ClaimStaticDepositOutput | null>: The claim result or null if the operation fails

​
refundStaticDeposit(depositTxId: string, destinationAddress: string, feeSats: number)

Refunds a deposit made to a static deposit address back to a specified Bitcoin address. The minimum fee is 300 satoshis. 
async refundStaticDeposit(
  depositTxId: string, 
  destinationAddress: string, 
  feeSats: number
): Promise<string>
Parameters:
  • depositTxId: The transaction ID of the original deposit
  • destinationAddress: The Bitcoin address to send the refund to
  • feeSats: The fee to pay for the refund transaction (minimum 300 sats)
Returns:
  • Promise<string>: The refund transaction as a hex string that needs to be broadcast

​
advancedDeposit(txHex: string)

Non-trusty flow for depositing funds to the wallet. Construct the tx spending from an L1 wallet to the Spark address. 
async advancedDeposit(txHex: string): Promise<TreeNode[]>
Parameters:
  • txHex: The hex string of the transaction to deposit.
Returns:
  • Promise<TreeNode[]>: The nodes resulting from the deposit.

​
Withdrawal Methods

​
withdraw(params)

Initiates a withdrawal to move funds from the Spark network to an on-chain Bitcoin address. 
interface WithdrawParams {
  onchainAddress: string;
  exitSpeed: ExitSpeed;
  amountSats?: number;
  feeQuote: WithdrawalFeeQuote; // returned by getWithdrawalFeeQuote
  deductFeeFromWithdrawalAmount?: boolean; // default: true
}

async withdraw(params: WithdrawParams): Promise<CoopExitRequest | null | undefined>
Parameters:
  • params: An object with the following properties:
    • onchainAddress: (Required) The Bitcoin address where the funds should be sent.
    • exitSpeed: (Required) The desired speed of the exit (FAST, MEDIUM, SLOW).
    • amountSats: (Optional) The amount in satoshis to withdraw. If not specified, attempts to withdraw all available funds.
    • feeQuote: (Required) The fee quote object returned by getWithdrawalFeeQuote. Must be used before it expires.
    • deductFeeFromWithdrawalAmount: (Optional, default: true) When true, fees are deducted from the withdrawal amount. When false, fees are deducted from the remaining wallet balance.
Returns:
  • Promise<CoopExitRequest | null | undefined>: The withdrawal request details, or null/undefined if the request cannot be completed.

​
getWithdrawalFeeQuote(params)

Gets a fee quote for a cooperative exit (on-chain withdrawal). The quote includes options for different speeds and an expiry time and must be passed to withdraw before it expires. 
async getWithdrawalFeeQuote({
  amountSats,
  withdrawalAddress,
}: {
  amountSats: number;
  withdrawalAddress: string;
}): Promise<WithdrawalFeeQuote | null>
Parameters:
  • params: Object containing:
    • amountSats: The amount in satoshis to withdraw.
    • withdrawalAddress: The Bitcoin address where the funds should be sent.
Returns:
  • Promise<WithdrawalFeeQuote | null>: A fee quote for the withdrawal, or null if not available.

​
getCoopExitRequest(id: string)

Gets a cooperative exit request by ID. 
async getCoopExitRequest(id: string): Promise<CoopExitRequest | null>
Parameters:
  • id: The ID of the cooperative exit request.
Returns:
  • Promise<CoopExitRequest | null>: The cooperative exit request details or null if not found.