# @buildonspark/issuer-sdk 中文文档

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

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

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

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

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

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

## 中文简介

SDK 发行信号

## 安装

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

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

## README

# Spark 发行器 SDK

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

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

## 安装

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

## 快速启动

### 初始化发行人钱包

```typescript
import { IssuerSparkWallet } from "@buildonspark/issuer-sdk";

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

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

### 创建一个托肯

```typescript
const token = await wallet.createToken({
  tokenName: "My Token",
  tokenTicker: "MTK",
  decimals: 8,
  maxSupply: 1000000n,
  isFreezable: true,
});

console.log(`Token created: ${token.tokenIdentifier}`);
```

### 薄荷图案

```typescript
// Mint tokens to your own wallet
const mintResult = await wallet.mintTokens({
  tokenIdentifier: "spark1...",
  tokenAmount: 10000n,
});

// To distribute tokens to others, mint first then transfer
await wallet.mintTokens({
  tokenIdentifier: "spark1...",
  tokenAmount: 5000n,
});

await wallet.transferTokens({
  tokenIdentifier: "spark1...",
  receiverSparkAddress: "sp1q...",
  tokenAmount: 5000n,
});
```

### 检查发行人托肯余额

```typescript
// Get balance for all tokens you've issued
const balances = await wallet.getIssuerTokenBalances();
for (const [tokenId, info] of balances) {
  console.log(`${info.tokenMetadata.tokenName}: ${info.balance}`);
}
```

### 冻结/解冻托肯斯

```typescript
// Freeze tokens at a Spark address (requires isFreezable: true during creation)
await wallet.freezeTokens({
  tokenIdentifier: "spark1...",
  sparkAddress: "sp1q...",
});

// Unfreeze tokens at a Spark address
await wallet.unfreezeTokens({
  tokenIdentifier: "spark1...",
  sparkAddress: "sp1q...",
});
```

### 烧掉托肯斯

```typescript
const burnResult = await wallet.burnTokens({
  tokenIdentifier: "spark1...",
  tokenAmount: 1000n,
});
```

### 查询托肯交易

```typescript
const transactions = await wallet.getTokenTransactions({
  tokenIdentifier: "spark1...",
  limit: 50,
});

for (const tx of transactions) {
  console.log(`TX: ${tx.id}, Amount: ${tx.amount}`);
}
```

## 平台支持

SDK支持多个 JavaScript 运行时间 :

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

## 常见问题

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

SDK 发行信号

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

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

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

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

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

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

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

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

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

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

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

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

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

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

