Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sablier-labs/v2-core

⏳ Smart contracts of the Sablier Lockup protocol
https://github.com/sablier-labs/v2-core

blockchain cryptoasset-streaming ethereum foundry money-streaming real-time-finance sablier sablier-protocol sablier-v2 smart-contracts solidity token-streaming

Last synced: 5 days ago
JSON representation

⏳ Smart contracts of the Sablier Lockup protocol

Awesome Lists containing this project

README 

        
# Sablier V2 Core [![Github Actions][gha-badge]][gha] [![Coverage][codecov-badge]][codecov] [![Foundry][foundry-badge]][foundry] [![Discord][discord-badge]][discord]



[gha]: https://github.com/sablier-labs/v2-core/actions

[gha-badge]: https://github.com/sablier-labs/v2-core/actions/workflows/ci.yml/badge.svg

[codecov]: https://codecov.io/gh/sablier-labs/v2-core

[codecov-badge]: https://codecov.io/gh/sablier-labs/v2-core/branch/main/graph/badge.svg

[discord]: https://discord.gg/bSwRCwWRsT

[discord-badge]: https://dcbadge.vercel.app/api/server/bSwRCwWRsT?style=flat

[foundry]: https://getfoundry.sh

[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg



This repository contains the core smart contracts of the Sablier V2 Protocol. For higher-level logic, see the

[sablier-labs/v2-periphery](https://github.com/sablier-labs/v2-periphery) repository.



In-depth documentation is available at [docs.sablier.com](https://docs.sablier.com).



## Background



Sablier V2 is a token distribution protocol used by DAOs and businesses for vesting, payroll, airdrops, and more. Our

flagship model is the linear stream, which distributes assets on a continuous, by-the-second basis.



The way it works is that the sender of a payment stream first deposits a specific amount of ERC-20 tokens in a contract.

Then, the contract progressively allocates the funds to the recipient, who can access them as they become available over

time. The payment rate is influenced by various factors, including the start and end times, as well as the total amount

of tokens deposited.



## Install



### Node.js



This is the recommended approach.



Install Sablier V2 Core using your favorite package manager, e.g., with Bun:



```shell

bun add @sablier/v2-core

```



Then, if you are using Foundry, you need to add these to your `remappings.txt` file:



```text

@sablier/v2-core/=node_modules/@sablier/v2-core/

@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/

@prb/math/=node_modules/@prb/math/

```



### Git Submodules



This installation method is not recommended, but it is available for those who prefer it.



First, install the submodule using Forge:



```shell

forge install --no-commit sablier-labs/v2-core

```



Second, install the project's dependencies:



```shell

forge install --no-commit OpenZeppelin/[email protected] PaulRBerg/[email protected]

```



Finally, add these to your `remappings.txt` file:



```text

@sablier/v2-core/=lib/v2-core/

@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/

@prb/math/=lib/prb-math/

```



## Usage



This is just a glimpse of Sablier V2 Core. For more guides and examples, see the

[documentation](https://docs.sablier.com).



```solidity

import { ISablierV2LockupLinear } from "@sablier/v2-core/src/interfaces/ISablierV2LockupLinear.sol";



contract MyContract {

  ISablierV2LockupLinear sablier;



  function buildSomethingWithSablier() external {

    // ...

  }

}

```



## Architecture



V2 Core uses a singleton-style architecture, where all streams are managed in the `LockupLinear`, `LockupDynamic` and

`LockupTranched` contracts. That is, Sablier does not deploy a new contract for each stream. It bundles all streams into

a single contract, which is more gas-efficient and easier to maintain.



For more information, see the [Technical Overview](https://docs.sablier.com/contracts/v2/reference/overview) in our

docs, as well as these [diagrams](https://docs.sablier.com/contracts/v2/reference/diagrams).



### Branching Tree Technique



You may notice that some test files are accompanied by `.tree` files. This is called the Branching Tree Technique, and

it is explained in depth [here](https://github.com/sablier-labs/v2-core/wiki/Tests#branching-tree-technique).



## Deployments



The list of all deployment addresses can be found [here](https://docs.sablier.com). For guidance on the deploy scripts,

see the [Deployments wiki](https://github.com/sablier-labs/v2-core/wiki/Deployments).



## Security



The codebase has undergone rigorous audits by leading security experts from Cantina, as well as independent auditors.

For a comprehensive list of all audits conducted, please click [here](https://github.com/sablier-labs/audits).



For any security-related concerns, please refer to the [SECURITY](./SECURITY.md) policy. This repository is subject to a

bug bounty program per the terms outlined in the aforementioned policy.



## Contributing



Feel free to dive in! [Open](https://github.com/sablier-labs/v2-core/issues/new) an issue,

[start](https://github.com/sablier-labs/v2-core/discussions/new) a discussion or submit a PR. For any informal concerns

or feedback, please join our [Discord server](https://discord.gg/bSwRCwWRsT).



For guidance on how to create PRs, see the [CONTRIBUTING](./CONTRIBUTING.md) guide.



## License



The primary license for Sablier V2 Core is the Business Source License 1.1 (`BUSL-1.1`), see

[`LICENSE.md`](./LICENSE.md). However, there are exceptions:



- All files in `src/interfaces/` and `src/types` are licensed under `GPL-3.0-or-later`, see

  [`LICENSE-GPL.md`](./LICENSE-GPL.md).

- Several files in `src`, `script`, and `test` are licensed under `GPL-3.0-or-later`, see

  [`LICENSE-GPL.md`](./LICENSE-GPL.md).

- Many files in `test/` remain unlicensed (as indicated in their SPDX headers).