# @liqpro/liq-react 中文文档

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

版本：0\.83\.0
npm 元数据更新时间：2026-11-01T17:07:21.950Z
中文译文更新时间：2026-11-01T17:58:14.673Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：230 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：viem ^2\.0\.0，react ^18\.0\.0 \|\| ^19\.0\.0，wagmi ^2\.0\.0，@tanstack/ai-react ^0\.7\.9，@tanstack/react-query ^5\.99\.2
- 首次发布：2026-06-14T05:20:03.132Z
- 最新版本发布：2026-11-01T17:07:21.775Z
- 已发布版本数：53（近 12 个月 53 个）

## 中文简介

React钩子、突变和Liq perpetual交易前端的状态管理。

## 安装

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

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

## README

# @liq /反应

React钩子、突变和Liq perpetual交易前端的状态管理。

## 概述

`@liq/react` 包装 `@liq/api-client` 和 `@liq/onchain` 在React Query查询、wagmi/ video突变和Zustand存储中。它提供了 `LiqProvider` 作为根上下文组件，一组用于市场、头寸、订单和保证金的数据获取钩子，以及用于订单提交、取消、存款和网关身份验证的突变钩子。跟踪所有异步事务流 `useTransactionStore`.

## 主要出口

### 提供者

-   `LiqProvider` -根提供商（封装React Query +网关客户端上下文）
-   `useLiqClient()` -访问配置的 `LiqClient` 实例
-   `useLiqOnchain()` -访问配置的 `LiqOnchain` 实例

### 查询钩子（TanStack Query）

| 钩 | 描述 |
| --- | --- |
| `useMarketsQuery()` | 争取所有市场 |
| `useOpenOrdersQuery()` | 获取往来账户的未结清订单 |
| `useAvailableMarginQuery()` | 获取往来账户可用保证金 |
| `useAccountId()` | 读取SNX帐户ID |
| `liqQueryKeys` | 所有查询的缓存键工厂 |

保证金（自0.67.0起）：

| 钩 | 描述 |
| --- | --- |
| `useAccountMargin(accountId)` | 门户保证金—— `available`， `locked`， `free` （`free` 提要 `validateOrder`);需要网关会话；也刷新了终端订单转换 |
| `useMarginUsage(accountId)` | `{ requiredInitialMargin, available, usage }` 阅读onchain; `data` 未定义=无读取(`isLoading` 在飞行中, `fetchStatus === 'idle'` 禁用-不禁用 `isPending`)， `data.usage` 在水下 |
| `useOrderMarginPreview(accountId, market, size, price, orderCost?)` | 协议 `requiredMargin` 和按价目表价格估算的平仓价格（限价为limit，标记为MARKET）；价格变动费用，初始保证金根据合约的预设值计算；没有连接钱包的禁用；每隔10秒重读一次，并在结算、存款、取款和还款方面进行更新 |

### 突变钩子

| 钩 | 描述 |
| --- | --- |
| `useOrderSubmission()` | 提交订单草稿-立即、签名、重试、无效 |
| `useCancelOrderMutation()` | 取消未完成的订单 |
| `useDepositMutation()` | USDC→sUSDC→抵押存款（链上） |
| `useWithdrawMutation()` | 收回抵押品，必要时先偿还债务（在线） |
| `useCreateAccountMutation()` | 创建SNX账户NFT（在线） |
| `useClaimFaucetMutation()` | 申请测试网水龙头代币（链上） |
| `useGatewayAuthMutation()` | SIWE认证→JWT |
| `useTransactionMutation()` | 具有状态跟踪的通用链上tx包装器 |

无气继电器(ADR-0063) -安装 `<LiqProvider relay>` 同样的突变挂在上面 签署一份 `Delegate7702` 批处理中继器发送和支付，因此钱包永远不需要 乙。没有单独的钩子：提供者的发送者选择钱包或 中继，钩子不知道是哪个。

### SSE /实时

-   `useSseOrderUpdates(orderIds, callback)` -所列订单的实时状态更新，从过滤 `orders:{accountId}` 通道（更改列表不会重新打开流）
-   `useAccountOrderUpdates(onUpdate?)` -一个帐户范围的订阅 `orders:{accountId}` 流;回调得到完整的 `order_update` 与 `reason` / `origin`

### 公用事业公司

-   `useWallet()` -活动钱包地址+链ID
-   `useNetworkId()` -当前网络ID
-   `useDebounce(value, delay)` -脱钩

### 商店(Zustand)

-   `useGatewayStore` / `selectIsAuthenticated` - JWT +授权状态
-   `useTransactionStore` / `TransactionStatus` / `TransactionState` / `TransactionType` - onchain tx生命周期

## 安装

```bash
pnpm add @liq/react
```

## 同行依赖性

-   `react` ^18或^19
-   `viem` ^ 2
-   `wagmi` ^ 2

## 构建

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

## 常见问题

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

React钩子、突变和Liq perpetual交易前端的状态管理。

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

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

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

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

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

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

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

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

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

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