Skip to content

Latest commit

 

History

History

README.md

Sablier Lockup GitHub Actions Coverage Foundry Twitter

Important

The license changed from BUSL-1.1 to GPL on 2026-07-13. Read the announcement on X for details.

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

Background

Sablier Lockup is a token distribution protocol that enables onchain vesting and airdrops. Our flagship model is the linear stream, which distributes tokens 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 Lockup using your favorite package manager, e.g., with Bun:

bun add @sablier/lockup

Git Submodules

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

Install the monorepo and its dependencies using Forge:

forge install sablier-labs/evm-monorepo@lockup@v4.0.1 OpenZeppelin/openzeppelin-contracts@v5.3.0 PaulRBerg/prb-math@v4.1.0 smartcontractkit/chainlink-evm@contracts-v1.4.0

Then, add the following remappings in remappings.txt:

@chainlink/contracts/=lib/chainlink/contracts-evm/
@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
@prb/math/=lib/prb-math/
@sablier/evm-utils/=lib/evm-monorepo/utils/
@sablier/lockup/=lib/evm-monorepo/lockup/

Usage

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

import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";

contract MyContract {
  ISablierLockup lockup;

  function buildSomethingWithSablier() external {
    // ...
  }
}

Architecture

Lockup uses a singleton-style architecture, where all streams are managed in the SablierLockup contract. That is, Sablier does not deploy a new contract for each distribution model or 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.

Deployments

The list of all deployment addresses can be found here. For guidance on the deployment scripts, see the Deployments Guide in our docs.

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.

Contributing

This repository is not accepting pull requests of any kind, including changes to code comments. Comment-only edits can change the compiled bytecode, and the source on main must remain byte-for-byte verifiable against the deployed addresses. PRs will be closed without review.

For questions or informal feedback, open an issue or start a discussion.

License

See LICENSE.md.