布里兹 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-spark | Node.js / 浏览器( 默认) | CJS/无害环境管理 |
@breeztech/breez-sdk-spark/web | 浏览器 | 无害环境管理 |
@breeztech/breez-sdk-spark/nodejs | 节点.js | CJS/无害环境管理 |
@breeztech/breez-sdk-spark/bundler | Bundler (Webpack, Vite) (英语) | 无害环境管理 |
@breeztech/breez-sdk-spark/deno | 德诺 | 无害环境管理 |
@breeztech/breez-sdk-spark/ssr | 安全部门改革(说明) | 无害环境管理 |
定价
布里兹SDK是 免费 用于开发者.
支助
有问题给团队吗? 加入我们 电报 或者给我们发邮件 联系人@breez.技术。 。 。 .