@ agg- building/ sdk

Vanilla 类型脚本客户端 恶作剧 预测市场聚合物—— 一个客户端,每个表面(自动,市场,订单,图表,交易,管理下的执行, 腾讯网.

这是什么

@agg-build/sdk 是安装最低级别的软件包伙伴。 它通过HTTPS和AGG API说话 WebSockets, 管理认证/ 会话状态, 并曝光每个产品端点的打入包装 (市场、订货簿、图表、贸易执行、存款/提款、管理下的钱包、 ,(增加). 它没有框架依赖性,在浏览器,Node.js和React Introduct中工作.

反应应用程序, 层 @agg-build/hooks, (中文(简体) ), @agg-build/ui,以及 @agg-build/auth 在顶端,他们都使用这个客户端 在引擎盖下.

何时使用此软件包

• 您正在构建一个 vanilla TS/JS app, React Industrial app, 或服务器侧整合 .
• 您要为 AGG REST API 和 WebSocket 网关输入一个已输入的、包含电池的客户端 .
• 您正在自编自导出反应层, 并需要基本的 认证/ 部分/ 交易原始 .
• 您需要只使用服务器的助手: SSR 配置取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取取, 或管理员 API 客户端(参见 @agg-build/sdk/server) (中文(简体) ).

如果您正在运送一个 React app 并且想要现成的钩子或 UI, 请安装 @agg-build/hooks, (中文(简体) ), @agg-build/ui,以及 @agg-build/auth 相反,这些软件包是建立在 @agg-build/sdk。 。 。 .

安装

npm install @agg-build/sdk

快开始

import { createAggClient } from "@agg-build/sdk";

const client = createAggClient({
  baseUrl: "https://api.agg.market",
  appId: "your-app-id",
});

// Health check
const hello = await client.getHello();

// Current auth state (persisted across reloads via localStorage)
console.log(client.isAuthenticated, client.user);

认证一个用户( SIWE)

// 1. Start the auth flow
const { nonce } = await client.authStart({ provider: "siwe" });

// 2. Build the EIP-4361 message
const message = client.buildSiweMessage({
  address: "0x…",
  chainId: 1,
  nonce,
  domain: window.location.host,
  uri: window.location.origin,
});

// 3. Sign with the user's wallet (wagmi, viem, ethers, …)
const signature = await wallet.signMessage(message);

// 4. Verify → stores accessToken + user in the client
const { accessToken, user } = await client.verify({ message, signature });

SIWS (索拉纳语) 使用相同的流量 buildSiwsMessage 以及一个基数58编码的Ed25519签名.

重定向流(Google,苹果,Twitter,电子邮件magic-link)返回一个URL来导航:

const response = await client.authStart({
  provider: "google",
  redirectUrl: "https://yourapp.com/auth/callback",
});

if (response.type === "redirect") {
  window.location.assign(response.url);
}

// …back on the callback page:
const code = new URLSearchParams(window.location.search).get("code");
if (code) {
  await client.exchangeAuthCode(code);
  window.history.replaceState(null, "", window.location.pathname);
}

Http 纯饼干- 新鲜模式

对于选择一个的浏览器应用程序 HttpOnly 刷新饼干 存储刷新标志 在JS, 用 authDelivery: "cookie-refresh"数字 :

const client = createAggClient({
  baseUrl: "https://api.agg.market",
  appId: "your-app-id",
  authDelivery: "cookie-refresh",
});

在这个模式下, verify() 财务报告和审定财务报表 exchangeAuthCode() 可省略 refreshToken 从返回 对象。 刷新饼干仍保留在 AGG API 主机下 /auth 从未接触过 伙伴前端域.

流取数据( WebSocket)

const ws = client.createWebSocket({
  onSnapshot: (outcomeId, book) => console.log("snapshot", outcomeId, book),
  onDelta: (outcomeId, book) => console.log("delta", outcomeId, book),
  onTrade: (trade) => console.log("trade", trade.venue, trade.price, trade.size),
});

// Orderbooks are keyed by venueMarketOutcomeId (the `outcomes[].id` on REST).
const unsubscribe = ws.subscribe("venue-market-outcome-id");

// Optional: authenticate for user-scoped events (orders, balances)
ws.authenticate(accessToken);

// Cleanup
unsubscribe();
ws.destroy();

createWebSocket 需求 wsUrl 改为: createAggClient基础 AggWebSocket 如果想要更好的控制,也可以直接被即时处理.

服务器侧助手

从 /server 仅限节点公用事业的入口:

import { AggAdminClient, signExternalId, verifyWebhook } from "@agg-build/sdk/server";

// Sign a partner external-ID assertion before sending to the browser
const assertion = signExternalId(process.env.AGG_APP_SECRET!, partnerUser.id);

// Verify an inbound webhook
verifyWebhook(rawBody, req.headers, process.env.AGG_WEBHOOK_SECRET!);

// Admin API client (uses x-app-api-key)
const admin = new AggAdminClient({
  baseUrl: "https://api.agg.market",
  apiKey: process.env.AGG_APP_API_KEY!,
});
const users = await admin.listUsers("your-app-id", { limit: 50 });

客户选项

打电话 client.destroy() 当你不再需要客户端释放内部资源时 (BroadcastChannel用于跨tab auth同步).

主要出口

AggClient 方法

认证会话( S)

用户配置文件账户( A)

市场数据

相关市场

订单和路由

图表数据

贸易

地点键

管理执行和结余

要引出并填补一个管理下的交易, 瞄准一个场地市场 结果. 采购预算与 maxSpend; 销售指定与 sellShares。通过返回 quoteId 改为 executeManaged()数字 :

const buyRoute = await client.getSmartRoute({
  venueMarketOutcomeId,
  tradeSide: "buy",
  maxSpend: 50,
});
await client.executeManaged({ quoteId: buyRoute.quoteId });

const sellRoute = await client.getSmartRoute({
  venueMarketOutcomeId,
  tradeSide: "sell",
  sellShares: 10,
});
await client.executeManaged({ quoteId: sellRoute.quoteId });

venueMarketId, (中文(简体) ), outcomeId,以及 side: "yes" | "no" 仍为已贬值的相容性别名; 应使用新的整合 venueMarketOutcomeId 财务报告和审定财务报表 tradeSide。 。 。 .

在v4中被删除. quoteManaged() ——其终点, POST /execution/quote,在API上并不存在,所以这个电话只有 返回 404号。 取上取出两相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相.

命令和职位

领导板

公用事业

独立公用事业

处理错误

每一个非-2xx 反应被扔作为一个 AggApiError 携带 status,并且 -- 当API供给他们的时候—— code, (中文(简体) ), retryable 和每个外地 errors部门 打开 status编号 :code 而不是匹配消息文本; 消息是人为的 并可能被重新措辞.

import { isAggApiError } from "@agg-build/sdk";

try {
  await client.getPositions();
} catch (err) {
  if (isAggApiError(err)) {
    if (err.status === 401) return promptReconnect(); // session lapsed
    if (err.code === "unregistered_domain") {
      // The signed SIWE `domain` is not in the app's allowedOrigins.
      // Note this is NOT the Origin header — sign-in works with no Origin
      // at all, which is what makes Node and React Native work.
    }
  }
  throw err;
}

@agg-build/sdk/server

WebSocket 回调

命令书按结果键. OrderbookState.outcomeId 是一个 书;被贬损 OrderbookState.marketId 持有同样的结果id, 没有 地点 市场编号,因为订货簿框架没有市场编号。 使用 REST 软件 venueMarketId (例如来自 getOutcomeOrderbooks或你自己的结果 / 当你需要市场绘图时 市场.

关键行为 :

• 与每个市场重新计算的订阅单项持续连接. orderbookUrl 将命令簿频道移动到第二个套接字上并报告 onOrderbookConnectionStateChange。只订阅订单不保留 wsUrl 连接。 交易、arb、目录和用户活动保持不变 wsUrl。 。 。 .
• 每集市内订单状态(snapshot + delta并有CRC32核查).
• 序列间隙或校验和错配会触发自动回放.
• snapshot_unavailable 复试只影响活性结果,每套最多有3个紧张的复试,最多每套每秒再试20个结果。 仍然到达错误 onError; 成功快照、 未订阅和套接字关闭将取消等待重试 。 缺少的答复仍由可选书监督员负责.
• 以指数回放自动重联(基数1s,最大为30s).
• 活性:45s没有消息触发重接;服务器心跳每30s.
• 投标总是排序 降级,问总是排序 升级.

自动附加信头

• x-app-id ——从 appId 选项
• Authorization: Bearer <jwt> - 注册后
• x-admin-key 如果 adminKey 提供
• x-auth-delivery: cookie-refresh + 键 credentials: "include" 只有认证的请求 authDelivery: "cookie-refresh" 已启用

入境点

同伴依赖关系

无——至于v4,也没有运行时间依赖关系. 捆绑的唯一模块 进口为 node:crypto (使用时间: @agg-build/sdk/server因此,一个新的安装是 1 MB以下,无中转.

带上你的钱包库 SDK 构建 SIWE/ SIWS 消息串, 绝不 签名本身,所以 viem, (中文(简体) ), ethers,或者任何其他签名者的工作——你通过 在一个 signMessage 函数.

在v4中有所改变. 先前版本已声明 viem, (中文(简体) ), ethers@5, (中文(简体) ), @polymarket/clob-client 财务报告和审定财务报表 @polymarket/builder-signing-sdk 作为运行时间 依赖性。 从未导入过代码路径, 但安装者仍在付费 - 大约100 MB的 node_modules 穿过他们的中转树 他们 在v4中被删除; SDK的行为没有任何改变.

链接

• 文 件 - 存档副本 https://docs.agg.market/ 互联网档案馆的存檔,存档日期2013-12-02
• Demo app - 软件 https://agg.market/ (中文(简体) )
• 反应钩- @agg-build/hooks
• 贸易UI - @agg-build/ui
• 连接/ 登录 UX —— @agg-build/auth

许可证

麻省理工学院

地点活动读取录取

getVenueEventById 共享同时在每一个客户端内读取和认证 届会(包括常会) cluster 财务报告和审定财务报表 minVolume 查询值). 它保留 没有完成结果缓存。 最多四个不同的活动同时进行; 最多128 等待FIFO顺序。 全队拒绝方式 AggApiError 状态429, 代码 client_read_queue_full,并重试延迟提示.

一个服务器429仍然拒绝原调用,而没有自动重试. 新员额 已队列事件读取其荣誉 Retry-After 延迟加最多250ms正焦; 缺少提示使用一秒钟。 呼叫者可以独立取消; 共享抓取 只有在所有来电者离开后才取消。 队列读取拒绝 AbortError 如果在录取前认证更改. destroy() 取消待读 . 其他读取方法和写取方法保留了现有的再试行为.