Stream 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. |
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?
Knowing the status of a stream can inform your decision making. For example, if a stream is canceled, you know that you can't cancel it again. Or, if a stream is depleted, you know that you can't withdraw any more assets from it.