图书馆
perp-ts-library是一个TypeScript库,用于与DipCoin永久合同智能合同在链上互动,为与Dipcoin协议互动提供了完整的功能.
* 特性
- 完成协议整合:全力支持所有DipCoin长期交易业务
- 类型安全: 以 TypeScript 为增强开发者经验所建
- 模块设计: 将关注事项与专门模块明确分开
- 综合文件: 所有使用案例的详细指南和示例
- 自动分割硬币: 无缝存款自动分币功能
* 核心组成部分
交易 构建器
与 DipCoin 协议进行交易的类别 .
它还揭露了NAV预建帮助者,例如: buildNavFilledTransaction() 用于保险库存款、提取、关闭和股价更新流量.
新建自动分割特性 :
bank_depositWithAutoSplitTx()- 为存款自动分币bank_batchDepositWithAutoSplitTx()- 自动拆分的批存款- 不需要外部签名或手动拆分
顺序符号
办理安全交易业务的订单签署和核查.
市场业务
- 订单安置和管理
- 职位跟踪和管理
- 清算处理
- 供资率业务
自动分集功能
图书馆现在包括自动分币功能 不需要手动 splitCoin 操作 :
传统方法(在此之前)
// 1. Manual split coin operation
const splitTx = await splitCoin(client, signer, coinType, amount);
const coinId = TransactionParse.getCreatedObjectIDs(splitTx)[0];
// 2. Deposit with split coin
const depositTx = await txBuilder.bank_depositTx({
coinID: coinId,
amount: amount,
accountAddress: userAddress
});
自动分割方法( 现在)
// Single step - automatic coin splitting and deposit
const depositTx = await txBuilder.bank_depositWithAutoSplitTx({
amount: amount,
accountAddress: userAddress
});
福利
- 简化 API: 存款业务中不需要外部签名
- 减少复杂程度: 单一交易而不是多个步骤
- 更好的 UX 设备: 简化终端用户存款程序
- 批次支持: 分批存款自动分拆
发展与实例
先决条件
- 节点.js(v16或更高)
- Yarn 软件包管理器
- 查阅DipCoin协议合同
安装
yarn install
项目建设
yarn build
文件和实例
前端和后端用户可以指以下文档和实例:
生成 API 引用
这个项目使用JSDoc格式进行评论并使用TypeDoc自动生成文档.
npx typedoc src/
生成的文件将保存在 docs/api/ 目录.