Superfluid Protocol

🌊 实时资金流的完整开发手册

Superfluid 协议官方技术知识库,提供智能合约 ABI、SDK 集成指南与实时资金流的完整开发文档,适合构建可编程现金流 dApp。

收藏
5k
安装
1k
版本
1.1.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

Superfluid Protocol Skill 是面向开发者的综合性技术知识库,覆盖智能合约开发、前端/后端集成及脚本工具三大开发轨道。

智能合约开发:基于 SuperTokenV1Library 构建 Solidity 集成,使用 CFASuperAppBase 处理回调,通过 MacroForwarder 执行原子批处理操作。核心架构包含 Host(中央路由)、Agreements(CFA 1:1 流、GDA 多对多池、已弃用 IDA)、Super Token(ERC-20/777/2612 实时余额)三大组件。

应用开发:使用 @sfpro/sdk 获取 ABI、wagmi hooks 和地址,配合 Subgraphs 和 API 服务查询协议数据。推荐 RPC 调用获取实时余额,Subgraphs 专用于历史查询和事件索引。

脚本工具:通过 bunx 运行 metadata.mjsbalance.mjs 等脚本快速查询地址、余额和流率,适合一次性调查和调试。

显著优点

  • 完整文档覆盖:Rich ABI YAML 详细记录每个函数的输入输出、事件、错误及关键 notes 字段,标注非明显行为和常见陷阱
  • 实时资金流动态realtimeBalanceOfNow 支持真正的实时余额计算,区别于传统区块更新模型
  • GDA O(1) 可扩展性:General Distribution Agreement 通过 PDPool 数学实现向无限接收者的恒定成本分配
  • 成熟的 SDK 生态@sfpro/sdk 统一替换多个旧 SDK,提供 wagmi/viem 兼容的现代化开发体验
  • 自动化基础设施:Vesting Scheduler、Flow Scheduler、Auto-Wrap 支持链上意图调度,配合链下 keeper 执行

潜在缺点与局限性

  • 学习曲线陡峭:协议概念密集(流、押金、临界状态、app credit、GDA 连接池等),notes 字段中的细节对新手不友好
  • Gas 成本敏感:GDA 连接池限制 256 个/账户/代币,超出需手动 claimAllbalanceOf 随连接数线性增长
  • Solidity 测试陷阱SuperTokenV1Library 隐式使用 address(this) 而非 msg.sender,Foundry vm.prank 无效,需用显式 sender 重载
  • App Credit 不对称:仅 CFA 支持 app credit,GDA 无此机制,CFA→GDA 分流合约常因押金不足失败
  • 生态系统集中:SUP 代币和核心治理集中在 Base 链,跨链部署成熟度不均

适合人群

  • DeFi 协议开发者:需要构建流式支付、实时薪资、订阅或 vesting 合约的团队
  • Web3 前端工程师:使用 React/Vue/Svelte 实现实时流动余额动画显示
  • DAO 财库管理:需要程序化、透明的持续资金释放机制
  • 研究者和审计师:深入理解 Semantic Money 形式化规范和 GDA 数学证明

常规风险

  • 临界清算风险:余额为负(critical)账户可被 sentinel 清算,需监控 realtimeBalanceOfNowavailableBalance
  • GDA 舍入偏差distributeFlow 的整除余数流向池管理员,小流率/大单元数场景下接收者可能获得 0 流
  • 升级金额单位混淆upgrade/downgrade 始终使用 18 位小数,仅 approve 需用底层代币精度
  • 自动化依赖链下 keeper:Vesting/Flow Scheduler 需 allowlisting 和活跃 keeper,否则意图不会执行
  • 合约组合限制CFASuperAppBase 固定为 APP_LEVEL_FINAL,无法调用下游 Super App,需自定义 APP_LEVEL_SECOND 实现

安全提示

  • 硬编码地址仅接受 Forwarder 地址(CFA/GDA Forwarder 跨网络统一),Host 和 Agreement 地址必须从 @superfluid-finance/metadata 动态获取
  • balanceOf 钳制零值,负余额检测必须使用 realtimeBalanceOfNow
  • FluidLocker 即时解锁收取 80% 惩罚 + 0.0001 ETH 费用,需提前规划解锁策略

Superfluid Protocol 内容

references文件夹
contracts文件夹
deep-researches文件夹
guides文件夹
subgraphs文件夹
scripts文件夹
手动下载zip · 252.6 kB
_rich-abi-yaml-format.mdtext/markdown
请选择文件