doc: document on-chain state machines

akash-network / support

Akash Support and Issue Tracking

Apache License 2.0

5 stars 4 forks source link

doc: document on-chain state machines #70

Open boz opened 4 years ago

boz commented 4 years ago

Illustrate (using dot) the state transitions and events that cause them of on-chain objects:

[ ] deployment/deployment
[ ] deployment/group
[ ] market/order
[ ] market/bid
[ ] market/lease

Ropes commented 4 years ago

I'll dig into deployment/deployment, since that's related to https://github.com/ovrclk/akash/pull/620

Are there any example dot files for general layout/guidelines?

Ropes commented 4 years ago

After looping up and down throught he code, this is what the graph looks like for Deployments and Groups. There is a bit of muddying in terms of packages/cosmos module boxes, and action diamonds. Also the rendering needs to be tweaked so labels don't clash. It's a start for outlining how things operate though. deployment dot

Wanted to get feedback on how the basic flow of commands ends up being executed through packages. It's definitely not as consistent as I'd like, but it's a start.

Open to ideas and feedback.