Chococoin / superfluid-protocol-preview

The preview version of superfluid protocol.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Superfluid Protocol (Preview)

Welcome to the preview version of the Superfluid protocol.

Ethereum Contracts

The ethereum contracts is published under the ethereum-contracts folder.

Currently the core logics are not yet published publicly, but they will be coming very soon!

How to Integrate

Install the SDK and its peer dependency:

$ npm install --save @superfluid-finance/ethereum-contracts
$ npm install --save @truffle/contract

To start with the SDK (with Goerli testnet):

const SuperfluidSDK = require("@superfluid-finance/ethereum-contracts");
const sf = new SuperfluidSDK.Framework({
    version: "preview-20200928", // This is for using different protocol release
    web3Provider: web3.currentProvider // your web3 provider
});

For more information about the SDK, read SDK Integration.

For more information about the protocol, please visit docs.

Example Integrations

Superfluid Console Demo

This demo show cases how to write a console only app using the superfluid SDK.

Flow Lottery - A Super App Demo

Flow lottery is a super app which showcases how to write a SuperApp that composes agreements into a fun money game.

Dividend Rights Token

A ERC20 token that tokenizes units in the Instant Distribution Agreements.

Further Readings

To read more about Superfluid Finance and our vision, please visit our website.

About

The preview version of superfluid protocol.


Languages

Language:JavaScript 75.7%Language:Solidity 22.6%Language:HTML 1.5%Language:Shell 0.1%Language:CSS 0.1%