This project aims to demonstrate the capabilities of Superfluid protocol. It contains a simple smart contract with one function (two in reality...) that use Superfluid CFA library and its Supertokens.
The contract's method(s) use the getFlowInfo to verify if a certain address, provided as an argument, has an active flow towards vitalik.eth. The difference between the two functions is that one uses ENS' on-chain name resolver to resolve vitalik.eth, while the other one is more generic and accepts an additional parameter.
Look at .env.example file, create a copy of it, named .env and fill in the empty variables. For this project, an Infura account was used, but any other RPC url would do.
To deploy the contract to Mumbai testnet, make sure to have enough funds and run the command:
npx hardhat run scripts/deploy.js --network mumbaiNote: if you want to deploy on a different network, modify hardhat.config.js by adding a new network configuration
To interact with the on-chain contract, try running these commands:
npx hardhat run scripts/checkNonExistingStream.js --network mumbai
npx hardhat run scripts/checkExistingStream.js --network mumbaiAnd play around with sender or vitalik addresses, if you want to verify a stream existence between different addresses.
A test has been written for this, but at the moment of writing this README, a library error prevents from executing them
This project contains a small frontend as well, written in Next.js and located in the lens-donator subfolder. For instructions regarding the frontend itself, see its README.