# @branta-ops/branta 中文文档

规范地址：https://npmcn.com/package/%40branta-ops/branta/

版本：4\.0\.5
npm 元数据更新时间：2026-11-02T01:30:23.062Z
中文译文更新时间：2026-11-08T14:08:12.566Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：62.3 kB，53 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-02-16T19:13:18.082Z
- 最新版本发布：2026-11-02T01:30:22.852Z
- 近 30 天下载量：6378（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

布兰塔 API 的 JavaScript SDK

## 安装

```sh
npm install @branta-ops/branta
```

也可以使用：`pnpm add @branta-ops/branta`、`yarn add @branta-ops/branta`、`bun add @branta-ops/branta`

## README

# @branta-ops/ branta (英语)

Java 脚本 SDK 用于 [布兰塔](https://developer.branta.pro/)仅限无害环境管理.

使用 `verify()` 发送和发送 `addPayment()` 接收时。 状态处理和母平台在 [开发者文件](https://developer.branta.pro/)。 。 。 .

## 安装

```bash
npm i @branta-ops/branta
```

## 发送

```ts
import { BrantaEnvironment, BrantaService } from "@branta-ops/branta";

const service = new BrantaService({
  environment: BrantaEnvironment.Production, // Staging everywhere else
});

const result = await service.verify(input); // scanned QR or pasted text

switch (result.status) {
  case "match":
    // Show the card for result.payments[0]. Link it to result.verifyUrl.
    break;
  case "unknown":
    // Not in Branta — show nothing.
    break;
  case "tampered":
    // Destination was altered. Warn. Do not show a verified card.
    break;
  case "incomplete":
    // 5xx, 429, or unreachable. Tell the user. Do not treat as unknown.
    break;
}
```

链上比特币需要一个 `bitcoin:` 与 URI 连接 `branta_id` 编号 : `branta_secret`. . . . . . 一个赤裸的地址是 `unknown`。 。 。 .

缺少密码 `crypto_unavailable`。不要将其作为 `unknown`。一个404是 `unknown`5xx, 429, 或者没有网络是 `incomplete`。 。 。 .

## 接收

```ts
import {
  BrantaEnvironment,
  BrantaService,
  DestinationType,
  PaymentBuilder,
} from "@branta-ops/branta";

const service = new BrantaService({
  environment: BrantaEnvironment.Production,
  apiKey: "<api-key>",
});

const payment = new PaymentBuilder()
  .setDescription("Invoice #12345")
  .addDestination("bc1q…", DestinationType.BitcoinAddress)
  .setTtl(600) // seconds
  .build();

const { secret, verifyUrl } = await service.addPayment(payment);
```

存储 `secret` 与发票。 打开 `branta_id` 财务报告和审定财务报表 `branta_secret` 在发票QR.

## 密码

HTTPS上的浏览器:无事可做.

HTTP 上的浏览器, 或 React Native / Expo: pass `crypto`,并使用 `service.createPaymentBuilder()` 改为 `new PaymentBuilder()`。 。 。 .

**反应原生/博览会** —— 说 `@noble`数字 :

```bash
npm i @noble/hashes @noble/ciphers
```

```ts
import { BrantaEnvironment, BrantaService, createNobleCryptoProvider } from "@branta-ops/branta";
import { sha256 } from "@noble/hashes/sha2.js";
import { hmac } from "@noble/hashes/hmac.js";
import { gcm } from "@noble/ciphers/aes.js";
import { randomBytes } from "@noble/hashes/utils.js";

const service = new BrantaService({
  environment: BrantaEnvironment.Production,
  crypto: createNobleCryptoProvider({ sha256, hmac, gcm, randomBytes }),
});
```

**HTTP 上的浏览器** —— 说 `@peculiar/webcrypto`数字 :

```bash
npm i @peculiar/webcrypto
```

```ts
import { Crypto } from "@peculiar/webcrypto";
import { BrantaEnvironment, BrantaService } from "@branta-ops/branta";

const service = new BrantaService({
  environment: BrantaEnvironment.Production,
  crypto: new Crypto(),
});
```

[更改日志](https://npmcn.com/package/%40branta-ops/branta/CHANGELOG.md) • 妇女 [警卫](https://npmcn.com/package/%40branta-ops/branta/SECURITY.md)

## 常见问题

### @branta-ops/branta 是什么？

布兰塔 API 的 JavaScript SDK

### 如何安装 @branta-ops/branta？

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

### @branta-ops/branta 支持 TypeScript 吗？

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

### @branta-ops/branta 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @branta-ops/branta 可以商用吗？

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

### @branta-ops/branta 的下载量有多少？

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

### @branta-ops/branta 还在维护吗？

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