SushiSwap SDK 集成

SushiSwap SDK 是一个围绕 SushiSwap API 构建的 TypeScript 封装层。 它为处理代币、价格、兑换报价（swap quote）以及交易生成等场景，提供了 强类型的基础组件 和实用工具。

该 SDK 不会替代 SushiSwap API —— 它是在 API 基础之上构建的、更安全且表达能力更强的抽象层。

安装

使用您偏好的包管理器安装所需依赖：

pnpm add sushi viem

npm add sushi viem

yarn add sushi viem

bun add sushi viem

使用方法

1. 从 sushi/evm 中导入所需的 SushiSwap SDK 工具函数
2. 根据用户意图选择正确的 SDK 方法：
   • 获取兑换报价 → getQuote()
   • 执行兑换交易 → getSwap()
3. 严格按 SDK 类型定义提供所有必需参数
4. 必须传入有效的 referrer 值
5. 在执行前验证输入参数（如 chainId、代币地址、金额、滑点容忍度等）
6. 直接使用 SDK 返回的交易数据进行模拟或上链执行，不得擅自修改结构

SDK 仅是对 SushiSwap REST API 的轻量级封装 —— 所有路由计算、价格计算及 calldata 生成仍由后端 API 完成。

支持的网络

SushiSwap SDK 通过以下方式暴露当前支持的兑换网络列表：

import { SWAP_API_SUPPORTED_CHAIN_IDS } from 'sushi/evm'

• Agent 及集成方在执行以下操作前，应始终检查该列表：
  • 获取兑换报价
  • 生成兑换交易数据
• 若请求的 chainId 不在该列表中：
  • Agent 必须提前失败（fail early），或提示用户选择受支持的网络
  • Agent 不得尝试猜测或硬编码支持的链列表

该列表反映的是 SushiSwap 聚合器 API 当前支持的网络。支持的网络可能随时间变化，不应长期缓存。

--

强制要求的 referrer 参数

• 调用 getQuote() 或 getSwap() 时，referrer 参数 必须显式指定
• Agent 或集成方 必须通过该字段标识自身身份
• 所有与兑换相关的 SDK 调用均不得在缺失 referrer 值的情况下执行
• SDK 不得代表集成方自动生成或省略该值

手续费定制

SushiSwap SDK 在调用 getQuote() 或 getSwap() 时支持自定义兑换手续费。

默认手续费模型

• 兑换相关请求默认采用 80/20 手续费分润模式
  • 80% 归集成方（即 referrer）
  • 20% 归 SushiSwap
• 除非 SushiSwap 显式覆盖，否则该分润比例始终生效

自定义手续费分润

• 如需采用其他分润比例，需与 SushiSwap 建立 合作关系
• Agent 与集成方不应假定自定义分润可用。若用户提出非标准分润需求，Agent 应引导其联系 SushiSwap 团队，而非自行修改请求参数。

补充参考

有关 SDK 的详细使用示例与执行流程，请参阅：

references/REFERENCE.md