Changes requested for StateMachine.sol

contracts/drafts/state/README.md → contracts/state/README.md

@@ -26,6 +26,6 @@ In `StateMachine.sol`:
 * constructor: Creates the setup state and updates currentState to it.
 
 * function `stateExists(bytes32 _state)`: Returns `true` if `_state` exists.
-* function `createState(bytes32 _state`: Adds a new state with id `_state` to the contract. There is no function to remove states.
-* function `createTransition(bytes32 _originState, bytes32 _targetState)`: Adds a transition from `_originState` to `_targetState`.
-* function `transition(bytes32 _targetState)`: Transitions the machine from `currentState` to `_targetState`.
+* function `_createState(bytes32 _state`: Adds a new state with id `_state` to the contract. There is no function to remove states.
+* function `_createTransition(bytes32 _originState, bytes32 _targetState)`: Adds a transition from `_originState` to `_targetState`.
+* function `_transition(bytes32 _targetState)`: Transitions the machine from `currentState` to `_targetState`.

contracts/drafts/state/StateMachine.sol → contracts/state/StateMachine.sol

@@ -55,8 +55,8 @@ contract StateMachine {
     /**
      * @dev Create a new state.
      */
-    function createState(bytes32 _state)
-        public
+    function _createState(bytes32 _state)
+        internal
     {
         require(currentState == SETUP_STATE, "State machine not in SETUP.");
         require(!stateExists(_state), "State already exists.");
@@ -71,8 +71,8 @@ contract StateMachine {
     /**
      * @dev Create a transition between two states.
      */
-    function createTransition(bytes32 _originState, bytes32 _targetState)
-        public
+    function _createTransition(bytes32 _originState, bytes32 _targetState)
+        internal
     {
         require(currentState == SETUP_STATE, "State machine not in SETUP.");
         require(stateExists(_originState), "Origin state doesn't exist.");
@@ -85,8 +85,8 @@ contract StateMachine {
     /**
      * @dev Transition the state machine between states
      */
-    function transition(bytes32 _targetState)
-        public
+    function _transition(bytes32 _targetState)
+        internal
     {
         require(stateExists(_targetState), "Target state doesn't exist.");
         State memory originState = states[currentState];

contracts/state/TestStateMachine.sol

@@ -0,0 +1,23 @@
+pragma solidity ^0.5.10;
+
+import "./StateMachine.sol";
+
+
+contract TestStateMachine is StateMachine {
+
+    function createState(bytes32 _state) external {
+        _createState(_state);
+    }
+
+    function createTransition(
+        bytes32 _originState,
+        bytes32 _targetState
+    ) external {
+        _createTransition(_originState, _targetState);
+    }
+
+    function transition(bytes32 _targetState) external {
+        _transition(_targetState);
+    }
+
+}

test/drafts/state/StateMachine.test.ts → test/state/StateMachine.test.ts

@@ -1,14 +1,14 @@
 import { should } from 'chai';
-import { StateMachineInstance } from '../../../types/truffle-contracts';
+import { TestStateMachineInstance } from '../../types/truffle-contracts';
 
-const StateMachine = artifacts.require('./state/StateMachine.sol') as Truffle.Contract<StateMachineInstance>;
+const StateMachine = artifacts.require('./state/TestStateMachine.sol') as Truffle.Contract<TestStateMachineInstance>;
 should();
 
 // tslint:disable-next-line no-var-requires
-const { itShouldThrow } = require('./../../utils');
+const { itShouldThrow } = require('./../utils');
 
-contract('StateMachine', (accounts) => {
-    let stateMachine: StateMachineInstance;
+contract('TestStateMachine', (accounts) => {
+    let stateMachine: TestStateMachineInstance;
     const SETUP_STATE = 'SETUP';
     const NEW_STATE = 'NEW';