@superfluid-finance/js-sdk

Search…
📦
Using the Superfluid JS-SDK - the Precursor to the SDK-Core
IMPORTANT NOTE
The JS-SDK is a legacy SDK which is no longer being actively maintained. We strongly recommend that new developers use the SDK-Core or SDK-Redux.****
Overview
Use @superfluid-finance/js-sdk with goerli testnet
Obtain Super Tokens
Check Super Token balances
Set up
The js-sdk can be used with both web3.js and ethers. A peer dependency for contract loading is required, so make sure to include it when you install the SDK!
ethers
web3
1
yarn add @superfluid-finance/js-sdk @ethersproject/contracts
Copied!
1
yarn add @superfluid-finance/js-sdk @truffle/contract
Copied!
Now in our application, we can create the SuperfluidSDK object and initialize.
ethers
web3
1
const SuperfluidSDK = require("@superfluid-finance/js-sdk");
2
const { Web3Provider } = require("@ethersproject/providers");
3
​
4
const sf = new SuperfluidSDK.Framework({
5
    ethers: new Web3Provider(window.ethereum)
6
});
7
await sf.initialize()
Copied!
1
const SuperfluidSDK = require("@superfluid-finance/js-sdk");
2
const Web3 = require("web3");
3
​
4
const sf = new SuperfluidSDK.Framework({
5
    web3: new Web3(window.ethereum),
6
});
7
await sf.initialize()
Copied!
By default, the SDK will load Version 1 of the contracts, for whichever network the wallet is connected to. See 🔗 Network Directory for the full list of contract addresses.
Create a User
Now let's make a request to unlock our ethereum wallet and create a User object.
1
const walletAddress = await window.ethereum.request({
2
  method: 'eth_requestAccounts',
3
  params: [
4
    {
5
      eth_accounts: {}
6
    }
7
  ]
8
});
9
    
10
const carol = sf.user({
11
    address: walletAddress[0],
12
    token: '0xF2d68898557cCb2Cf4C10c3Ef2B034b2a69DAD00'
13
});
Copied!
You'll notice we passed a token address when we created the User. Over in 🔗 Network Directory we can see this is the fDAIx token, which is a test Super Token on Goerli network.
What's a Super Token? It's just a "wrapped" or upgraded ERC20 token. This is what enables the cool super-powers like streaming, batch calls, and more.
After upgrading an ERC20 to Super Token, it will have a new token address. To denote this, we just append "x" to the token symbol. Since the fDAI in our example is named "Fake DAI", it now becomes "Super Fake DAI"... pretty funny name right?
Now let's inspect our user, to see if they are interacting with the fDAIx token.
1
const details = await carol.details();
2
console.log(details);
3
​
4
// {
5
//    cfa: {
6
//         flows: { ... }
7
//         netFlow: "0"
8
//   ...
9
// }
Copied!
In this example Carol has no flows of fDAIx, since her netFlow is 0. Let's get some tokens so we can start flowing! 🏄♂
​
Test Tokens
Head to app.superfluid.finance. During log-in you'll be prompted to receive some goerli ETH and test tokens. Once you receive these normal ERC20 tokens, we need to upgrade them to **Super Tokens. **Open the Currencies tab and click the "+" Upgrade button.
If you're using the fDAIx token as shown in this guide, the you need to upgrade your DAI (token symbols don't always match exactly on testnet).
You'll be prompted to "Allow Superfluid to spend your DAI". Then you'll call the upgrade function, which will take the DAI token from your wallet, and send back the same amount of DAIx. Use the handy "Add to Metamask" button to see DAIx in your wallet.
Start a Flow
Now that you have some tokens, let's start streaming them. Use a different wallet adddress for the recipient (you cannot flow to yourself), and set **flowRate **to 385802469135802 tokens per second. This flow rate is equivalent to 1000 tokens per month, for a token with 18 decimals.
1
await carol.flow({
2
    recipient: '0xA8f3447922d786045CB582B0C825723B744a54df',
3
    flowRate: '385802469135802'
4
});
5
​
6
const details = await carol.details();
7
console.log(details);
8
​
9
// {
10
//    cfa: {
11
//         flows: { ... }
12
//         netFlow: "-385802469135802"
13
//   ...
14
// }
Copied!
**🎉 Excellent work, you just started your first Superfluid Flow! **Carol now has a negative **netFlow **which means she is sending tokens out from her wallet.
We can call it again to change the flow rate, or stop it by passing a 0 flowRate:
1
await carol.flow({
2
  recipient: '0xA8f3447922d786045CB582B0C825723B744a54df',
3
  flowRate: '1000000000000000' // 2592 DAIx per month
4
});
5
​
6
await carol.flow({
7
  recipient: '0xA8f3447922d786045CB582B0C825723B744a54df',
8
  flowRate: '0' 
9
});
Copied!
You just used a Superfluid Agreement to create a flow. Let's dive a bit more into what an agreement actually is.
Resources - Previous
Archived Tutorials / Docs
Money Streaming with JS-SDK
Last modified 1mo ago
Copy link
Contents