Walkthrough: Stream status

[PaulRBerg]

I made this diagram that highlights the allowed transitions between stream statuses.

---
title: Stream Status
---
stateDiagram-v2
  direction LR
  state Warm {
    Pending
    Streaming
  }
  state Cold {
    Settled
    Canceled
    Depleted
  }
  Null --> Pending
  Null --> Settled
  Pending --> Streaming
  Pending --> Settled
  Pending --> Canceled
  Streaming --> Settled
  Streaming --> Canceled
  Streaming --> Depleted
  Settled --> Depleted
  Canceled --> Depleted

Loading

[PaulRBerg]

Note: this diagram is now part of the docs website:

https://docs.sablier.com/concepts/protocol/statuses

[smol-ninja]

Thanks for the making this diagram. It is really cool. I am closing this discussion now as it has already been shipped with the docs.

[PaulRBerg]

Thanks! But why close it? I think that "Show and Tell"-like discussions are helpful for external readers of this repository. They might not know that the status is documented on our docs site.