@cashu/cashu-ts

中文文档
4.13.1发布于 2026/11/11MIT OR Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 8.1万

用于与 casu mint 通信的 cashu 库

中文使用文档
文档目录8 节
  1. 安装
  2. 快速启动( 创建钱包)
  3. 使用量
  4. 注意: 构建器钩子对全局事件
  5. 浏览器用法( 独立构建)
  6. 更改日志
  7. 贡献
  8. 联系人社区( C)

卡苏TS

GitHub Workflow Status GitHub issues GitHub package.json version npm npm type definitions npm bundle size codecov

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

Cashu TS 是一个 JavaScript 库,用于 卡许 以 TypeScript 编写的钱包.

安装

npm i @cashu/cashu-ts

自v4起,只实行无害环境管理. 这个软件包只载ES模块. 常见JS require() 不再支持。 如果从 v3 升级, 请参看 移徙-4.0.0.md。 。 。 .

快速启动( 创建钱包)

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

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

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

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

使用量

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

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

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

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

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

浏览器用法( 独立构建)

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


更改日志

每个版本——跨越所有发布线(当前和LTS)——的发布注释都在 GitHub 发布页面。 。 。 .

贡献

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

如果您想捐款:

  • 从阅读开始 社区. md 理解我们的贡献哲学,审查期望,以及如何参与.
  • 打开一个 问题 或一个 公关。 。 。 .
  • 利用我们追踪进度 项目。 。 。 .
  • 进程细节见 贡献指南。 。 。 .

联系人社区( C)

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

  • 加入我们每周的电话——倾听、介绍自己或提问.
  • 参加我们 矩阵服务器 或者说 电报频道 供正在进行的讨论和合作.

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

版本与发布记录

@cashu/cashu-ts 共发布 173 个版本,首次发布于 2023/03/09;过去 12 个月发布了 76 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.13.1latest2026/11/11今天
5.0.0-rc.13next2026/11/11今天
5.0.0-rc.122026/10/2912 天前
4.13.02026/10/2714 天前
5.0.0-experimental.b723385aexperimental2026/10/2418 天前
4.12.02026/10/2021 天前

其他发布通道:v3-lts → 3.7.2,experimental → 5.0.0-experimental.b723385a,next → 5.0.0-rc.13。

关于 @cashu/cashu-ts 的常见问题

@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 和提交记录判断。