adklempner / state-machine-builder Goto Github PK

Import error in StateMachineBuilder.sol

I'm leaning towards using the Ethereum Natural Specification Format in the code and generating docs with Digix's Doxity (example here )

Another option is Read the Docs

Huge barrier to user on-boarding of decentralized applications is paying for gas.

Let's add another version of the performStateChange method that accepts two additional parameters: bytes32 hash, bytes sig and uses Zeppelin's ECRecovery library to allow anyone to submit a TX on the signer's behalf.

If this pattern can work in StateMachineBuilder it'll be worth releasing a generic version, probably as a new addition to the OpenZeppelin library.

Inspired by TrueBit's incentive layer contracts that use a state machine with timeout restrictions

Solium's repo and Getting Started guide

Aragon uses very sophisticated Access Control List contracts for aragonOS. Let's explore the possibility of implementing these same contracts (perhaps with modifications) for managing our permissions system.

Create a CONTRIBUTING.md file that outlines the contribution process

Good examples:

• OpenZeppelin
• Gitcoin
• Atom

Implement solidity-coverage for the repo

The data specifying the requirements for performing a state transition is stored in the Transition struct in the State library, violating the single responsibility principle.

In order to keep the core contracts as simple, modular and extensible as possible, it's best to think of the transitionGraph as a labeled directed graph.

        nodeA              nodeB      label
mapping(bytes32 => mapping(bytes32 => bytes32)) transitionGraph;

Here's how the graph below would be stored in the transitionGraph mapping (assume strings are converted to bytes32)

transitionGraph["a"]["b"] = "1"
transitionGraph["b"]["c"] = "2"
transitionGraph["c"]["d"] = "3"
transitionGraph["d"]["a"] = "4"
transitionGraph["a"]["c"] = "5"
transitionGraph["c"]["a"] = "6"

In the same way the meaning of each node is interpreted by the implementing contract (and perhaps even further above, by the application at large), so should the meaning of each label.

Flagging a transition as networked does not specify the details of the transition (which builder, machine, process, and state), it only requires that a transition is successfully performed.

Getting Started Guide

Examples of YAML files from other Solidity projects:

• OpenZeppelin
• WindingTree
• Aragon