@ fairmint/ wrapped- 资产- sdk
州际网络 WrappedAssets-v01 DAML合同:登记处
读取钱包要求, 以及合同定义的每个选择的指令构建器。 这里什么都没有
提交 —— 构建者返回一个 Ledger JSON API 命令,加上提交所携带的披露,
把它交给一个分类账客户 是打电话者的一步.
不是生成的 Daml 绑定。 这些是
@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。 。 。 .
安装
npm install @fairmint/wrapped-assets-sdk
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 有迁移.
每项出口都在其定义的医生评论中载有合同,包括谁控制每项出口 选择,哪个构建者被暂停, 和每个读者拒绝猜测。 棋子怎么合得来 ——登记册在OTA架构中的位置,以及DAR的部署地点 费尔明特/德文文件。 。 。 .
开发
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提出的,而不是
提交.