Skip to content

Latest commit

 

History

History
125 lines (86 loc) · 4.85 KB

README.md

File metadata and controls

125 lines (86 loc) · 4.85 KB
Raw

Sablier V2 Core Github Actions Coverage Foundry Discord

This repository contains the core smart contracts of the Sablier V2 Protocol. For higher-level logic, see the sablier-labs/v2-periphery repository.

In-depth documentation is available at docs.sablier.com.

Background

Sablier is a token streaming protocol that enables by-the-second payments in web3. DAOs and businesses use it for vesting, payroll, airdrops, and more.

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

Foundry

First, run the install step:

forge install sablier-labs/v2-core

Your .gitmodules file should now contain the following entry:

[submodule "lib/v2-core"]
  branch = "release"
  path = "lib/v2-core"
  url = "https://github.com/sablier-labs/v2-core"

Finally, add this to your remappings.txt file:

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

Node.js

Sablier V2 Core is available as a Node.js package:

pnpm add @sablier/v2-core

Usage

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

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 and LockupDynamic 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 in our docs, as well as these 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.

Deployments

The list of all deployment addresses can be found here. For guidance on the deploy scripts, see the Deployments wiki.

It is worth noting that not every file in this repository is included in the current deployments. For instance, the SablierV2FlashLoan abstract is not inherited by any contract on the main branch, but we have kept it in version control because we may decide to use it in the future.

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.

For any security-related concerns, please refer to the SECURITY 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 an issue, start a discussion or submit a PR. For any informal concerns or feedback, please join our Discord server.

For guidance on how to create PRs, see the CONTRIBUTING guide.

License

The primary license for Sablier V2 Core is the Business Source License 1.1 (BUSL-1.1), see 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.
  • Several files in src, script, and test are licensed under GPL-3.0-or-later, see LICENSE-GPL.md.
  • Many files in test/ remain unlicensed (as indicated in their SPDX headers).