Documentation for how to use Sablier, the protocol for real-time finance on the Ethereum blockchain.
This is a technical account on how to integrate Sablier into your own application. If you have questions, please join the #development channel in the Sablier Discord server; our team, and members of the community, look forward to helping you.
What we will cover:
Smart contract architecture and ABI.
Networks and typical gas costs.
How to create, withdraw from and cancel streams.
If you're looking for a high-level overview, you may want to read the FAQ first.
The Sablier protocol codebase is hosted on GitHub and the source code for each contract is verified on Etherscan.
Depending on what web3 library you're using, you may need to get hold of the Sablier ABI (Application Binary Interface). The ABI acts as an interface between two program modules, one of which is the smart contract and the other the machine code.
The Sablier.json artifact should be generated in the relative build/contracts folder.
Depending on what Ethereum network you want to use Sablier with, you will need a different contract address. Sablier runs on top of one single master contract that manages all streams.
If you want to use the Sablier interfaces on a testnet, you need to get some testnet DAI first. To do this, you have to go to the Etherscan page of the associated token, tap the "Write Contract" tab, connect your Ethereum wallet and call the mint method. Note that the token has 18 decimals, so you may want to use a unit converter.
The gas usage of the Sablier protocol is not deterministic and varies by user. Calls to third-party contracts, such as ERC-20 tokens, may use an arbitrary amount of gas. We provide the table below for guidance:
Typical Gas Cost
Withdraw from Stream
Our blockchain data can be accessed via our subgraphs, which you interact with via a GraphQL client. We recommend Apollo.