# @buildonspark/spark-sdk 中文文档

规范地址：https://npmcn.com/package/%40buildonspark/spark-sdk/

版本：0\.15\.0
npm 元数据更新时间：2026-11-03T22:14:18.216Z
中文译文更新时间：2026-11-08T19:13:27.396Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40buildonspark/spark-sdk
原文对照：https://npmcn.com/package/%40buildonspark/spark-sdk/?lang=original
项目主页：https://github.com/buildonspark/spark
源码仓库：https://github.com/buildonspark/spark

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：190 MB，519 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：22 个
- peer 依赖：react \>=18\.2\.0，react-native \>=0\.71\.0，react-native-get-random-values \>=1\.11\.0
- 首次发布：2025-02-25T17:24:07.212Z
- 最新版本发布：2026-11-03T22:14:17.941Z
- 近 30 天下载量：119341（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：168（近 12 个月 60 个）

## 中文简介

闪光 SDK

## 安装

```sh
npm install @buildonspark/spark-sdk
```

也可以使用：`pnpm add @buildonspark/spark-sdk`、`yarn add @buildonspark/spark-sdk`、`bun add @buildonspark/spark-sdk`

## README

# 闪光 SDK

Spark是最快,最便宜,而且最UX友好的方式,在Bitcoin上建立金融应用程序和推出本土资产. 比特币(Bitcoin L2)让开发者以近乎零的成本立即移动比特币和比特币本土资产(包括稳定币),同时保持与比特币基础设施的完全连接.

完整文件,访问 [https://docs.spark.money (英语)](https://docs.spark.money/)

## 安装

```bash
npm install @buildonspark/spark-sdk
# or
yarn add @buildonspark/spark-sdk
# or
pnpm add @buildonspark/spark-sdk
```

## 快速启动

### 初始化钱包

```typescript
import { SparkWallet } from "@buildonspark/spark-sdk";

// Create a new wallet (generates a new mnemonic)
const { wallet, mnemonic } = await SparkWallet.initialize({
  options: {
    network: "MAINNET", // or "REGTEST" for testing
  },
});

// Or initialize with an existing mnemonic
const { wallet } = await SparkWallet.initialize({
  mnemonicOrSeed: "your twelve word mnemonic phrase here ...",
  options: {
    network: "MAINNET",
  },
});
```

### 检查余额

```typescript
const balance = await wallet.getBalance();
console.log(`Bitcoin balance: ${balance.balance} sats`);
console.log(`Token balances:`, balance.tokenBalances);
```

### 静态保存地址

静态存款地址可以重新使用,并允许您收到同一地址的多笔存款.

```typescript
// Get a reusable static deposit address
const staticAddress = await wallet.getStaticDepositAddress();
console.log(`Static deposit address: ${staticAddress}`);

// After sending Bitcoin to the address from an external wallet,
// get a quote for claiming the deposit
const quote = await wallet.getClaimStaticDepositQuote(transactionId);
console.log(`Credit amount: ${quote.creditAmountSats} sats`);
console.log(`Fee: ${quote.feeSats} sats`);

// Claim the deposit with the quote
await wallet.claimStaticDeposit({
  transactionId,
  creditAmountSats: quote.creditAmountSats,
  sspSignature: quote.signature,
});

// Or use the convenience method with a max fee
await wallet.claimStaticDepositWithMaxFee({
  transactionId,
  maxFee: 500, // Will throw if fee exceeds this amount
});

// Query all your static deposit addresses
const addresses = await wallet.queryStaticDepositAddresses();

// Get confirmed UTXOs for a deposit address
const utxos = await wallet.getUtxosForDepositAddress(staticAddress);
for (const utxo of utxos) {
  console.log(`UTXO: ${utxo.txid}:${utxo.vout}`);
}
```

### 发送比特币

```typescript
// Transfer to another Spark address
const transfer = await wallet.transfer({
  receiverSparkAddress: "sp1q...",
  amountSats: 10000,
});

// Withdraw to on-chain Bitcoin address
const withdrawal = await wallet.withdraw({
  onchainAddress: "bc1q...",
  amountSats: 50000,
  exitSpeed: "FAST", // or "MEDIUM", "SLOW"
});
```

### 闪电付款

```typescript
// Create a Lightning invoice
const invoice = await wallet.createLightningInvoice({
  amountSats: 1000,
  memo: "Payment for services",
});
console.log(`Invoice: ${invoice.invoice.encodedInvoice}`);

// Pay a Lightning invoice
const payment = await wallet.payLightningInvoice({
  invoice: "lnbc...",
  maxFeeSats: 100,
});
```

### 调试操作

```typescript
// Get token balances
const { tokenBalances } = await wallet.getBalance();
for (const [tokenId, info] of tokenBalances) {
  console.log(`${info.tokenMetadata.tokenName}: ${info.balance}`);
}

// Transfer tokens
const tokenTransfer = await wallet.transferTokens({
  tokenIdentifier: "spark1...",
  receiverSparkAddress: "sp1q...",
  tokenAmount: 100n,
});
```

### 事件处理

```typescript
import { SparkWalletEvent } from "@buildonspark/spark-sdk";

// Listen for incoming transfers
wallet.on(SparkWalletEvent.TransferClaimed, (transferId, newBalance) => {
  console.log(`Received transfer ${transferId}, new balance: ${newBalance}`);
});

// Listen for confirmed deposits
wallet.on(SparkWalletEvent.DepositConfirmed, (depositId, newBalance) => {
  console.log(`Deposit ${depositId} confirmed, new balance: ${newBalance}`);
});
```

## 平台支持

SDK支持多个 JavaScript 运行时间 :

-   **浏览器**
-   **节点.js**
-   **原生反应**

## 常见问题

### @buildonspark/spark-sdk 是什么？

闪光 SDK

### 如何安装 @buildonspark/spark-sdk？

在项目目录运行 npm install @buildonspark/spark-sdk，或使用 pnpm add / yarn add / bun add。

### @buildonspark/spark-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @buildonspark/spark-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @buildonspark/spark-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @buildonspark/spark-sdk 可以商用吗？

@buildonspark/spark-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @buildonspark/spark-sdk 的下载量有多少？

根据 npm 官方下载统计，@buildonspark/spark-sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 119,341 次，日均约 3,978 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @buildonspark/spark-sdk 还在维护吗？

最新版本 0\.15\.0 发布于 2026/11/04（4 天前）；至今共发布 168 个版本，其中过去 12 个月发布了 60 个；首次发布于 2025/02/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。