docs(xsnap): protocol state diagram

Agoric · Mar 18, 2021 · 23e99c1 · 23e99c1
1 parent 4cbfd67
commit 23e99c1
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 0 deletions.
diff --git a/packages/xsnap/README.md b/packages/xsnap/README.md
@@ -43,6 +43,8 @@ The parent and child communicate using "commands".
 - The Node.js parent can implement an asynchronous `handleCommand` function to
   respond to commands from the XS child.
 
+![state diagram](doc/xsnap-states.svg)
+
 # xsrepl
 
 With `xsnap` comes an `xsrepl` command line tool.

diff --git a/packages/xsnap/doc/xsnap-states.dot b/packages/xsnap/doc/xsnap-states.dot
@@ -0,0 +1,8 @@
+digraph G {
+ idle -> idle [label="snapshot"]
+ idle -> running [label="rx:eval"]
+ idle -> running [label="rx:handleCommand"]
+ running -> sysCalling [label="tx:issueCommand"]
+ sysCalling -> running [label="rx:response"]
+ running -> idle [label="tx:response"]
+}
diff --git a/packages/xsnap/doc/xsnap-states.svg b/packages/xsnap/doc/xsnap-states.svg