# @liqpro/liq-onchain 中文文档

规范地址：https://npmcn.com/package/%40liqpro/liq-onchain/

版本：0\.83\.0
npm 元数据更新时间：2026-11-01T17:06:01.798Z
中文译文更新时间：2026-11-01T18:00:44.682Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40liqpro/liq-onchain
原文对照：https://npmcn.com/package/%40liqpro/liq-onchain/?lang=original
项目主页：https://github.com/liqu-fi/monorepo#readme
源码仓库：https://github.com/liqu-fi/monorepo

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

- 包体积（解压后）：426 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：viem ^2\.0\.0
- 首次发布：2026-06-14T05:19:22.764Z
- 最新版本发布：2026-11-01T17:06:01.665Z
- 已发布版本数：53（近 12 个月 53 个）

## 中文简介

在线帮助Liq永久交换-存款，抵押品，账户，头寸，并通过视频结算。

## 安装

```sh
npm install @liqpro/liq-onchain
```

也可以使用：`pnpm add @liqpro/liq-onchain`、`yarn add @liqpro/liq-onchain`、`bun add @liqpro/liq-onchain`

## README

# @liq / onchain

在线帮助Liq永久交换-存款，抵押品，账户，头寸，并通过视频结算。

## 概述

`@liq/onchain` 提供了 `LiqOnchain` 所有链上交互的farade和个人服务类别：存入USDC抵押品，管理SNX账户，读取未平仓头寸，并向Synthetix V3提交结算交易 `PerpsMarketProxy`． 它还导出规范契约abi。 `signOrder` （EIP-712）也出口，但只作为 `@internal` 交通为 `@liq/react`． 唯一的运行时依赖项是 `@liq/core` 和 `viem`.

## 主要出口

### `LiqOnchain` (外观)

实例化和 `OnchainConfig` （`{ chainId, walletClient, publicClient }`）. 公开:

| 财产 | 描述 |
| --- | --- |
| `.accounts` | 创建SNX帐户NFTs，设置book模式 |
| `.collateral` | 读可用+锁定边距 |
| `.deposit` | USDC→sUSDC→修改侧枝流 |
| `.positions` | 阅读PerpsMarketProxy的开放头寸 |
| `.delegate` | 无气继电器读取：代表地址， `state(user)` |
| `.settlement` | 呼叫 `settleBookOrders()` |

### 构建器（独立，不需要钱包）

-   `DepositBuilder` / `WithdrawBuilder` - - - - - - `build(): TxPlan` 返回存款/取款步骤；每一步的 `forwarderSafe` Flag表示它是否可以利用钱包发送者批次
-   `executeTypedData(chainId, user, { calls, nonce, deadline })` - - - `signTypedData` 中继批的参数
-   `claimFaucetCall(faucetAddress, token)` -水龙头声称为一体 `PlanStep` （`forwarderSafe: false`);由该计划使用的任何发件人发送，包括钱包
-   `onchain.deposit.repay(debtWei)` ——作为建造者的收回的腿 `build()` 返回一个 `TxPlan` （`WithdrawBuilder.afterRepay`）
-   `tokenTransferPlan(token, amount, recipients)` ——一个 `TxPlan` 一个直接的ERC-20 `transfer` 每名收件人(`forwarderSafe: false`： `transfer` 读取 `msg.sender`); `token` 是 `{ token, decimals }` 对一个 `getCollateral` 结果已经是，所以地址和它的小数不能漂移

### 发送计划

构造器只返回A `TxPlan` （`readonly PlanStep[]`);将其转换为交易是发送者的工作，在呼叫现场选择：

-   `executePlan(plan, { sender, publicClient })` -一组一组地发送计划，等待每个收据，停在第一个没有到达的
-   `walletSender(config)` -批量一个连续的 `forwarderSafe` 一连串的步骤汇成一个 `TrustedMulticallForwarder.aggregate3` 调用;有标记的台阶 `forwarderSafe: false` (一个裸露的ERC-20 `approve`)作为自己的事务
-   `relaySender(config)` -将整个计划作为一个整体发送 `Delegate7702.execute` 批量通过无气继电器（ADR-0063）
-   `landedOrThrow(outcome, what)` -结果作为投掷：返回 `LandedTx[]` 当计划落地，抛出 `PlanRevertedError` （或发送方/传输方自己的错误）否则

### 签署

`signOrder` 仅作为 `@internal` 交通为 `@liq/react`的 `useOrderSubmission`;它不是一个稳定的API （ADR-0012, 0.62.0更新）。

### abi

-   `perpsMarketProxyAbi`， `perpsAccountProxyAbi`， `bookOrderModuleAbi`
-   `spotMarketProxyAbi`， `trustedMulticallForwarderAbi`， `isolatedMarginManagerAbi`， `erc20Abi`
-   遗留的别名: `PERPS_MARKET_PROXY_ABI`， `ERC20_ABI`

### 甲骨文助手

-   `OnchainMarketsService.getChainlinkFeedAddress(nodeId)` -解析价格节点的Chainlink-type (RedStone) feed地址，或者 `null` 当节点不是类型3时

### 链助手

-   `getViemChain(chainId)` -返回视频 `Chain` 对象来获取给定的链ID

## 安装

```bash
pnpm add @liq/onchain
```

## 依赖关系

-   `@liq/core` -链配置，合约地址，共享类型
-   `viem` -链上交互（读写合约，钱包客户端）

## 构建

```bash
moon run liq-onchain:build    # tsup → dist/
```

## 常见问题

### @liqpro/liq-onchain 是什么？

在线帮助Liq永久交换-存款，抵押品，账户，头寸，并通过视频结算。

### 如何安装 @liqpro/liq-onchain？

在项目目录运行 npm install @liqpro/liq-onchain，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：viem（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @liqpro/liq-onchain 支持 TypeScript 吗？

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

### @liqpro/liq-onchain 支持 ESM 还是 CommonJS？

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

### @liqpro/liq-onchain 可以商用吗？

@liqpro/liq-onchain 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @liqpro/liq-onchain 还在维护吗？

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