This is the source code of the Sablier V1 token streaming protocol, which is a legacy release. The most recent release is V2 and can be found here. For more details about how Sablier works, check out our docs at docs.sablier.com/.
This repo is structured as a monorepo:
| Package | Description |
|---|---|
@sablier/dev-utils |
Dev utils to be shared across Sablier projects and packages |
@sablier/protocol |
The core token streaming protocol |
@sablier/shared-contracts |
Smart contracts to be shared across Sablier projects and packages |
To compile the smart contracts, bootstrap the monorepo and open the package you'd like to work on. For example, here are the instructions for @sablier/protocol:
$ yarn run bootstrap
$ cd packages/protocol
$ truffle compile --all
$ truffle migrate --reset --network developmentAlternatively, if you simply want to use the UI, head to v1-pay.sablier.com to create streams and v1-app.sablier.com to withdraw from streams. You'll need an Ethereum wallet and some ERC20 tokens.
Participation from the community is crucial for shaping the future development of Sablier. If you are interested in contributing or have any questions, ping us on Discord.
We use Yarn as a dependency manager and Truffle as a development environment for compiling, testing, and deploying our contracts. The contracts were written in Solidity.
- yarn >=1.17.3
- truffle >= 5.0.35
- solidity 0.5.17
Make sure you are using Yarn >=1.17.3.
$ npm install --global yarnThen, install dependencies:
$ yarn installTo re-build all packages on change:
$ yarn watchTo clean all packages:
$ yarn cleanTo clean a specific package:
$ PKG=@sablier/protocol yarn cleanTo lint all packages:
$ yarn lintTo lint a specific package:
$ PKG=@sablier/protocol yarn lintTo run prettier on all packages:
$ yarn prettierPrettier cannot be run on individual packages.
To run all tests:
$ yarn testTo run tests in a specific package:
$ PKG=@sablier/protocol yarn test