In-depth documentation is available at docs.sablier.com.
Sablier Airdrops is a collection of smart contracts that allows airdrops of ERC-20 tokens using Merkle trees. It offers multiple distributions options, including:
Sablier Airdrops also offer flexibility in configuring the Airdrop campaigns. For example, you can choose between whether you want to have vesting to begin at the same time for all user (absolute) or at the time of each claim (relative).
For guides and technical details, check out the Sablier documentation.
You can install this repo using either Node.js or Git Submodules.
This is the recommended approach.
Install this repo using your favorite package manager, e.g., with Bun:
bun add @sablier/airdrops
Then, if you are using Foundry, you need to add these to your remappings.txt
file:
@sablier/airdrops/=node_modules/@sablier/airdrops/
@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
@prb/math/=node_modules/@prb/math/
This installation method is not recommended, but it is available for those who prefer it.
First, install the submodule using Forge:
forge install --no-commit sablier-labs/airdrops
Second, install the project's dependencies:
forge install --no-commit OpenZeppelin/openzeppelin-contracts@v5.0.2 PaulRBerg/prb-math@v4.1.0 sablier-labs/lockup@v2.0.0
Finally, add these to your remappings.txt
file:
@sablier/airdrops/=lib/airdrops/
@sablier/lockup/=lib/lockup/src/
@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
@prb/math/=lib/prb-math/
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.
The list of all deployment addresses can be found here.
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.
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.
The primary license for Sablier Airdrops is the Business Source License 1.1 (BUSL-1.1
), see
LICENSE.md
. However, there are exceptions:
src/interfaces/
and src/types
are licensed under GPL-3.0-or-later
, see
LICENSE-GPL.md
.src
, script
, and tests
are licensed under GPL-3.0-or-later
, see
LICENSE-GPL.md
.tests/
remain unlicensed (as indicated in their SPDX headers).