Skip to content

Commit 14acc0c

Browse files
committed
docs: explain Lockup more explicitly
1 parent 2ffacbf commit 14acc0c

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/concepts/protocol/02-stream-types.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@ title: "Types of Streams"
66

77
import FunctionPlot from "@site/src/components/FunctionPlot";
88

9+
## Lockup
10+
11+
"Lockup" is a higher-level category that refers to the requirement that the creator of a stream must lock up a certain
12+
amount of assets in a smart contract. All streams currently supported by Sablier are Lockup streams.
13+
14+
Let's take an example. Imagine Alice wants to stream 3,000 DAI to Bob during the whole month of January.
15+
16+
1. Alice deposits the 3,000 DAI in Sablier before Jan 1, setting the end time to Feb 1.
17+
2. Bob's allocation of the DAI deposit increases every second beginning Jan 1.
18+
3. On Jan 10, Bob has earned approximately 1,000 DAI. He can send a transaction to Sablier to withdraw the tokens.
19+
4. If at any point during January Alice wishes to get back her tokens, she can cancel the stream and recover what has
20+
not been streamed yet.
21+
922
## Lockup Linear
1023

1124
Lockup Linear streams are the simplest type of stream in Sablier. The streamed amount over time follows a straight line
@@ -17,13 +30,6 @@ With this type of stream, the payment rate remains constant, meaning that the sa
1730
streamed to the recipient every second. This provides greater predictability and is easy to understand because of how
1831
intuitive it is. Imagine a diagonal line going up and to the right – that's how simple it is.
1932

20-
:::tip
21-
22-
You will often hear the term **"Lockup"** when dealing with Sablier. This is a term coined by us to describe the
23-
requirement that the sender must lock up a certain amount of assets at the beginning of the stream.
24-
25-
:::
26-
2733
### Cliffs
2834

2935
It is possible to attach a "cliff" to a Lockup Linear stream, which sets a cut-off point for releasing assets. Prior to

0 commit comments

Comments
 (0)