Skip to content

Commit 2d1ae54

Browse files
maxdesallemaxdesalle
committed
refactor: update csv page
1 parent ecf0458 commit 2d1ae54

File tree

4 files changed

+76
-24
lines changed

4 files changed

+76
-24
lines changed

‎docs/apps/guides/01-csv-support.mdx

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -65,29 +65,31 @@ addresses, amounts, and other details.
6565

6666
### CSV Template
6767

68-
Here's table with all the available CSV templates:
69-
70-
| URL | Description |
71-
| :------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------- |
72-
| [Flow](https://files.sablier.com/templates/flow-template.csv) | Open-ended streams that can be topped up. |
73-
| [Linear with duration](https://files.sablier.com/templates/linear-duration-template.csv) | Linear streams with the duration timing. |
74-
| [Linear with range](https://files.sablier.com/templates/linear-range-template.csv) | Linear streams with the range timing. |
75-
| [Cliff with duration](https://files.sablier.com/templates/2025-02/cliff-duration-template.csv) | Cliff streams with the duration timing. |
76-
| [Cliff with range](https://files.sablier.com/templates/2025-02/cliff-range-template.csv) | Cliff streams with the range timing. |
77-
| [Monthly with range](https://files.sablier.com/templates/monthly-range-template.csv) | Unlock Each Month streams with the range timing. |
78-
| [Stepper with duration](https://files.sablier.com/templates/2025-02/unlockSteps-duration-template.csv) | Unlock In Steps streams with the duration timing. |
79-
| [Stepper with range](https://files.sablier.com/templates/2025-02/unlockSteps-range-template.csv) | Unlock In Steps streams with the range timing. |
80-
| [Timelock with duration](https://files.sablier.com/templates/timelock-duration-template.csv) | Timelock streams with the duration timing. |
81-
| [Timelock with range](https://files.sablier.com/templates/timelock-range-template.csv) | Timelock streams with the range timing. |
82-
| [BackWeighted with range](https://files.sablier.com/templates/backWeighted-range-template.csv) | BackWeighted streams with the range timing. |
83-
| [Unlock linear with duration](https://files.sablier.com/templates/unlockLinear-duration-template.csv) | Unlock-Linear streams with the duration timing. |
84-
| [Unlock linear with range](https://files.sablier.com/templates/unlockLinear-range-template.csv) | Unlock-Liner streams with the range timing. |
85-
| [Unlock cliff with duration](https://files.sablier.com/templates/2025-02/unlockCliff-duration-template.csv) | Unlock-Cliff streams with the duration timing. |
86-
| [Unlock cliff with range](https://files.sablier.com/templates/2025-02/unlockCliff-range-template.csv) | Unlock-Cliff streams with the range timing. |
87-
| [Exponential with duration](https://files.sablier.com/templates/exponential-duration-template.csv) | Exponential streams with the duration timing. |
88-
| [Exponential with range](https://files.sablier.com/templates/exponential-range-template.csv) | Exponential streams with the range timing. |
89-
| [Cliff exponential with duration](https://files.sablier.com/templates/exponentialCliff-duration-template.csv) | Cliff-Exponential streams with the duration timing. |
90-
| [Cliff exponential with range](https://files.sablier.com/templates/exponentialCliff-range-template.csv) | Cliff-Exponential streams with the range timing. |
68+
Here's table with all the available CSV templates.
69+
70+
[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.
71+
72+
| URL | Description |
73+
| :------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------ |
74+
| [Flow](https://files.sablier.com/templates/flow-template.csv) | [Open-ended streams](/concepts/flow/overview#total-debt) that can be topped up. |
75+
| [Linear with duration](https://files.sablier.com/templates/linear-duration-template.csv) | [Linear streams](/concepts/lockup/stream-shapes#linear) with the duration timing. |
76+
| [Linear with range](https://files.sablier.com/templates/linear-range-template.csv) | [Linear streams](/concepts/lockup/stream-shapes#linear) with the range timing. |
77+
| [Cliff with duration](https://files.sablier.com/templates/2025-02/cliff-duration-template.csv) | [Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the duration timing. |
78+
| [Cliff with range](https://files.sablier.com/templates/2025-02/cliff-range-template.csv) | [Cliff streams](/concepts/lockup/stream-shapes#cliff-unlock) with the range timing. |
79+
| [Monthly with range](https://files.sablier.com/templates/monthly-range-template.csv) | [Unlock Each Month streams](/concepts/lockup/stream-shapes#unlock-monthly) with the range timing. |
80+
| [Stepper with duration](https://files.sablier.com/templates/2025-02/unlockSteps-duration-template.csv) | [Unlock In Steps streams](/concepts/lockup/stream-shapes#unlock-in-steps) with the duration timing. |
81+
| [Stepper with range](https://files.sablier.com/templates/2025-02/unlockSteps-range-template.csv) | [Unlock In Steps streams](/concepts/lockup/stream-shapes#unlock-in-steps) with the range timing. |
82+
| [Timelock with duration](https://files.sablier.com/templates/timelock-duration-template.csv) | [Timelock streams](/concepts/lockup/stream-shapes#timelock) with the duration timing. |
83+
| [Timelock with range](https://files.sablier.com/templates/timelock-range-template.csv) | [Timelock streams](/concepts/lockup/stream-shapes#timelock) with the range timing. |
84+
| [BackWeighted with range](https://files.sablier.com/templates/backWeighted-range-template.csv) | [BackWeighted streams](/concepts/lockup/stream-shapes) with the range timing. |
85+
| [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. |
86+
| [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. |
87+
| [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. |
88+
| [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. |
89+
| [Exponential with duration](https://files.sablier.com/templates/exponential-duration-template.csv) | [Exponential streams](/concepts/lockup/stream-shapes#exponential) with the duration timing. |
90+
| [Exponential with range](https://files.sablier.com/templates/exponential-range-template.csv) | [Exponential streams](/concepts/lockup/stream-shapes#exponential) with the range timing. |
91+
| [Cliff exponential with duration](https://files.sablier.com/templates/exponentialCliff-duration-template.csv) | [Cliff-Exponential streams](/concepts/lockup/stream-shapes#cliff-exponential) with the duration timing. |
92+
| [Cliff exponential with range](https://files.sablier.com/templates/exponentialCliff-range-template.csv) | [Cliff-Exponential streams](/concepts/lockup/stream-shapes#cliff-exponential) with the range timing. |
9193

9294
### Navigation
9395

‎docs/concepts/flow/01-overview.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ linear and can be defined as:
1212
\text{amount owed} = rps \cdot \text{elapsed time}
1313
```
1414

15-
Flow protocol can be used in several areas of everyday finance, such as payroll, distributing grants, insurance
15+
The Flow protocol can be used in several areas of everyday finance, such as payroll, distributing grants, insurance
1616
premiums, loans interest, token ESOPs etc. If you are looking for vesting and airdrops, please refer to our
1717
[Lockup](../lockup/overview) protocol.
1818

@@ -32,6 +32,19 @@ premiums, loans interest, token ESOPs etc. If you are looking for vesting and ai
3232

3333
The definitions below will help you understand some terms used in Sablier Flow:
3434

35+
## Open-Ended Streams
36+
37+
Open-ended streams on Sablier are token streams without a predefined end date. They continue indefinitely until voided
38+
by the sender.
39+
40+
Key traits:
41+
42+
- No end time: the stream has a start date but no fixed stop.
43+
- Funds are streamed continuously at a fixed rate per second.
44+
- Stream must be topped up periodically to maintain solvency,
45+
[debt is otherwise accumulated](/concepts/flow/overview#total-debt).
46+
- Useful for ongoing payments like salaries, grants, or subscriptions.
47+
3548
### Stream balance
3649

3750
Stream balance is the token balance of a stream. It increases when funds are deposited into a stream, and decreases when

‎docs/concepts/lockup/02-stream-shapes.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,42 @@ vary as there are multiple factors to consider.
293293

294294
:::
295295

296+
### Backweighted
297+
298+
Backweighted is a type of tranched vesting curve where the tokens are vested in a backweighted way, meaning little vests early on, and large chunks vest towards the end.
299+
300+
Example for a 4-year vesting schedule:
301+
302+
- Year 1: 10% vests
303+
- Year 2: 20% vests
304+
- Year 3: 30% vests
305+
- Year 4: 40% vests
306+
307+
This makes it a particularly good fit for recipients that need to be particularly incentivized on a long-term perspective, as they receive progressively more and more tokens as the stream gets closer to its end date.
308+
309+
<FunctionPlot
310+
options={{
311+
data: [
312+
{
313+
points: [
314+
[0.01, 0.01],
315+
[25, 0],
316+
[25, 10],
317+
[50, 10],
318+
[50, 30],
319+
[75, 30],
320+
[75, 60],
321+
[99.99, 60],
322+
[99.99, 99.99],
323+
],
324+
fnType: "points",
325+
graphType: "polyline",
326+
color: "#f77423",
327+
},
328+
],
329+
}}
330+
/>
331+
296332
### Timelock
297333

298334
The Timelock shape locks all tokens for a specified period. Users cannot access the tokens until the set period elapses.

‎package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"@heroicons/react": "^2.2",
3535
"@mdx-js/react": "~3.0.1",
3636
"@vercel/analytics": "^1.5",
37+
"ajv": "^8.17.1",
3738
"clsx": "^2.1",
3839
"docusaurus-theme-github-codeblock": "^2.0",
3940
"function-plot": "^1.25",

0 commit comments

Comments
 (0)