Skip to content

Commit

Permalink
refactor: update statuses page (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
@maxdesalle
maxdesalle committed Jun 25, 2023
1 parent f01ea9c commit 082f2bb
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/concepts/protocol/04-statuses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ title: "Statuses"

A Sablier stream can have one of four distinct statuses, as shown in the table below:

| Status | Description |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| NULL | The stream has not been created yet. This is the default value. |
| ACTIVE | The stream has been created and it is active, indicating that assets are either in the process of being streamed or have yet to be withdrawn. |
| CANCELED | The stream has been canceled. |
| DEPLETED | The stream has been depleted, meaning all assets have been withdrawn. |
| Status | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| NULL | The stream has not been created yet. This is the default value. |
| PENDING | The has been created, but hasn't yet started, it's in a pending state. |
| STREAMING | The stream has been created and it is active, assets are being streamed. |
| SETTLED | All assets have been streamed, the recipient is due to withdraw them. |
| CANCELED | The stream has been canceled, remaining assets (those that were streamed before the cancellation) await for the recipient's withdrawal. |
| DEPLETED | The stream has been depleted, meaning all assets have been withdrawn. |

## What to do with a stream status?

Expand Down

0 comments on commit 082f2bb

Please sign in to comment.