Sablier is maintained as a monorepo with multiple sub packages. Please find a comprehensive list below.
||Sablier solidity smart contracts & tests|
||Dev utils to be shared across Sablier projects and packages|
This is a dApp, so if you just want to use it, you should head to the production-ready version at sablier.app!
However, if you want to run it locally:
$ cd packages/frontend $ yarn install
If you want to test Sablier on Rinkeby, make sure to create a
.env file and mirror the contents of
.env.example. In that file, you can also include any other variables and they will be set in
$ yarn run start
You will also need some testnet DAI, which you can get by calling the
mint method of this contract.
For all other commands, check out the contribution guide below.
We highly encourage participation from the community to help shape the development of Sablier. If you are interested in contributing or have any questions, please ping us on Twitter.
- yarn >=1.15.2
- truffle >= 5.0.19
- solidity >=0.5.0 <0.6.0
Make sure you are using Yarn >=1.15.2. To install using homebrew:
$ brew install yarn
Then install dependencies:
$ yarn install
To re-build all packages on change:
$ yarn watch
To clean all packages:
$ yarn clean
To clean a specific package:
$ PKG=@sablier/contracts yarn clean
To lint all packages:
$ yarn lint
To lint a specific package:
$ PKG=@sablier/contracts yarn lint
To run all tests:
$ yarn test
To run tests in a specific package:
$ PKG=@sablier/contracts yarn test