Skip to content

update csv guide #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update csv guide #361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions docs/apps/guides/01-csv-support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,25 @@ browser.
With Sablier, you can create airdrop campaigns with up to a million recipients. To do so, you must upload a CSV file
containing all recipient addresses and the airdrop amounts.

Use the provided template and fill in the rows with recipient addresses and airdrop amounts.

### CSV Template

For your convenience, here's a download link for the CSV template:

<LinkPreview
href="https://files.sablier.com/templates/airdrop-template.csv"
icon="sablier"
subtitle="CSV template for creating airdrops on Sablier"
title="Sablier - Airdrop CSV Template"
/>
Use the provided templates and fill in the rows with recipient addresses, airdrop amounts, and other details depending on the airdrop type.

### CSV Templates

Here's a table with all the available airdrop CSV templates:

| URL | Description |
| :------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------- |
| [Instant](https://files.sablier.com/templates/airdrop-instant-template.csv) | Instant airdrops with immediate token distribution. |
| [Linear with duration](https://files.sablier.com/templates/airdrop-linear-duration-template.csv) | [Linear streams](/concepts/lockup/stream-shapes#linear) with the duration timing. |
| [Linear with range](https://files.sablier.com/templates/airdrop-linear-range-template.csv) | [Linear streams](/concepts/lockup/stream-shapes#linear) with the range timing. |
| [Cliff with duration](https://files.sablier.com/templates/airdrop-cliff-duration-template.csv) | [Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the duration timing. |
| [Cliff with range](https://files.sablier.com/templates/airdrop-cliff-range-template.csv) | [Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the range timing. |
| [Timelock with duration](https://files.sablier.com/templates/airdrop-timelock-duration-template.csv) | [Timelock streams](/concepts/lockup/stream-shapes#timelock) with the duration timing. |
| [Timelock with range](https://files.sablier.com/templates/airdrop-timelock-range-template.csv) | [Timelock streams](/concepts/lockup/stream-shapes#timelock) with the range timing. |
| [Unlock linear with duration](https://files.sablier.com/templates/airdrop-unlockLinear-duration-template.csv) | [Unlock-Linear streams](/concepts/lockup/stream-shapes#initial-unlock) with the duration timing. |
| [Unlock linear with range](https://files.sablier.com/templates/airdrop-unlockLinear-range-template.csv) | [Unlock-Linear streams](/concepts/lockup/stream-shapes#initial-unlock) with the range timing. |
| [Unlock cliff with duration](https://files.sablier.com/templates/airdrop-unlockCliff-duration-template.csv) | [Unlock-Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the duration timing. |
| [Unlock cliff with range](https://files.sablier.com/templates/airdrop-unlockCliff-range-template.csv) | [Unlock-Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the range timing. |

### Navigation

Expand All @@ -61,9 +68,9 @@ To use this feature:
Using a CSV, you can deploy up to 280 streams all at once. Start from the suggested template, and fill in the rows with
addresses, amounts, and other details.

### CSV Template
### CSV Templates

Here's table with all the available CSV templates.
Here's a table with all the available CSV templates.

[Sablier Flow](/concepts/use-cases#sablier-flow) (the first row in the below table) is a great fit for use cases like payroll, grants, and subscriptions. The other streaming curves in the table rely on [Sablier Lockup](/concepts/use-cases#sablier-lockup) and are a better fit for vesting and airdrops.

Expand All @@ -81,7 +88,7 @@ Here's table with all the available CSV templates.
| [Timelock with range](https://files.sablier.com/templates/timelock-range-template.csv) | [Timelock streams](/concepts/lockup/stream-shapes#timelock) with the range timing. |
| [BackWeighted with range](https://files.sablier.com/templates/backWeighted-range-template.csv) | [BackWeighted streams](/concepts/lockup/stream-shapes) with the range timing. |
| [Unlock linear with duration](https://files.sablier.com/templates/unlockLinear-duration-template.csv) | [Unlock-Linear streams](/concepts/lockup/stream-shapes#initial-unlock) with the duration timing. |
| [Unlock linear with range](https://files.sablier.com/templates/unlockLinear-range-template.csv) | [Unlock-Liner streams](/concepts/lockup/stream-shapes#initial-unlock) with the range timing. |
| [Unlock linear with range](https://files.sablier.com/templates/unlockLinear-range-template.csv) | [Unlock-Linear streams](/concepts/lockup/stream-shapes#initial-unlock) with the range timing. |
| [Unlock cliff with duration](https://files.sablier.com/templates/2025-02/unlockCliff-duration-template.csv) | [Unlock-Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the duration timing. |
| [Unlock cliff with range](https://files.sablier.com/templates/2025-02/unlockCliff-range-template.csv) | [Unlock-Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the range timing. |
| [Exponential with duration](https://files.sablier.com/templates/exponential-duration-template.csv) | [Exponential streams](/concepts/lockup/stream-shapes#exponential) with the duration timing. |
Expand All @@ -103,7 +110,7 @@ To use this feature:

### Column Formats

To use the CSV feature, the data you provide must be formatted correctly. Bellow is a list with the format expected for
To use the CSV feature, the data you provide must be formatted correctly. Below is a list with the format expected for
all column types supported by Sablier.

:::warning
Expand Down