# @cashu/cashu-ts 中文文档

规范地址：https://npmcn.com/package/%40cashu/cashu-ts/

版本：4\.13\.1
npm 元数据更新时间：2026-11-10T18:44:40.955Z
中文译文更新时间：2026-11-10T18:46:19.629Z
软件包许可：MIT OR Apache-2\.0

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

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

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

- 包体积（解压后）：2.1 MB，63 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.4\.0
- 运行依赖：4 个
- 首次发布：2023-03-09T15:19:33.600Z
- 最新版本发布：2026-11-10T18:44:40.630Z
- 近 30 天下载量：81017（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：173（近 12 个月 76 个）

## 中文简介

用于与 casu mint 通信的 cashu 库

## 安装

```sh
npm install @cashu/cashu-ts
```

也可以使用：`pnpm add @cashu/cashu-ts`、`yarn add @cashu/cashu-ts`、`bun add @cashu/cashu-ts`

## README

# 卡苏TS

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cashubtc/cashu-ts/node.js.yml) ![GitHub issues](https://img.shields.io/github/issues/cashubtc/cashu-ts) ![GitHub package.json version](https://img.shields.io/github/package-json/v/cashubtc/cashu-ts) ![npm](https://img.shields.io/npm/v/@cashu/cashu-ts) ![npm type definitions](https://img.shields.io/npm/types/@cashu/cashu-ts) ![npm bundle size](https://img.shields.io/bundlephobia/min/@cashu/cashu-ts) [![codecov](https://codecov.io/gh/cashubtc/cashu-ts/graph/badge.svg)](https://codecov.io/gh/cashubtc/cashu-ts)

⚠️ **别鲁莽:** 这个项目还处于早期发展阶段, 总是使用数量 你不介意失去.

Cashu TS 是一个 JavaScript 库,用于 [卡许](https://github.com/cashubtc) 以 TypeScript 编写的钱包.

### 安装

```shell
npm i @cashu/cashu-ts
```

> **自v4起,只实行无害环境管理.** 这个软件包只载ES模块. 常见JS `require()` 不再支持。 如果从 v3 升级, 请参看 [移徙-4.0.0.md](https://npmcn.com/package/%40cashu/cashu-ts/migration-4.0.0.md)。 。 。 .

### 快速启动( 创建钱包)

根据您的需要, 有许多方法可以对钱包进行即时处理 .

钱包课大多是无国籍的,因此可以即时处理并按需要扔掉. 因此,您的应用程序必须管理状态, 例如获取和存储数据库中的证明 .

NB:你必须总是打电话 `loadMint()` 或者说 `loadMintFromCache` 跳过钱包后.

```typescript
import { Wallet } from '@cashu/cashu-ts';

// Simplest: With a mint URL
const mintUrl = 'http://localhost:3338';
const wallet1 = new Wallet(mintUrl); // unit is 'sat'
await wallet1.loadMint(); // wallet is now ready to use

// Persist these in your app
const keychainCache = wallet1.keyChain.cache; // KeyChainCache
const mintInfoCache = wallet1.getMintInfo().cache; // GetInfoResponse

// Advanced: With cached mint data (avoids network calls on startup)
const wallet2 = new Wallet(keychainCache.mintUrl); // unit defaults to 'sat'
wallet2.loadMintFromCache(mintInfoCache, keychainCache);
// wallet2 is now ready to use
```

## 使用量

我们提供了按使用情况分类的综合实例:

-   **[基本指南](https://npmcn.com/package/%40cashu/cashu-ts/docs-src/usage/usage_index.md)**: 开始,和基本符号操作.
-   **[创建钱包](https://npmcn.com/package/%40cashu/cashu-ts/docs-src/usage/create_wallet.md)**: 从薄荷 URL 或缓存薄荷状态初始化钱包 .
-   **[钱包](https://npmcn.com/package/%40cashu/cashu-ts/docs-src/wallet_ops/wallet_ops.md)**: 翻译构建器使用道具.
-   **[钱包事件](https://npmcn.com/package/%40cashu/cashu-ts/docs-src/wallet_events/wallet_events.md)**: 事件订阅
-   **[决定性的对决](https://npmcn.com/package/%40cashu/cashu-ts/docs-src/deterministic_counters.md)**:定型计数器(持久性,检查,凸起).

### 注意: 构建器钩子对全局事件

`WalletOps` 建材包括单笔交易建材中起火的per-operation switch (on Countersreated).

`WalletEvents` 提供全球订阅服务 `(wallet.on.*)` 它能比一个建筑工的电话活得更久.

使用构建者钩子进行交易-本地回调,并使用钱包Events进行全应用订阅.

### 浏览器用法( 独立构建)

Cashu TS 提供了用于演示和 非捆绑使用。 独立捆绑作为 GitHub 释放的一部分而不是 npm 发布 软件包.

* * *

## 更改日志

每个版本——跨越所有发布线(当前和LTS)——的发布注释都在 [GitHub 发布页面](https://github.com/cashubtc/cashu-ts/releases)。 。 。 .

## 贡献

我们欢迎任何人的贡献——新来者、有经验的开发者和AI协助的工作流程.

如果您想捐款:

-   从阅读开始 [社区. md](https://npmcn.com/package/%40cashu/cashu-ts/COMMUNITY.md) 理解我们的贡献哲学,审查期望,以及如何参与.
-   打开一个 [问题](https://github.com/cashubtc/cashu-ts/issues) 或一个 [公关](https://github.com/cashubtc/cashu-ts/pulls)。 。 。 .
-   利用我们追踪进度 [项目](https://github.com/orgs/cashubtc/projects/19)。 。 。 .
-   进程细节见 [贡献指南](https://npmcn.com/package/%40cashu/cashu-ts/CONTRIBUTING.md)。 。 。 .

* * *

## 联系人社区( C)

我们正在建设和鼓励积极参与:

-   加入我们每周的电话——倾听、介绍自己或提问.
-   参加我们 [矩阵服务器](https://matrix.to/#/#dev:matrix.cashu.space) 或者说 [电报频道](https://t.me/CashuBTC) 供正在进行的讨论和合作.

参与对话是产生影响并成为长期贡献者的最佳方式.

## 常见问题

### @cashu/cashu-ts 是什么？

用于与 casu mint 通信的 cashu 库

### 如何安装 @cashu/cashu-ts？

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

### @cashu/cashu-ts 支持 TypeScript 吗？

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

### @cashu/cashu-ts 支持 ESM 还是 CommonJS？

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

### @cashu/cashu-ts 需要什么版本的 Node\.js？

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

### @cashu/cashu-ts 可以商用吗？

@cashu/cashu-ts 使用 MIT OR Apache-2\.0 许可。可在 MIT、Apache-2\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cashu/cashu-ts 的下载量有多少？

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

### @cashu/cashu-ts 还在维护吗？

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