# @blinkbitcoin/blink-client 中文文档

规范地址：https://npmcn.com/package/%40blinkbitcoin/blink-client/

版本：1\.1\.1
npm 元数据更新时间：2026-08-28T19:16:40.669Z
中文译文更新时间：2026-11-08T06:57:47.914Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1 MB，98 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@bitcoinerlab/secp256k1 ^1\.1\.1，@noble/hashes ^1\.8\.0，@scure/base ^1\.1\.9，bitcoinjs-lib ^7\.0\.0，bolt11 ~1\.4\.1，libphonenumber-js ^1\.12\.23，lnurl-pay ^5\.0\.2
- 首次发布：2025-03-31T09:42:17.067Z
- 最新版本发布：2026-08-28T19:16:40.485Z
- 近 30 天下载量：1929（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 5 个）

## 中文简介

Brink 堆栈的 JavaScript 客户端库. 这被用在网络和移动钱包等前端应用中.

## 安装

```sh
npm install @blinkbitcoin/blink-client
```

也可以使用：`pnpm add @blinkbitcoin/blink-client`、`yarn add @blinkbitcoin/blink-client`、`bun add @blinkbitcoin/blink-client`

## README

# 闪烁客户端

Brink 堆栈的 JavaScript 客户端库. 这被用在网络和移动钱包等前端应用中.

## 安装

以 :

```bash
pnpm add @blinkbitcoin/blink-client
```

## 使用量

### 解析付费列表

```js
import { parsePaymentDestination } from "@blinkbitcoin/blink-client"

const { valid, paymentType, amount } = parsePaymentDestination({
  destination: "username or invoice or bitcoin address",
  network: "mainnet", // or signet or regtest
  lnAddressDomains: ["blink.sv"],
})
```

有效的电话号码输入解析为闪电地址 `pay.blink.sv` 页:1 主网和 `pay.staging.blink.sv` 用于签名或重新测试。 设定 `phoneNumberLnAddressDomain` 只覆盖电话号码域 :

```js
parsePaymentDestination({
  destination: "+50370123456",
  network: "mainnet",
  lnAddressDomains: ["blink.sv"],
  phoneNumberLnAddressDomain: "phone.example.com",
})
// lnurl: "+50370123456@phone.example.com"
```

当一个QR代码或非手机手动输入与一个商家付款集成匹配时 结果仍然有效 `PaymentType.Lnurl` 包含 `isMerchant: true` 加一个 `merchant` 对象。 当输入匹配无法独到的多个集成时 由 `displayCurrency`,结果是:

```ts
{
  paymentType: PaymentType.Merchant,
  merchants: Merchant[],
}
```

每个商家包括其ID、闪电地址、类别、显示元数据以及一个 可选显示货币. `category` 仅是元数据; 消费者选择全部, 过滤、区域资格和政策决定.

`PaymentType.Merchant` 要求支付前选择消费者,不包括 `valid` 字段。 分会 `paymentType` 在依赖之前 `valid` 或开始支付.

## 测试

用 Jest 框架进行测试 :

```bash
pnpm test
```

## 构建

在其中构建生产(分发)文件 **数字** 文件夹 :

```bash
pnpm build
```

## 地方发展

使用 pnpm 数据

运行 :

```bash
pnpm link --global
```

在测试项目运行中:

```bash
pnpm link --global @blinkbitcoin/blink-client
```

如果您想要删除链接, 请运行 :

```bash
# in your test project
pnpm unlink @blinkbitcoin/blink-client

# in blinkbitcoin/client folder
pnpm unlink --global
```
使用雅尔克语

运行 :

```bash
# in blinkbitcoin/blink-client folder
yalc publish
```

在测试项目运行中 :

```bash
yalc add @blinkbitcoin/blink-client
```

如果您想要删除符号链接, 请运行 :

```bash
# in your test project
yalc remove @blinkbitcoin/blink-client
```

要更新更改,必须运行 `yalc publish` 运行前 :

```bash
# in your test project
yalc update
```

## 常见问题

### @blinkbitcoin/blink-client 是什么？

Brink 堆栈的 JavaScript 客户端库\. 这被用在网络和移动钱包等前端应用中\.

### 如何安装 @blinkbitcoin/blink-client？

在项目目录运行 npm install @blinkbitcoin/blink-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@bitcoinerlab/secp256k1（^1\.1\.1）、@noble/hashes（^1\.8\.0）、@scure/base（^1\.1\.9）、bitcoinjs-lib（^7\.0\.0）、bolt11（~1\.4\.1）、libphonenumber-js（^1\.12\.23）、lnurl-pay（^5\.0\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blinkbitcoin/blink-client 支持 TypeScript 吗？

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

### @blinkbitcoin/blink-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @blinkbitcoin/blink-client 可以商用吗？

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

### @blinkbitcoin/blink-client 的下载量有多少？

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

### @blinkbitcoin/blink-client 还在维护吗？

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