Skip to content

README.md

Latest commit

 

History

History
99 lines (67 loc) · 4.22 KB

README.md

File metadata and controls

99 lines (67 loc) · 4.22 KB
Raw

Sablier Airdrops 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.

Introduction

Sablier Airdrops is a collection of smart contracts that allows airdrops of ERC-20 tokens using Merkle trees. It offers multiple distributions options, including:

  1. Instant airdrops: The simplest way to distribute tokens to a list of addresses. Eligible users can claim and receive their allocation instantly via a single claim transaction.
  2. Vesting airdrops: This is the way to go if you want your users to receive tokens over time through vesting. Upon claiming, eligible users will have their tokens streamed through Sablier over a period specified by the campaign creator (aka the campaign owner). This distribution option has been referred to as Airstreams in the past.
  3. Variable Claim Amount (VCA) airdrops: This distribution method allows the campaign creator to set up an airdrop with linear unlock. However, when a user claims their airdrop, any unvested tokens are forfeited and returned to the campaign creator. This approach is useful for airdrops aimed at rewarding loyal users who wait until the end of the unlock period to claim their tokens.

Sablier Airdrops also offer flexibility in configuring the Airdrop campaigns. For example, you can choose between whether you want vesting to begin at the same time for all users (absolute) or at the time of each claim (relative).

Documentation

For guides and technical details, check out the Sablier documentation.

Getting started

Install

You can install this repo using either Node.js or Git Submodules.

Node.js

This is the recommended approach.

Install this repo using your favorite package manager, e.g., with Bun:

bun add @sablier/airdrops

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@airdrops@v3.0.1 OpenZeppelin/openzeppelin-contracts@v5.3.0 PaulRBerg/prb-math@v4.1.0

Then, add the following remappings in remappings.txt:

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

Deployments

The list of all deployment addresses can be found here.

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.