State machine scaffolding

[sapinb]

Description

scaffolding for state machine integration + some other traits. Still messy, but I'm trying to keep the mess away from the cac protocol state machine.

mosaic-cac-protocol hold the protocol state machines (garbler setup, evaluator setup, garbler deposit, evaluator deposit) and these are based on StateMachineSpec trait. This will only deal with state, inputs and actions.

StateMachineAdaptorSpec impls (1 - 1 with protocol state machines) hold the messier bits of translating between network/job messages and the protocol state machine inputs, actions.

StateMachineExecutor<StateMachineAdaptorSpec> is responsible for running all state machines of a given type and manage its inputs and outputs.

a Router component (TODO) will handle coordination between the 4 types of state machine executors and the other parts of the system (rpc, p2p, jobs)

Storage is currently divided into 2 parts: StateMachineDb and JobStateDb.
A third storage, ArtifactDb may be required if storing ~200mb blobs (adaptors, polynomial commitments) in the state directly proves problematic.

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Refactor
• New or updated tests
• Dependency update
• Security fix

Notes to Reviewers

Checklist

• I have performed a self-review of my code.
• I have commented my code where necessary.
• I have updated the documentation if needed.
• My changes do not introduce new warnings.
• I have added tests that prove my changes are effective or that my feature works.
• New and existing tests pass with my changes.

Related Issues