Skip to content

Commit 85ea9d9

Browse files
authored
Merge pull request #254 from sablier-labs/refactor/prb-feedback
refactor: prb feedback
2 parents 9886deb + 6bbb778 commit 85ea9d9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+494
-511
lines changed

docs/api/01-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Below, we will cover:
2020

2121
## Solutions
2222

23-
![Banner Sablier APIs](/banner/docs-banner-apis.webp)
23+
![Banner Sablier APIs](/banners/docs-apis.webp)
2424

2525
As an alternative to reading data from the contracts or listening to onchain events, we use a collection of subgraphs
2626
and indexers. These service act as a middleware between the chain and our interfaces and allow for caching, formatting

docs/apps/03-branding.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,3 @@ If you have any special requests, reach out on [Discord](https://discord.sablier
1919
subtitle="GitHub"
2020
title="Github - sablier-labs/branding: Sablier brand guidelines and assets"
2121
/>
22-
23-
### Promo video
24-
25-
[![Introducing Sablier Lockup](/img/youtube-cover.webp)](https://youtu.be/0XvJ112Jf1k "Introducing Sablier Lockup")

docs/apps/features/01-overview.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
id: "overview"
3+
sidebar_position: 1
4+
title: "Overview"
5+
---
6+
7+
# The Sablier Interface
8+
9+
The Sablier Interface is a web application that allows users to interact with the Sablier Protocol. It is a
10+
user-friendly interface that enables users to create, manage, and interact with streams.
11+
12+
Start exploring at [app.sablier.com](https://app.sablier.com) or continue reading below to learn more about the
13+
available features.
14+
15+
## Use-case centric
16+
17+
![Banner App Navigation](/banners/docs-app-navigation.webp)
18+
19+
The app is split among three use cases:
20+
21+
| Use Case | Smart Contracts Involved | Description |
22+
| -------- | ------------------------------------- | ----------------------------------------------------------------------- |
23+
| Vesting | Sablier Lockup | Closed-ended streams with and an end time and funds deposited upfront |
24+
| Payments | Sablier Flow | Open-ended streams that can be topped up over time |
25+
| Airdrops | Sablier MerkleFactory, Sablier Lockup | Instant or vested over time, with pre-configured recipients and amounts |
26+
27+
These features are enabled by two types of streams:
28+
29+
- Lockup streams - <i>fixed duration, amount required upfront, strict distribution curve</i>
30+
- Flow streams - <i>no end time, amount can be topped-up, rate-per-second can be adjusted</i>
31+
32+
The Sablier Interface has adapted the Sablier Protocol for the use cases mentioned above, but we encourage you to
33+
explore other applications.
34+
35+
## Vesting
36+
37+
Read about the business use-case on our [dedicated landing page](https://sablier.com/vesting) or dive deeper into the
38+
vesting-related features documented in [this section](/apps/features/vesting).
39+
40+
## Payments
41+
42+
Read about the business use-case on our [dedicated landing page](https://sablier.com/payroll) or dive deeper into the
43+
vesting-related features documented in [this section](/apps/features/payments).
44+
45+
## Airdrop
46+
47+
Read more about the business use-case on our [dedicated landing page](https://sablier.com/airdrops) or dive deeper into
48+
the airdrop-related features documented in [this section](/apps/features/airdrops).
49+
50+
## Grants
51+
52+
Given how flexible Sablier is in adapting to any processes involving token distribution, we've also documented the
53+
business case for [onchain grants](https://sablier.com/grants)

docs/apps/features/01-overview.mdx

Lines changed: 0 additions & 53 deletions
This file was deleted.

docs/apps/features/02-vesting.mdx

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import LockupNFTSVG from "@site/static/img/lockup-nft.svg";
1111
The Sablier Interface will showcase [Lockup](/concepts/lockup/overview) streams under the Vesting tab. These are token
1212
streams with a fixed duration, predefined amount and strict distribution curve.
1313

14-
![Banner Vesting](/banner/docs-banner-vesting.webp)
14+
![Banner Vesting](/banners/docs-vesting.webp)
1515

1616
In Q4 2024 the app has undergone a use-case centric redesign. For past users, all streams created before this update
1717
will show up in the Vesting page.
@@ -78,28 +78,27 @@ Streaming, everywhere. We support 11+ EVM chains and testnets where you can stre
7878
| ---------------------------------------------- |
7979
| ![ChainList](/screenshots/general-chains.webp) |
8080

81-
### Create in batches
81+
### Create in bulk
8282

83-
Save time by creating up to 60 streams in bulk for your employees, investors, or community members. Use the forms for a
83+
Save time by creating up to 280 streams in bulk for your employees, investors, or community members. Use the forms for a
8484
clean and straightforward UX.
8585

86-
| |
87-
| ------------------------------------------ |
88-
| ![Group](/screenshots/vesting-create.webp) |
86+
| |
87+
| --------------------------------------------------- |
88+
| ![Create in bulk](/screenshots/vesting-create.webp) |
8989

90-
### Create from CSVs
90+
### Create with CSV
9191

92-
Save even more time by using our CSV upload, dedicated to power-users. Under the hood, it works the same as the visual
93-
forms.
92+
As an alternative to manually filling out the form, you can upload a CSV file with your user data.
9493

95-
| |
96-
| ---------------------------------------------- |
97-
| ![Group](/screenshots/vesting-create-csv.webp) |
94+
| |
95+
| -------------------------------------------------------- |
96+
| ![Create with CSV](/screenshots/vesting-create-csv.webp) |
9897

9998
### Simulations
10099

101-
Eager to see what your chosen distribution will look like? Use our simulation tool right from the create-stream forms
102-
(or later on, from the stream profile).
100+
Eager to see what your token distribution will look like? Use our simulation tool right from the stream creation forms
101+
(or later, from the stream profile).
103102

104103
![Simulate](/screenshots/simulation.webp)
105104

@@ -119,13 +118,25 @@ on your payouts. Remember, you can always be both a sender and a recipient.
119118

120119
### Any ERC-20 token
121120

122-
Stream your favorite token! Thanks to our integration of Token Lists, any ERC-20 token can be streamed on Sablier
123-
Lockup.
121+
Thanks to our integration of Token Lists, any ERC-20 token can be distributed via Sablier Lockup.
122+
123+
:::warning
124+
125+
The only exception is rebasing tokens like Aave's aTokens. Tokens that dynamically rebase their balance are not
126+
supported by Sablier.
127+
128+
:::
124129

125130
| | |
126131
| ----------------------------------------------- | -------------------------------------------------------- |
127132
| ![Token List](/screenshots/tokenlist-home.webp) | ![Token List Search](/screenshots/tokenlist-search.webp) |
128133

134+
### Mobile-ready layout
135+
136+
Token streams on the go!
137+
138+
Yes, the Sablier app works on mobile. And yes, we support dark mode by default (light mode coming soon).
139+
129140
### Permissions
130141

131142
We've mapped the most important utilities from the Lockup contracts into in-app features. Interact with streams that
@@ -136,15 +147,10 @@ reference you as a key participant (e.g. sender, recipient) directly from the in
136147
| Create Streams || - | - |
137148
| Renounce Cancelability ||| - |
138149
| Cancel ||| - |
139-
| Cancel Multiple ||| - |
140150
| Transfer ||| - |
141151
| Withdraw ||||
142152

143153
### Safe multisig support
144154

145155
Vesting is fully integrated with [Safe](https://safe.global). Start streaming from the safety and comfort of your
146156
multisig wallet.
147-
148-
### Mobile-ready layout
149-
150-
Stream in style! Yes, the app works on mobile. And yes, we support dark mode by default (light mode coming soon).

docs/apps/features/03-payments.mdx renamed to docs/apps/features/03-payments.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ sidebar_position: 3
44
title: "Payments"
55
---
66

7-
The Sablier Interface will showcase [Flow](/concepts/flow/overview) streams under the Payments tab. These are token
8-
streams with a no end-date, an ever increasing amount (can be topped up) and a flexible rate per second.
7+
The Sablier Interface displays [Flow](/concepts/flow/overview) streams under the Payments tab. These are token streams
8+
with no end time, an ever-increasing amount (meaning the streams can be topped up), and a flexible rate per second.
99

10-
![Banner Vesting](/banner/docs-banner-payments.webp)
10+
![Banner Payments](/banners/docs-payments.webp)
1111

1212
## Features
1313

@@ -51,24 +51,20 @@ Streaming, everywhere. We enable payments on 11+ EVM chains and testnets where y
5151
| ---------------------------------------------- |
5252
| ![ChainList](/screenshots/general-chains.webp) |
5353

54-
### Create in batches
54+
### Create in bulk
5555

56-
Save time by creating up to 60 streams in bulk for your employees, investors, or community members. Use the forms for a
56+
Save time by creating up to 280 streams in bulk for your employees, investors, or community members. Use the forms for a
5757
clean and straightforward UX.
5858

59-
### Create from CSVs
59+
### Create with CSV
6060

61-
Save even more time by using our CSV upload, dedicated to power-users. Under the hood, it works the same as the visual
62-
forms.
63-
64-
### Safe multisig support
65-
66-
Payments are fully integrated with [Safe](https://safe.global). Start streaming from the safety and comfort of your
67-
multisig wallet.
61+
As an alternative to manually filling out the form, you can upload a CSV file with your user data.
6862

6963
### Mobile-ready layout
7064

71-
Stream in style! Yes, the app works on mobile. And yes, we support dark mode by default (light mode coming soon).
65+
Token streams on the go!
66+
67+
Yes, the Sablier app works on mobile. And yes, we support dark mode by default (light mode coming soon).
7268

7369
### Permissions
7470

@@ -86,3 +82,8 @@ reference you as a key participant (e.g. sender, recipient) directly from the in
8682
| Restart ||| - |
8783
| Transfer ||| - |
8884
| Withdraw ||||
85+
86+
### Safe multisig support
87+
88+
Payments are fully integrated with [Safe](https://safe.global). Start streaming from the safety and comfort of your
89+
multisig wallet.

docs/apps/features/04-airdrops.md

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
id: "airdrops"
3+
sidebar_position: 4
4+
title: "Airdrops"
5+
---
6+
7+
# Airdrops
8+
9+
Sablier provides a solution for launching airdrops with up to a million recipients. This is designed to help projects
10+
distribute tokens to a large number of users in a fair and efficient manner. Start exploring at
11+
[app.sablier.com](https://app.sablier.com/airdrops/) or read more about it on
12+
[sablier.com/airdrops](https://sablier.com/airdrops).
13+
14+
## Airstreams (Vested Airdrops)
15+
16+
![Banner Airdrops Vesting](/banners/docs-airdrops-airstreams.webp)
17+
18+
**Airdrops should be vested!**
19+
20+
At Sablier, we believe in long-term distributions with aligned incentives. That's why we engineered Airstreams, a
21+
solution which allows you to airdrop streams with a vesting schedule.
22+
23+
Pick a vesting curve (e.g., linear), define the rules (e.g. duration, clawback window), and allow recipients to claim
24+
their airdrops as vesting streams.
25+
26+
## Instant Airdrops
27+
28+
![Banner Airdrops Instant](/banners/docs-airdrops-instant.webp)
29+
30+
Sablier also offers an instant airdrop solution, meaning the tokens are immediately released to the recipients upon
31+
claiming.
32+
33+
## Features
34+
35+
### Create with CSV
36+
37+
Generate your list of recipients and put it into a CSV file, upload it to our app, and we'll take care of the rest. We
38+
will sanitize, validate and triple-check the data to ensure everything is formatted correctly.
39+
40+
:::caution Timezone Caveat
41+
42+
All times in the CSV are considered to be in the same timezone as the airdrop creator's device. Visit our
43+
[CSV guide](/apps/guides/csv-support) to read more about the format.
44+
45+
:::
46+
47+
### Easy 3-step process
48+
49+
Creating campaigns involves a simple 3-step process:
50+
51+
1. Configure the initial details (e.g., token, campaign name, etc.)
52+
2. Upload the CSV containing the recipient data
53+
3. Deploy the Airdrop campaign contract
54+
55+
| |
56+
| ------------------------------------------------------------- |
57+
| ![Airdrop Create: Step 1](/screenshots/airdrop-create-1.webp) |
58+
| ![Airdrop Create: Step 2](/screenshots/airdrop-create-2.webp) |
59+
60+
### Open source
61+
62+
If you'd like to support Airdrops in your UI or have additional requirements, you can do so by using a self-hosted
63+
[Merkle service](/api/airdrops/merkle-api/overview). Reach out to us on [Discord](https://discord.sablier.com) for more
64+
details and customer support.
65+
66+
### Explore the dashboard
67+
68+
Enter the Dashboard and discover a detailed overview of the Airdrops you may be eligible for.
69+
70+
Take advantage of the Search functionality to explore the chain and gain more insight into how others are using Sablier.
71+
72+
| |
73+
| --------------------------------------------------- |
74+
| ![Airdrop Search](/screenshots/airdrop-search.webp) |
75+
76+
### Support for any ERC-20 token
77+
78+
You can drop your own token!
79+
80+
Thanks to our integration of Token Lists, any ERC-20 token can be airdropped on Sablier.
81+
82+
For your token logo to show up in the Sablier app, add it to our
83+
[token list](https://github.com/sablier-labs/community-token-list/issues/new?template=token-request.md)
84+
85+
| |
86+
| --------------------------------------------------- |
87+
| ![List of chains](/screenshots/general-chains.webp) |
88+
89+
### Oversight
90+
91+
Have a clear view of how your campaign is performing. Check eligibility or manage your own campaign from a dedicated
92+
interface.
93+
94+
| |
95+
| ----------------------------------------------------- |
96+
| ![Airdrop Profile](/screenshots/airdrop-profile.webp) |
97+
98+
:::info
99+
100+
To integrate this functionality into your own products/apps, have a look at the [API guides](/api/overview), especially
101+
the [Merkle API](/api/airdrops/merkle-api/overview) and the Merkle subgraphs.
102+
103+
:::
104+
105+
### Advanced Settings
106+
107+
For campaign admins, the interface enables advanced settings like in-app visibility, in-app geographical restrictions,
108+
and campaign-specific items like an eligibility criteria link.
109+
110+
| |
111+
| ------------------------------------------------------- |
112+
| ![Airdrop Settings](/screenshots/airdrop-settings.webp) |
113+
114+
### Geographical Restrictions
115+
116+
As shown in the image above, you can specify a list of countries where access to the campaign will be restricted on the
117+
Sablier Interface at [app.sablier.com](https://app.sablier.com). Note that this restriction does not apply to the
118+
Sablier Protocol, which runs permissionlessly on the blockchain.
119+
120+
Additionally, some jurisdictions may already be restricted by default — either by your ISP or Vercel, our hosting
121+
provider.

0 commit comments

Comments
 (0)