-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #254 from sablier-labs/refactor/prb-feedback
refactor: prb feedback
- Loading branch information
Showing
54 changed files
with
494 additions
and
511 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| id: "overview" | ||
| sidebar_position: 1 | ||
| title: "Overview" | ||
| --- | ||
|
|
||
| # The Sablier Interface | ||
|
|
||
| The Sablier Interface is a web application that allows users to interact with the Sablier Protocol. It is a | ||
| user-friendly interface that enables users to create, manage, and interact with streams. | ||
|
|
||
| Start exploring at [app.sablier.com](https://app.sablier.com) or continue reading below to learn more about the | ||
| available features. | ||
|
|
||
| ## Use-case centric | ||
|
|
||
|  | ||
|
|
||
| The app is split among three use cases: | ||
|
|
||
| | Use Case | Smart Contracts Involved | Description | | ||
| | -------- | ------------------------------------- | ----------------------------------------------------------------------- | | ||
| | Vesting | Sablier Lockup | Closed-ended streams with and an end time and funds deposited upfront | | ||
| | Payments | Sablier Flow | Open-ended streams that can be topped up over time | | ||
| | Airdrops | Sablier MerkleFactory, Sablier Lockup | Instant or vested over time, with pre-configured recipients and amounts | | ||
|
|
||
| These features are enabled by two types of streams: | ||
|
|
||
| - Lockup streams - <i>fixed duration, amount required upfront, strict distribution curve</i> | ||
| - Flow streams - <i>no end time, amount can be topped-up, rate-per-second can be adjusted</i> | ||
|
|
||
| The Sablier Interface has adapted the Sablier Protocol for the use cases mentioned above, but we encourage you to | ||
| explore other applications. | ||
|
|
||
| ## Vesting | ||
|
|
||
| Read about the business use-case on our [dedicated landing page](https://sablier.com/vesting) or dive deeper into the | ||
| vesting-related features documented in [this section](/apps/features/vesting). | ||
|
|
||
| ## Payments | ||
|
|
||
| Read about the business use-case on our [dedicated landing page](https://sablier.com/payroll) or dive deeper into the | ||
| vesting-related features documented in [this section](/apps/features/payments). | ||
|
|
||
| ## Airdrop | ||
|
|
||
| Read more about the business use-case on our [dedicated landing page](https://sablier.com/airdrops) or dive deeper into | ||
| the airdrop-related features documented in [this section](/apps/features/airdrops). | ||
|
|
||
| ## Grants | ||
|
|
||
| Given how flexible Sablier is in adapting to any processes involving token distribution, we've also documented the | ||
| business case for [onchain grants](https://sablier.com/grants) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| --- | ||
| id: "airdrops" | ||
| sidebar_position: 4 | ||
| title: "Airdrops" | ||
| --- | ||
|
|
||
| # Airdrops | ||
|
|
||
| Sablier provides a solution for launching airdrops with up to a million recipients. This is designed to help projects | ||
| distribute tokens to a large number of users in a fair and efficient manner. Start exploring at | ||
| [app.sablier.com](https://app.sablier.com/airdrops/) or read more about it on | ||
| [sablier.com/airdrops](https://sablier.com/airdrops). | ||
|
|
||
| ## Airstreams (Vested Airdrops) | ||
|
|
||
|  | ||
|
|
||
| **Airdrops should be vested!** | ||
|
|
||
| At Sablier, we believe in long-term distributions with aligned incentives. That's why we engineered Airstreams, a | ||
| solution which allows you to airdrop streams with a vesting schedule. | ||
|
|
||
| Pick a vesting curve (e.g., linear), define the rules (e.g. duration, clawback window), and allow recipients to claim | ||
| their airdrops as vesting streams. | ||
|
|
||
| ## Instant Airdrops | ||
|
|
||
|  | ||
|
|
||
| Sablier also offers an instant airdrop solution, meaning the tokens are immediately released to the recipients upon | ||
| claiming. | ||
|
|
||
| ## Features | ||
|
|
||
| ### Create with CSV | ||
|
|
||
| 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 | ||
| will sanitize, validate and triple-check the data to ensure everything is formatted correctly. | ||
|
|
||
| :::caution Timezone Caveat | ||
|
|
||
| All times in the CSV are considered to be in the same timezone as the airdrop creator's device. Visit our | ||
| [CSV guide](/apps/guides/csv-support) to read more about the format. | ||
|
|
||
| ::: | ||
|
|
||
| ### Easy 3-step process | ||
|
|
||
| Creating campaigns involves a simple 3-step process: | ||
|
|
||
| 1. Configure the initial details (e.g., token, campaign name, etc.) | ||
| 2. Upload the CSV containing the recipient data | ||
| 3. Deploy the Airdrop campaign contract | ||
|
|
||
| | | | ||
| | ------------------------------------------------------------- | | ||
| |  | | ||
| |  | | ||
|
|
||
| ### Open source | ||
|
|
||
| If you'd like to support Airdrops in your UI or have additional requirements, you can do so by using a self-hosted | ||
| [Merkle service](/api/airdrops/merkle-api/overview). Reach out to us on [Discord](https://discord.sablier.com) for more | ||
| details and customer support. | ||
|
|
||
| ### Explore the dashboard | ||
|
|
||
| Enter the Dashboard and discover a detailed overview of the Airdrops you may be eligible for. | ||
|
|
||
| Take advantage of the Search functionality to explore the chain and gain more insight into how others are using Sablier. | ||
|
|
||
| | | | ||
| | --------------------------------------------------- | | ||
| |  | | ||
|
|
||
| ### Support for any ERC-20 token | ||
|
|
||
| You can drop your own token! | ||
|
|
||
| Thanks to our integration of Token Lists, any ERC-20 token can be airdropped on Sablier. | ||
|
|
||
| For your token logo to show up in the Sablier app, add it to our | ||
| [token list](https://github.com/sablier-labs/community-token-list/issues/new?template=token-request.md) | ||
|
|
||
| | | | ||
| | --------------------------------------------------- | | ||
| |  | | ||
|
|
||
| ### Oversight | ||
|
|
||
| Have a clear view of how your campaign is performing. Check eligibility or manage your own campaign from a dedicated | ||
| interface. | ||
|
|
||
| | | | ||
| | ----------------------------------------------------- | | ||
| |  | | ||
|
|
||
| :::info | ||
|
|
||
| To integrate this functionality into your own products/apps, have a look at the [API guides](/api/overview), especially | ||
| the [Merkle API](/api/airdrops/merkle-api/overview) and the Merkle subgraphs. | ||
|
|
||
| ::: | ||
|
|
||
| ### Advanced Settings | ||
|
|
||
| For campaign admins, the interface enables advanced settings like in-app visibility, in-app geographical restrictions, | ||
| and campaign-specific items like an eligibility criteria link. | ||
|
|
||
| | | | ||
| | ------------------------------------------------------- | | ||
| |  | | ||
|
|
||
| ### Geographical Restrictions | ||
|
|
||
| As shown in the image above, you can specify a list of countries where access to the campaign will be restricted on the | ||
| Sablier Interface at [app.sablier.com](https://app.sablier.com). Note that this restriction does not apply to the | ||
| Sablier Protocol, which runs permissionlessly on the blockchain. | ||
|
|
||
| Additionally, some jurisdictions may already be restricted by default — either by your ISP or Vercel, our hosting | ||
| provider. |
Oops, something went wrong.