Protocols

protocol.ts is used to specify the configuration of a machine, which describes how a machine operates, and what it does. Each protocol should export the following objects:

• config: the machine's configuration
• mockOptions: (optional) mock options used by the xstate visualizer
• Init: A type indicating the initial context required by the machine
• machine: (store: IStore, context?: Init) => StateMachine<Init, any, any>
  • Most of the behaviour of machines depend in some way on a data store. src/store.ts contains Istore, a "rough draft" of the interface of a store. The machine factory hooks the protocol up to an implementation store of IStore. It also configures invoked services (child machines)
• Guards, Actions, Services, Options: (optional) types indicating what options are required.

Visualization

After updating protocol.ts, run yarn generateConfigs to update protocol.config.js. Configs (protocol.config.json) are used to generate the visualizations using https://xstate.js.org/viz/. There is currently no way to automatically generate the visualization from the config.js file (this is apparently in the works for the new year). The best so far is to copy/paste protocol.config.js into @xstate/viz, and screenshot the visualization.

Runtime

runtime.ts creates two wallets connected to the message service. The first wallet is sent a CREATE_CHANNEL event. This should trigger a JoinChannel protocol in the second protocol.