@liqpro/liq-subgraph

中文文档
0.83.0发布于 2026/11/02TypeScriptES Module

Liq市场子图的类型化GraphQL客户端。

中文使用文档
文档目录9 节
  1. 概述
  2. 主要出口
  3. LiqSubgraph
  4. 类型
  5. 使用
  6. 安装
  7. 依赖关系
  8. 同行依赖性
  9. 构建

@liq /子图

Liq市场子图的类型化GraphQL客户端。

概述

@liq/subgraph 提供了 LiqSubgraph 客户端类,具有用于从The Graph获取链上事件数据的类型化查询方法——账户、市场、订单结算、抵押品变更、清算和市场更新。子图URL自动从 @liq/core 链配置时 chainId 提供,或可直接提供。

主要出口

LiqSubgraph

由 LiqSubgraphConfig ({ chainId? } | { url? })。

方法返回类型描述
getAccount(accountId)SubgraphAccount | null账户+抵押品余额
getMarket(marketId)SubgraphMarket | null市场的元数据
getOrderSettlements(filter, pagination)SubgraphOrderSettled[]已结算订单历史
getCollateralHistory(filter, pagination)SubgraphCollateralModified[]抵押品存取款事件
getLiquidations(filter, pagination)SubgraphPositionLiquidated[]清算事件
getMarketUpdates(filter, pagination)SubgraphMarketUpdated[]资金率+倾斜更新

类型

  • SubgraphAccount, SubgraphMarket -核心实体类型
  • SubgraphOrderSettled, SubgraphCollateralModified, SubgraphPositionLiquidated, SubgraphMarketUpdated -事件类型
  • OrderSettledFilter, CollateralFilter, LiquidationFilter, MarketUpdatedFilter -滤波器输入
  • PaginationOpts - - - - - - { first?, skip? } 分页

使用

import { LiqSubgraph } from '@liq/subgraph';

const subgraph = new LiqSubgraph({ chainId: 6343 });
// or: new LiqSubgraph({ url: 'https://...' })

const account = await subgraph.getAccount(12345n);
const settlements = await subgraph.getOrderSettlements({ accountId: '12345' }, { first: 50 });

安装

pnpm add @liq/subgraph graphql

依赖关系

  • @liq/core - chain配置和子图URL解析
  • graphql-request -轻量级GraphQL客户端

同行依赖性

  • graphql ^ 16

构建

moon run liq-subgraph:build    # tsup → dist/

版本与发布记录

@liqpro/liq-subgraph 共发布 53 个版本,首次发布于 2026/06/14;过去 12 个月发布了 53 个版本。

版本发布日期距今
0.83.0latest2026/11/021 天前
0.80.02026/10/295 天前
0.79.02026/10/277 天前
0.78.02026/10/2410 天前
0.77.02026/10/2410 天前
0.74.02026/10/2112 天前

关于 @liqpro/liq-subgraph 的常见问题

@liqpro/liq-subgraph 是什么?

Liq市场子图的类型化GraphQL客户端。

如何安装 @liqpro/liq-subgraph?

在项目目录运行 npm install @liqpro/liq-subgraph,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(^16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@liqpro/liq-subgraph 支持 TypeScript 吗?

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

@liqpro/liq-subgraph 支持 ESM 还是 CommonJS?

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

@liqpro/liq-subgraph 可以商用吗?

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

@liqpro/liq-subgraph 还在维护吗?

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