# @fairmint/wrapped-assets-sdk 中文文档

规范地址：https://npmcn.com/package/%40fairmint/wrapped-assets-sdk/

版本：0\.0\.5
npm 元数据更新时间：2026-08-21T19:22:26.931Z
中文译文更新时间：2026-11-14T09:05:45.570Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40fairmint/wrapped-assets-sdk
原文对照：https://npmcn.com/package/%40fairmint/wrapped-assets-sdk/?lang=original
项目主页：https://github.com/Fairmint/canton-assets/tree/main/packages/sdk#readme
源码仓库：https://github.com/Fairmint/canton-assets

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

- 包体积（解压后）：405 kB，114 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：zod \>=4\.3\.6 \<5
- 首次发布：2026-08-19T11:22:30.832Z
- 最新版本发布：2026-08-21T19:22:26.726Z
- 近 30 天下载量：11050（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

对SrappedAssets-v01 DAML合同的意见式Canton Network Token标准注册:工厂、选择上下文和仪器读取,从一个狭窄的分类账端口组装.

## 安装

```sh
npm install @fairmint/wrapped-assets-sdk
```

也可以使用：`pnpm add @fairmint/wrapped-assets-sdk`、`yarn add @fairmint/wrapped-assets-sdk`、`bun add @fairmint/wrapped-assets-sdk`

## README

# @ fairmint/ wrapped- 资产- sdk

州际网络 `WrappedAssets-v01` DAML合同:登记处 读取钱包要求, 以及合同定义的每个选择的指令构建器。 这里什么都没有 提交 —— 构建者返回一个 Ledger JSON API 命令,加上提交所携带的披露, 把它交给一个分类账客户 是打电话者的一步.

不是生成的 Daml 绑定。 这些是 [`@fairmint/wrapped-assets-daml-js`](https://www.npmjs.com/package/@fairmint/wrapped-assets-daml-js), (中文(简体) ), 从此寄存器库中发布并单独版本, 以及此软件包的依赖性 而不是别的选择 每个模板 id, 接口 id, 选择名称和选择参数形状 这里读取这些束缚, 绑在 `0.0.2`,所以这个SDK 跟踪的正是该版本的DAR 产生来源于:登记工厂、仪器暂停和遵约执行。 A 类 选择稍后的 DAR 重命名或缩放停止此软件包的编译, 而不是在提交时失败 时间.

此软件包并不影响您使用的哪个分类账客户端 。 输入 a `RegistryLedger`,或一个 鸭型JSON API读取器(`getActiveContracts` + 键 `getEventsByContractId`) (中文(简体) ). 读取CIP-56结果, 使用情况 `@fairmint/canton-node-sdk` (或另一个客户端)与此软件包 `CHOICES` 编号 : `TEMPLATE_IDS`。 。 。 .

## 安装

```bash
npm install @fairmint/wrapped-assets-sdk
```

```ts
import { createWrappedAssetsRegistry } from '@fairmint/wrapped-assets-sdk';

// `ledger` is a RegistryLedger, or any JSON API reader with
// getActiveContracts + getEventsByContractId.
const registry = createWrappedAssetsRegistry({
  ledger: client,
  adminId: 'OTA::1220aaaa',
  instruments: [{ id: 'FMT-A', name: 'Fairmint Wrapped A', symbol: 'FMTA', decimals: 6 }],
});

await registry.listInstruments();
```

## 要达到什么

| 意图 | 开始于 |
| --- | --- |
| 为登记册服务 API:仪器、工厂、选择背景 | `createWrappedAssetsRegistry`, (中文(简体) ), `createWrappedAssetsRegistryFromJsonApiClient` |
| 发行或再包装单元(暂停) | `getBurnMintFactory`, (中文(简体) ), `buildMintCommand`, (中文(简体) ), `buildBurnMintCommand` |
| 退休单位(停用盲) | `getBurnFactory`, (中文(简体) ), `buildBurnCommand` |
| Redeem:主人同意,转帐员晚点烧了 | `buildBurnOfferCreateCommand`,则 `Accept`编号 :`Reject`编号 :`Withdraw`编号 :`Expire` 旁边的建筑工 |
| 发送单位,或解决一个行业的一段 | `buildTransferCommand`, (中文(简体) ), `buildAllocateCommand`,以及接受、拒绝、退出和取消建设者 |
| 遵守:冻结、释放、没收、暂停 | `buildEnforceHoldingsCommand`, (中文(简体) ), `buildBurnHoldingEnforcementCommand`, (中文(简体) ), `buildEnforceInstrumentsCommand` |
| 站起来或退休 工厂或乐器 | `build*ProposalCreateCommand` 以及接受、拒绝和退出建造者 |
| 名称或匹配模板、接口或选择 | `TEMPLATE_IDS` (命令), `TEMPLATES` + 键 `matchesTemplate` (创建事件), `CHOICES`, (中文(简体) ), `*_INTERFACE_ID` |
| 处理失败 | `NotFoundError` (404个), `BadRequestError` (400个), `UnavailableError` (503) (中文(简体) ) |
| 自己执行分类账 或者从别的地方读 | `RegistryLedger`,以及 `test/support/fixtures.ts` 作为实例 |
| 根据标准验证请求或答复 | `@fairmint/wrapped-assets-sdk/schemas` |

这个 `./schemas` 切入点是Zod计划 每一个请求和响应的标准定义, 期间生成 `npm run build` 由 OpenAPI 四个文档 Splice 出版并粘接 `openapi/specs.lock.json`,因此根据标准验证的服务器不会运行生成器 自己来的. `zod` 是一种可选的同伴依赖,只有进口该条目的消费者需要 点 `devDependency` 被绑在最古老的版本上 所以一个消费者 将这个版本与这些计划共享一份Zod,而不是比较两份.

薄荷从0.0.4起被暂停并瞄准仪器 还有一个燃烧薄荷呼叫器通过 空上下文现在必须获取 . [`CHANGELOG.md`](https://npmcn.com/package/%40fairmint/wrapped-assets-sdk/CHANGELOG.md) 有迁移.

每项出口都在其定义的医生评论中载有合同,包括谁控制每项出口 选择,哪个构建者被暂停, 和每个读者拒绝猜测。 棋子怎么合得来 ——登记册在OTA架构中的位置,以及DAR的部署地点 [费尔明特/德文文件](https://github.com/Fairmint/dev-docs/blob/main/docs/onchain/canton/wrapped-assets.md)。 。 。 .

## 开发

```bash
npm install    # from the repository root
npm run build:sdk
npm run test:sdk
```

测试是 `node:test` 结束 `tsx` 永远无法到达参与者的节点:建筑商被指责反对 预期JSON, 登记册对照固定分类账, 和 `test/schemas.test.ts` 剖析每 登记册与生成的操作计划一起阅读.

`src/generated/` 没有承诺。 构建、测试和打字检查全部运行 `npm run generate` 首先,哪个 如果每个被绑定的文档缺失, 则获取这些文档, 拒绝一个不散开的文档 `openapi/specs.lock.json` 记录,写出计划——所以他们中任何一个人的第一流需要 网络接入.

此 SDK 名称的每个模板现在都在 `WrappedAssets-v01` DAR,以及 `test/templates.test.ts` 持之以恒: 选择从公布的装订中取出 宣布一个选择,建设者无法到达。 单位测试的只是他们的行为 在分类账上的命令—— `test/localnet/` 找到一个现场参与者 工厂的靴子, 因此,转移、分配和执行建设者是针对预期的JSON提出的,而不是 提交.

## 常见问题

### @fairmint/wrapped-assets-sdk 是什么？

对SrappedAssets-v01 DAML合同的意见式Canton Network Token标准注册:工厂、选择上下文和仪器读取,从一个狭窄的分类账端口组装\.

### 如何安装 @fairmint/wrapped-assets-sdk？

在项目目录运行 npm install @fairmint/wrapped-assets-sdk，或使用 pnpm add / yarn add / bun add。

### @fairmint/wrapped-assets-sdk 支持 TypeScript 吗？

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

### @fairmint/wrapped-assets-sdk 支持 ESM 还是 CommonJS？

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

### @fairmint/wrapped-assets-sdk 需要什么版本的 Node\.js？

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

### @fairmint/wrapped-assets-sdk 可以商用吗？

@fairmint/wrapped-assets-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @fairmint/wrapped-assets-sdk 的下载量有多少？

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

### @fairmint/wrapped-assets-sdk 还在维护吗？

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