Skip to content

Add state diagram for grant lifecycle (fixes #36) #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cokehill wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add state diagram for grant lifecycle (fixes #36) #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,29 @@ stateDiagram-v2
note right of Cancelled : Grant terminated<br/>No further actions
```

## Grant Lifecycle State Diagram

```mermaid
stateDiagram-v2
[*] --> Proposed : create_grant()
Proposed --> Active : activate_grant()
Proposed --> Cancelled : cancel_grant()
Active --> Cliff : enter_cliff()
Cliff --> Streaming : start_stream()
Streaming --> Paused/Slashed : pause_or_slash()
Paused/Slashed --> Streaming : resume_stream()
Streaming --> Completed : finish_stream()
Streaming --> Cancelled : cancel_during_stream()

note right of Proposed : Admin can create\nAdmin can cancel
note right of Active : Admin can activate\nMay enter cliff
note right of Cliff : System moves to streaming
note right of Streaming : Admin / Oracle actions
note right of Paused/Slashed : Admin/Oracle
note right of Completed : Grants done
note right of Cancelled : Grant terminated


## State Transitions and Permissions

| From State | To State | Trigger | Who Can Trigger |
Expand Down