@liq / api-client
Liq订单网关API的类型REST + SSE客户端。
概述
@liq/api-client 提供了一个类型化的HTTP客户端，用于与订单网关服务交互。它包装 up-fetch 具有自动JWT承载令牌管理，响应信封展开({ data: T } → T)，以及结构化错误处理 LiqApiError． 响应是类型化的，但没有在运行时进行验证（一个客户机构建读取多个网关版本），因此从声明类型漂移的有效负载原样到达调用者。顶级 LiqClient 公开认证、订单、市场、头寸、账户和SSE流的命名空间服务对象。
主要出口
LiqClient
主入口。由 { baseUrl, chainId? }.
const client = new LiqClient({ baseUrl: 'http://localhost:4000/v1' });
client.setToken(jwt); // set or clear auth token
| 财产 | 类型 | 描述 |
|---|---|---|
client.auth | AuthService | SIWE nonce + verify, dev-login |
client.orders | OrdersService | 提交，取消，列出，获取订单 |
client.markets | MarketsService | 列出市场 |
client.positions | PositionsService | 列出空缺职位 |
client.accounts | AccountsRestService | 注册+获取账号 |
client.sse | SSEService | 订阅实时事件通道 |
client.relay | RelayService | 无气中继：提交签名批，轮询其工作 |
其他出口
AuthService，AuthTokens-独立认证服务+令牌类型OrdersService-订单CRUDMarketsService-市场清单PositionsService，GatewayPosition(list/getOne返回:签署size，side由此衍生，realizedPnl,episodeRealizedPnl/episodeFeesUsd-当前头寸的价格PnL和费用；null当未知),PositionResponse（原线排）-位置AccountsRestService，RegisterAccountParams，RegisterAccountResponse-客户管理SSEService，SSEEventHandler- SSE订阅助手LiqApiError-类型API错误（状态码+错误码+正文）
安装
pnpm add @liq/api-client
依赖关系
@liq/core—共享类型和枚举up-fetch-使用基URL +拦截器的轻量级获取包装器
构建
moon run liq-api-client:build # tsup → dist/