Repository files navigation

This is the source code of the Sablier Legacy protocol, which has been superseded bySablier Lockup. For more details about how Sablier works, check out our docs atdocs.sablier.com.

This repo is structured as a monorepo:

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 development

Alternatively, if you simply want to use the UI, head tolegacy-recipient.sablier.com to withdraw from streams.

Participation from the community is crucial for shaping the future development of Sablier. If you are interested incontributing or have any questions, ping us onDiscord.

We useYarn as a dependency manager andTruffleas a development environment for compiling, testing, and deploying our contracts. The contracts were written inSolidity.

• yarn >=1.17.3
• truffle >= 5.0.35
• solidity 0.5.17

Make sure you are using Yarn >=1.17.3.

$ npm install --global 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/protocol yarn clean

To lint all packages:

$ yarn lint

To lint a specific package:

$ PKG=@sablier/protocol yarn lint

To run prettier on all packages:

$ yarn prettier

Prettier cannot be run on individual packages.

To run all tests:

$ yarntest

To run tests in a specific package:

$ PKG=@sablier/protocol yarntest