🏃Quickstart

Find what you need to getting off the ground quick with building on Superfluid

Money Streaming

The Constant Flow Agreement (CFA) allows for money streaming. Read this short explainer on how it works and then find the resources you need below!

Money Streaming with SDK Core

• Set Up: How to initialize our SDK Core to start conveniently accessing Superfluid functionality

• Functionality: See the functions that allow you to manage streams using the SDK Core.

• Simple Example: Very simple ReactJS examples showing how to allow a user to create, update, and delete their streams.

Money Streaming with Solidity

• Set Up: Set up your smart contract with the SuperTokenV1Library to easily manage money streams in Solidity.

• Functionality: See the basic stream management functions of the SuperTokenV1Library

• ACL: See how you can provide other addresses with the ability to create, update, and delete streams on your behalf

• Simple Example: "Money Router" smart contract example showing the very basics of coding stream management into a smart contract

• Video Tutorial: Tutorial demonstrating coding the Money Router contract

Testing With Money Streams

• Initializing: How to initialize our SDK Core for your Hardhat testing script to start conveniently accessing Superfluid functionality.

• Simple Example: Our "Tradeable Cashflow" example project Hardhat test script shows a lot of the basics.

Distributions

Instant Distributions

The Instant Distribution Agreement (IDA) allows for one-to-many instant distributions. Read this short explainer on how it works and then find the resources you need below!

Instant Distributions with SDK Core

You want to let users to manage their instant distribution indices from your frontend.

• Set Up: How to initialize our Javascript SDK (the SDK Core) for your frontend to start conveniently accessing Superfluid functionality
• Functionality: See the functions that allow you to manage streams using the SDK Core.
• Simple Example: Very simple ReactJS examples showing how to allow a user to create and manage an Instant Distribution Agreement Index.

Instant Distributions with Solidity

You want to create a smart contract that does instant distributions on its own.

• Set Up: Set up your smart contract with the Instant Distribution Agreement (IDA) library to easily start instant distributions in Solidity.
• Functionality: See the basic IDA management functions of the IDA Library
• Simple Example: "Token Spreader" smart contract example showing the very basics of coding IDA management into a smart contract
• Written Tutorial: Tutorial demonstrating coding the Token Spreader contract

Testing With Instant Distributions

You want to work with instant distributions in your test scripts.

• Set Up (Hardhat): How to initialize our SDK Core for your Hardhat testing script to start conveniently accessing Superfluid functionality.
• Functionality: See the functions that allow you to manage distributions using the SDK Core.
• Simple Example: Our "Token Spreader" example project Hardhat test script shows a lot of the basics.