@sablier/airdrops/README.md

EVM smart contracts of the Sablier Airdrops protocol

# Sablier Airdrops [![GitHub Actions][gha-badge]][gha] [![Coverage][codecov-badge]][codecov] [![Foundry][foundry-badge]][foundry] [![Discord][discord-badge]][discord] [![Twitter][twitter-badge]][twitter]

In-depth documentation is available at [docs.sablier.com](https://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](https://docs.sablier.com).

## 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:

```shell
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:

```shell
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`:

```text
@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/
```

### 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](https://bulloak.dev/).

### Deployments

The list of all deployment addresses can be found [here](https://docs.sablier.com/guides/airdrops/deployments).

## 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](https://github.com/sablier-labs/audits).

For any security-related concerns, please refer to the [SECURITY](../SECURITY.md) 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](https://github.com/sablier-labs/evm-monorepo/issues/new) an issue,
[start](https://github.com/sablier-labs/evm-monorepo/discussions/new/choose) a discussion or submit a PR. For any informal concerns
or feedback, please join our [Discord server](https://discord.gg/bSwRCwWRsT).

For guidance on how to create PRs, see the [CONTRIBUTING](../CONTRIBUTING.md) guide.

## License

See [LICENSE.md](../LICENSE.md).

[codecov]: https://codecov.io/gh/sablier-labs/evm-monorepo
[codecov-badge]: https://codecov.io/gh/sablier-labs/evm-monorepo/branch/main/graph/badge.svg
[discord]: https://discord.gg/bSwRCwWRsT
[discord-badge]: https://img.shields.io/discord/659709894315868191
[foundry]: https://getfoundry.sh
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
[gha]: https://github.com/sablier-labs/evm-monorepo/actions
[gha-badge]: https://github.com/sablier-labs/evm-monorepo/actions/workflows/ci-airdrops.yml/badge.svg
[twitter]: https://x.com/Sablier
[twitter-badge]: https://img.shields.io/twitter/follow/Sablier