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 - the center piece of the protocol, a scalable design pattern for building real-time finance applications.
• Core Contracts
  • Super Token Registry -
  • Super Token - Upgrade ERC20 token with realtime finance capabilities.
• Agreement Contracts
  • Flow Agreement
  • Indexed Agreement
  • Investment Agreement
• Application Contracts
  • Flow Payment
  • Flow Swap
• UX Contract
  • Conciege

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.

Lint

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