Home

The Superfluid Protocol is a collection of Ethereum smart contracts for building a new type of rails for real-time finance.

Main Concepts

• Super agreement is the center piece of the protocol, a scalable design pattern for building real-time finance applications.
• Core contracts provide real-time finance capabilities to assets.
  • Super token registry provides a contract factory, access control and limited governance for the super tokens.
  • Super token upgrades ERC20 token with real-time finance capabilities.
• Scalable super agreement
  • Flow agreement transfers value from one account to another over time in constant rate
  • Indexed agreement
  • Investment agreement
• Application contract
  • Flow payment
  • Flow swap
  • Interest donation
• UX contract
  • Conciege

Open Discussions

• Discussion: Solvency Mechanism Proposals
• Discussion: Governance Emergency Power
• Discussion: Circuit Breaker
• Discussion: Security

Development Processes

Branch Policy

• Master branch is protected, and only pull request with reviewers and CI passing can be merged.
• Master branch only allows linear history, with rebase only and merging is not allowed.
• One should create new branch for new feature development and bug fixes, and they should always have a issue number in their name: FEATURE-10-token-downgrade or BUG-11-fix-amount-leakage.
• All PR branches will be automatically deleted after the PR is accepted.

Linting

solhint is used for linting solidity code.

eslint is used for linting JS code.

TODOs

• Token Downgrade
• SuperToken registry
• SuperToken storage layout review
• SuperToken access control and TokenRegistry.permit
• Solvency Mechanism
• Superfluid Conciege: enable auto-add feature
• Superfluid Conciege: enable auto-exchange feature