# @dipcoinlab/perp-ts-library 中文文档

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

版本：0\.0\.37
npm 元数据更新时间：2026-10-19T02:50:32.680Z
中文译文更新时间：2026-11-12T12:35:03.053Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.6 MB，70 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：29 个
- 首次发布：2025-07-22T11:30:54.418Z
- 最新版本发布：2026-10-19T02:50:32.493Z
- 近 30 天下载量：2837（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 20 个）

## 中文简介

在Sui上部署的与 Dipcoin 协议互动的永久交换库居间辅助器方法

## 安装

```sh
npm install @dipcoinlab/perp-ts-library
```

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

## README

# 图书馆

perp-ts-library是一个TypeScript库,用于与DipCoin永久合同智能合同在链上互动,为与Dipcoin协议互动提供了完整的功能.

## \* 特性

-   **完成协议整合**:全力支持所有DipCoin长期交易业务
-   **类型安全**: 以 TypeScript 为增强开发者经验所建
-   **模块设计**: 将关注事项与专门模块明确分开
-   **综合文件**: 所有使用案例的详细指南和示例
-   **自动分割硬币**: 无缝存款自动分币功能

## \* 核心组成部分

### 交易 构建器

与 DipCoin 协议进行交易的类别 . 它还揭露了NAV预建帮助者,例如: `buildNavFilledTransaction()` 用于保险库存款、提取、关闭和股价更新流量.

**新建自动分割特性 :**

-   `bank_depositWithAutoSplitTx()` - 为存款自动分币
-   `bank_batchDepositWithAutoSplitTx()` - 自动拆分的批存款
-   不需要外部签名或手动拆分

### 顺序符号

办理安全交易业务的订单签署和核查.

### 市场业务

-   订单安置和管理
-   职位跟踪和管理
-   清算处理
-   供资率业务

## 自动分集功能

图书馆现在包括自动分币功能 不需要手动 `splitCoin` 操作 :

### 传统方法(在此之前)

```typescript
// 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
});
```

### 自动分割方法( 现在)

```typescript
// Single step - automatic coin splitting and deposit
const depositTx = await txBuilder.bank_depositWithAutoSplitTx({
    amount: amount,
    accountAddress: userAddress
});
```

### 福利

-   **简化 API**: 存款业务中不需要外部签名
-   **减少复杂程度**: 单一交易而不是多个步骤
-   **更好的 UX 设备**: 简化终端用户存款程序
-   **批次支持**: 分批存款自动分拆

## 发展与实例

### 先决条件

-   节点.js(v16或更高)
-   Yarn 软件包管理器
-   查阅DipCoin协议合同

### 安装

```bash
yarn install
```

### 项目建设

```bash
yarn build
```

### 文件和实例

前端和后端用户可以指以下文档和实例:

-   [实例](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/examples/README.md) - 完整的使用示例
-   [自动分割存款示例](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/examples/auto-split-deposit.ts) - 新的自动分币特征
-   [上岗和1CT](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/docs/1.Onboarding%E5%92%8C1CT.md) - 开始引导
-   [交存和退出](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/docs/2.%E5%85%85%E5%80%BC%E5%92%8C%E6%8F%90%E7%8E%B0.md) - 账户管理
-   [签署机制](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/docs/%E7%AD%BE%E5%90%8D.md) - 安全和签字
-   [类型脚本 SDK](https://npmcn.com/package/%40dipcoinlab/perp-ts-library/docs/ts_sdk.md) - SDK参考

## 生成 API 引用

这个项目使用JSDoc格式进行评论并使用TypeDoc自动生成文档.

```bash
npx typedoc src/
```

生成的文件将保存在 `docs/api/` 目录.

## 常见问题

### @dipcoinlab/perp-ts-library 是什么？

在Sui上部署的与 Dipcoin 协议互动的永久交换库居间辅助器方法

### 如何安装 @dipcoinlab/perp-ts-library？

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

### @dipcoinlab/perp-ts-library 支持 TypeScript 吗？

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

### @dipcoinlab/perp-ts-library 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @dipcoinlab/perp-ts-library 可以商用吗？

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

### @dipcoinlab/perp-ts-library 的下载量有多少？

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

### @dipcoinlab/perp-ts-library 还在维护吗？

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