cp0x-org/turbine-api-docs
GitHub: cp0x-org/turbine-api-docs
一份社区维护的 Turbine Alpha HTTP API 参考文档,帮助开发者与集成方快速理解私有 API 结构。
Stars: 1 | Forks: 0
# turbine-api-docs
由 **[PropellerHeads](https://propellerheads.xyz)** 维护的社区参考文档,适用于 **Turbine Alpha** HTTP API。
## 面向 AI 代理 / LLM
- **[llms.txt](llms.txt)** — 本仓库遵循
[llmstxt.org](https://llmstxt.org) 规范。提供每一页的机器可读索引及一句话描述。将此文件指向你的工具以发现其余内容。
- **[llms-full.txt](llms-full.txt)** — 全部文档合并为单个纯文本文件(约 1900 行),适合整体加载到 LLM 上下文窗口。
- **[examples/minimal_client.py](examples/minimal_client.py)** — 可直接复制作为起点的自包含 Python 参考实现。
## 存在的意义
PropellerHeads 以私有测试版 Alpha 形式发布 Turbine,前端位于 `app.turbine.exchange` 且未提供公共 SDK 文档。如果你是开发者、做市商、AI 代理或集成方,希望在不自行推导 API 结构的情况下理解其形态,本仓库可为你节省数小时时间。
## 内容包含
- **[docs/overview.md](docs/overview.md)** — Turbine 是什么、执行器是谁、结算在哪里发生
- **[docs/authentication.md](docs/authentication.md)** — SIWE 流程(`/nonce` → `personal_sign` → `/verify`)与 Cookie 会话
- **[docs/api-reference.md](docs/api-reference.md)** — 所有端点及载荷:`/config`、`/status`、`/nonce`、`/verify`、`/me`、`/logout`、`/add_order`、`/add_orders`、`/cancel_order`、`/order_states`、`/order_fees`、`/add_liquidity`、`/remove_liquidity`、`/liquidity_intent_states`
- **[docs/orders.md](docs/orders.md)** — `OrderIntent` 字段语义、`midPriceDelta` bps 含义、部分填充、过期、盐值、最小订单量
- **[docs/permit2.md](docs/permit2.md)** — 链上 ERC-20 授权、`PermitSingle` EIP-712 类型化数据签名、非一旦语义、结算器作为花费者
- **[docs/wire-format.md](docs/wire-format.md)** — 非显而易见的细节:十六进制前缀大整数序列化、`/verify` 与 `/add_order` 之间 `yParity` 布尔值与字符串的差异、`status` 枚举取值、大整数表示选择
- **[docs/fees.md](docs/fees.md)** — **平台费率、如何计算及其与价差的关系**
- **[examples/minimal_client.py](examples/minimal_client.py)** — 自包含的 Python 参考客户端
## 快速参考(一页摘要)
- **基础 URL:**`https://api.turbine.exchange/api`
- **链:**以太坊主网(chainId 1)
- **认证:**SIWE `personal_sign`,会话存储在 HTTP Cookie 中
- **订单:**仅通过 Permit2 `PermitSingle` 签名(`OrderIntent` 自身 **不** 使用 EIP-712 签名)
- **最小订单规模:****30 美元**(服务端强制校验,违反返回 HTTP 400 `INPUT_VALIDATION_ERROR`)
- **平台费率:**约 **0.99 bps**(0.0099%),按中间价名义值计算,与买卖方向及价差无关 — 详见 [docs/fees.md](docs/fees.md)
- **大整数线格式:**响应中使用 `0x` 前缀的十六进制字符串;输入同时接受十进制与十六进制
- **轮询:**`/order_states` 是主要填充来源;官方 JS SDK 每 6 轮询一次并带有客户端并发锁
- **实际可见的状态枚举值:**`"Active"`(TitleCase)表示挂单;其他值已推断但尚未验证
## 已知合约地址(以太坊主网,2026-04-13)
| 角色 | 地址 |
|------|------|
| Turbine Settler | `0x49e9a8ea9b6c05d5b2307538d159350a5aea73ac` |
| Turbine Signer(支付 Gas 的执行器) | `0x89c740fea6bd1df86d0f8dff3f4c4c23cb598890` |
| LP Hook | `0x40bd6d8c59d43f6c345d79b17234d9b0e781a088` |
| LP Router | `0x4bd3f2ffc321f3ba4c3b31708212b76922f805a2` |
| Uniswap v4 Pool Manager | `0x000000000004444c5dc75cb358380d2e3de08a90` |
| Permit2(标准 Uniswap) | `0x000000000022D473030F116dDEE9F6B43aC78BA3` |
**请固定这些值。** 每次启动时,`/api/config` 接口会返回它们;请与上述固定值比对。不匹配意味着 API / 部署已变更,你的客户端应立即停止。
## 支持的代币
SDK 常量内置以下代币:USDC、USDT、DAI、UNI、WETH、WEETH、PEPE、WBTC。`app.turbine.exchange` 前端在撰写时仅展示 USDC / WETH,但 SDK 与服务端接受任何已注册代币对。
## 准确性与贡献
所有内容均通过向生产环境的 Turbine 发送真实(或仅查询)请求于 2026-04-13 验证。如发现变更或错误,请提交 Issue 或 PR —
[CONTRIBUTING.md](CONTRIBUTING.md) 提供了流程说明。
## 许可证
[CC-BY-4.0](LICENSE)。可自由分享与改编,但需保留署名。复制实质性内容时请反向链接至本仓库。
## 商标
"Turbine"、"PropellerHeads"、"Tycho"、"Fynd" 属于 PropellerHeads 商标。本项目 **不** 与 PropellerHeads 关联、背书或赞助。仅作描述性使用。
标签:AI 集成, API 文档, Cookie 会话, HTTP API, llms.txt, PropellerHeads, Python 示例, Python脚本, SIWE, Turbine Alpha, Web API, 交易所接口, 交易执行, 关键词, 前端集成, 区块链, 市场制造, 开发者文档, 撮合结算, 文档参考, 机器学习代理, 检索优化, 流动性管理, 社区维护, 签名验证, 订单管理, 认证, 逆向工具, 链上交易, 防御加固