Skip to content
Decentralised app for continuous payments on Ethereum
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages fix(frontend): update contract address Jun 11, 2019
.commitlintrc.js feat: initial commit Apr 10, 2019
.editorconfig style: update EditorConfig rules May 6, 2019
.eslintignore
.eslintrc.js feat: initial commit Apr 10, 2019
.gitignore feat(website): code the Stream page May 5, 2019
.huskyrc feat: initial commit Apr 10, 2019
.prettierignore feat(website): code the Stream page May 5, 2019
.prettierrc feat: initial commit Apr 10, 2019
.solhint.json feat: initial commit Apr 10, 2019
.solhintignore feat: initial commit Apr 10, 2019
LICENSE.md chore: add LGPL license May 27, 2019
README.md docs: update netlify badge May 29, 2019
babel.config.js feat: initial commit Apr 10, 2019
lerna.json style: apply prettier May 27, 2019
package.json chore: remove unused scripts from package.json Jun 7, 2019
yarn.lock fix(contracts): add require checks to erc20 transfers Jun 11, 2019

README.md

Sablier is a decentralised app for continuous payments on Ethereum. Read this article to find our more about our mission. Check out a demo video here.

Styled with Prettier Commitizen Friendly Twitter License: LGPL v3


Packages 📦

Sablier is maintained as a monorepo with multiple sub packages. Please find a comprehensive list below.

Deployed Packages

Package Version Description
@sablier/contracts npm Sablier solidity smart contracts & tests
@sablier/dev-utils npm Dev utils to be shared across Sablier projects and packages

Private Packages

Package Description
@sablier/frontend Frontend app

Usage

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 process.env.

Finally:

$ 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.

Contributing 🙋

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.

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.

Requirements

  • yarn >=1.15.2
  • truffle >= 5.0.19
  • solidity >=0.5.0 <0.6.0

Pre Requisites

Make sure you are using Yarn >=1.15.2. To install using homebrew:

$ brew install yarn

Then install dependencies:

$ yarn install

Watch

To re-build all packages on change:

$ yarn watch

Clean

To clean all packages:

$ yarn clean

To clean a specific package:

$ PKG=@sablier/contracts yarn clean

Lint

To lint all packages:

$ yarn lint

To lint a specific package:

$ PKG=@sablier/contracts yarn lint

Test

To run all tests:

$ yarn test

To run tests in a specific package:

$ PKG=@sablier/contracts yarn test
You can’t perform that action at this time.