@breeztech/breez-sdk-spark

中文文档
0.28.0发布于 2026/11/05MITTypeScriptESM + CJS零依赖近 30 天下载 4.1万

Brez Spark SDK 闪光灯

中文使用文档
文档目录10 节
  1. 概览
  2. 什么是布列兹SDK?
  3. 安装
  4. 使用量
  5. 网页
  6. 安全部门改革框架(Next.js、SvelteKit、Nuxt、Remix)
  7. 节点.js
  8. 子路径导出
  9. 定价
  10. 支助

布里兹 SDK

概览

Breez SDK为开发者提供一端到端的解决方案,将即时,非拘禁的比特币和稳定币融入他们的应用和服务. 它消除了对第三方的需求,简化了比特币和闪电的复杂性,使数十亿用户能够无缝地上船,通向价值转移的未来.

什么是布列兹SDK?

它是一个无节奏的集成,它为比特币和稳定币的集成提供了非拘禁,端到端的解决方案,它利用了比特币-内生地层2闪电(Bitcoin-native Leater 2 Lightning & Spark),与链上互操作性和第三方相接相接.

安装

要安装软件包 :

npm install @breeztech/breez-sdk-spark

或者说

yarn add @breeztech/breez-sdk-spark

使用量

去布里兹SDK 文档 开始在你的应用或服务中执行即时比特币和马来克币.

网页

开发浏览器应用程序时,从 @breeztech/breez-sdk-spark (或明确 @breeztech/breez-sdk-spark/web (原始内容存档于2018-03-29). subpath.

打电话 await init() 在使用任何其他 SDK 方法之前装入 Web Assembly 模块.

import init, {
  defaultConfig,
  connect,
} from "@breeztech/breez-sdk-spark/web";

await init();

const config = defaultConfig("mainnet");
config.apiKey = "<your api key>";

const sdk = await connect({
  config,
  seed: { type: "mnemonic", mnemonic: "<words>", passphrase: undefined },
  storageDir: "./.data",
});

安全部门改革框架(Next.js、SvelteKit、Nuxt、Remix)

使用 @breeztech/breez-sdk-spark/ssr sSR应用中的子路径. 它可以在服务器侧面渲染时被导入而不出错——没有加载WASM,没有浏览器或节点.js API被触摸. 打电话 init() 在使用 SDK 函数之前,客户端可以加载 WASM 模块.

"use client";
import { useEffect, useState } from "react";
import init, { connect, defaultConfig } from "@breeztech/breez-sdk-spark/ssr";

export default function Wallet() {
  const [sdk, setSdk] = useState(null);

  useEffect(() => {
    (async () => {
      await init(); // Loads WASM — client-side only
      const config = defaultConfig("mainnet");
      config.apiKey = "<your api key>";
      const s = await connect({
        config,
        seed: { type: "mnemonic", mnemonic: "<words>", passphrase: undefined },
        storageDir: "./.data",
      });
      setSdk(s);
    })();
  }, []);

  return <div>{sdk ? "Connected" : "Loading..."}</div>;
}

节点.js

说明:此包需要node.js v22或更高.

开发节点Js应用程序时,使用 require("@breeztech/breez-sdk-spark") 或者说 import 或明白的 @breeztech/breez-sdk-spark/nodejs (原始内容存档于2018-03-29). Subpath. 没有 init() 需要呼叫: WASM 模块自动加载.

const {
  defaultConfig,
  connect,
} = require("@breeztech/breez-sdk-spark");

const config = defaultConfig("mainnet");
config.apiKey = process.env.BREEZ_API_KEY;

const sdk = await connect({
  config,
  seed: { type: "mnemonic", mnemonic: process.env.MNEMONIC, passphrase: undefined },
  storageDir: "./.data",
});

const info = await sdk.getInfo({});
console.log(`Balance: ${info.balanceSats} sats`);

子路径导出

子路径环境模块格式
@breeztech/breez-sdk-sparkNode.js / 浏览器( 默认)CJS/无害环境管理
@breeztech/breez-sdk-spark/web浏览器无害环境管理
@breeztech/breez-sdk-spark/nodejs节点.jsCJS/无害环境管理
@breeztech/breez-sdk-spark/bundlerBundler (Webpack, Vite) (英语)无害环境管理
@breeztech/breez-sdk-spark/deno德诺无害环境管理
@breeztech/breez-sdk-spark/ssr安全部门改革(说明)无害环境管理

定价

布里兹SDK是 免费 用于开发者.

支助

有问题给团队吗? 加入我们 电报 或者给我们发邮件 联系人@breez.技术。 。 。 .

版本与发布记录

@breeztech/breez-sdk-spark 共发布 148 个版本,首次发布于 2025/08/26;过去 12 个月发布了 109 个版本。

版本发布日期距今
0.28.0latest2026/11/053 天前
0.27.3-dev2026/11/053 天前
0.27.22026/10/2316 天前
0.27.12026/10/2317 天前
0.27.02026/10/2217 天前
0.26.12026/10/021 个月前

关于 @breeztech/breez-sdk-spark 的常见问题

@breeztech/breez-sdk-spark 是什么?

Brez Spark SDK 闪光灯

如何安装 @breeztech/breez-sdk-spark?

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

@breeztech/breez-sdk-spark 支持 TypeScript 吗?

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

@breeztech/breez-sdk-spark 支持 ESM 还是 CommonJS?

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

@breeztech/breez-sdk-spark 需要什么版本的 Node.js?

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

@breeztech/breez-sdk-spark 可以商用吗?

@breeztech/breez-sdk-spark 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@breeztech/breez-sdk-spark 的下载量有多少?

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

@breeztech/breez-sdk-spark 还在维护吗?

最新版本 0.28.0 发布于 2026/11/05(3 天前);至今共发布 148 个版本,其中过去 12 个月发布了 109 个;首次发布于 2025/08/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。