资助申请 - 框架无关的 CoW SDK
摘要
AI 生成本提案由 bleu 团队提交,旨在对 CoW 协议 SDK 进行全面重构,从依赖 Ethers.js v5 升级为支持 Ethers.js v6、Viem 和 Wagmi 的框架无关架构。项目为期6周,分为SDK重构、适配器集成与部署文档三个阶段,申请15k xDAI和10k COW(归属一年)的资助,以提升协议的可组合性和开发者体验。
注:摘要由 AI 自动生成,可能与正文存在差异,仅供参考。
提案内容
AI 翻译作者:
@bleu @yvesfracari @ribeirojose @mendesfabio
经验与资质:
bleu 作为 Web3 技术和用户体验合作伙伴,与多 家公司和 DAO 合作。我们与 CoW Swap 及其他团队合作开发了多个资助项目。与本项目更相关的项目包括:
- [CoW] Hook dApps: 一套集成在 CoW Swap 前端上的 Hook dApp。在此项目期间,我们开发了
@cowprotocol/cow-sdk的cow-shed模块。该模块旨在帮助开发者使用 CoW Shed 来创建权限化钩子。 - [CoW] Python SDK (等待审核): 我们正在帮助 CoW 整合一个 Python 版本的 cow TS SDK,为开发者提供查询链上数据、管理订单以及与 CoW 协议智能 合约集成的功能。这使团队对 CoW 的所有 TS 包有了深入的了解。
- [Pike] Pike SDK (进行中): 除了与 CoW 的合作,我们也开始为即将推出的借贷协议 Pike 创建一个 SDK。该项目 处于初期阶段,但 SDK 的设计遵循了与本提案相同的框架无关性原则。
资助描述:
类别:核心基础设施与开发者工具
如本 RFP 所述,CoW 协议生态系统目前严重依赖 Ethers.js v5 进行区块链交互。本资助提案不仅旨在升级到 Ethers.js v6,还旨在从根本上重 构 SDK 架构,使其通过 EVM 适配器与框架无关的基础包更具可组合性。我们提出一项全面的改革,包括:
- 扩展范围以实现 EVM 独立性: 除了核心 SDK,我们还将现代化
app-data和contracts包,确保基础包与框架无关。这意味着我们将移除当前业务逻辑对 ethers v5 的依赖。 - 多适配器支持: 我们将为以下框架开发独立的适配器包:
- Ethers.js v5 (用于向后兼容)
- Ethers.js v6
- Viem
- Wagmi
- 模块化包架构: SDK 将被重构为更小、模块化的包,开发者可以根据具体需求安装,以简化依赖管理。
此架构的演示及部分方法实现可在此处找到。
其影响超越了单纯的技术升级——它将通过允许开发者使用他们偏好的工具和框架集成协议,从而促进 CoW 协议的更广泛采用。
资助类型:
基于里程碑的资助。
里程碑:
| 里程碑 | 持续时间 | 付款 (15k xDAI + 10k COW 归属) |
|---|---|---|
| SDK 重构 | 2 周 | 5k xDAI |
| 新适配器与 CoWSwap 集成 | 2 周 | 5k xDAI |
| 部署与文档 | 2 周 | 5k xDAI |
SDK 重构 (2 周)
此里程碑侧重于在保持 ethers v5 的同时重构 SDK 包。我们将实现一个模块化包系统,将可重用逻辑与区块链交互分离。工作将基于此演示结构继续,实现适当的工具,并确保所有现有功能在新架构中正常工作(包括测试复制)。此里程碑包括将 app-data 和 contracts 包重构为新结构,为未来的适配器实现奠定基础。考虑到演示结构,我们希望在此里程碑交付以下包:
cow-order-bookcow-app-datacow-tradingcow-abi(包含部分合约逻辑)cow-shedcow-composablecow-common(包含部分合约逻辑)cow-configcow-order-bookcow-subgraphcow-tscow-order-signingcow-sdk(导出所有其他包)cow-sdk-ethers-v5(包含部分合约逻辑)
新适配器与 Cowswap 集成 (2 周)
第二个里程碑的核心是创建 viem、ethers v6 和 wagmi 适配器,并将选定的适配器集成到 CoW Swap 应用程序中。我们将为新适配器实施全面测试,并更新所有 CoWSwap 相关项目(包括 explorer 和其他子项目)以使用新的 SDK 架构。这将包括:
cow-sdk-ethers-v6cow-sdk-viemcow-sdk-wagmi
部署与文档 (2 周)
此里程碑以完全文档化、经过测试且支持所有三个适配器的生产就绪系统结束。我们将更新现有的 SDK 文档 以涵盖新包(核心、适配器等),并为现有用户提供详尽的迁移指南。
此阶段包括为每个适配器创建集成示例,在所有支持的库中实施端到端测试,并为整个系统的生产部署做好准备。此阶段还将包括更新 Learn 网站 上的教程。
时长:
预计开始日期:2025 年 4 月至 5 月间
预计结束日期:开始日期后 6 周
资金请求:
我们建议在每个里程碑获得批准后支付里程碑款项。预算包括执行期间开发人员的时薪以及按需安排的项目经理费用。预算的 xDAI 部分应在每个里程碑完成后支付(每个里程碑 5k xDAI,总计 15k xDAI),10k COW 应在 1 年内归属,以覆盖同期稀释的维护及相关成本。
Gnosis Chain 地址 (用于接收资助):
0x554866e3654E8485928334e7F91B5AfC37D18e04
其他信息:
- 所有代码将从第 0 天起开源。我们也欢迎在 PR 期间提供反馈;
- 我们乐意回答任何问题,并欢迎对此提案提出反馈;
条款与条件:
通过提交此资助申请,我确认并同意受 CoW DAO 参与协议 和 CoW DAO 资助协议条款 的约束。