@sablier/airdrops

Sablier Airdrops

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:

• 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.
• 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.
• 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.

First, install the submodule using Forge:

forge install sablier-labs/airdrops

Second, install the project's dependencies:

forge install sablier-labs/evm-utils@v1.0.0 OpenZeppelin/openzeppelin-contracts@v5.3.0 PaulRBerg/prb-math@v4.1.0 sablier-labs/lockup@v3.0.0

Branching Tree Technique

You may notice that some test files are accompanied by .tree files. This is because we are using Branching Tree Technique and Bulloak.

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

See LICENSE.md.