[#360] [stbx-protocol, stbx-service-rest] updates after review

Author: marcosh

Diff for: stbx-protocol/src/Statebox/Protocol/Store/Handler.purs renamed to stbx-protocol/src/Statebox/Protocol/Store/TransactionExecutionStateHandler.purs

@@ -1,4 +1,4 @@
-module Statebox.Protocol.Store.Handler where
+module Statebox.Protocol.Store.TransactionExecutionStateHandler where
 
 import Prelude
 import Control.Monad.Free (Free, hoistFree, runFreeM)
@@ -27,6 +27,8 @@ hoistToMultipleStores = hoistFree (case _ of
   GetExecutionState    key       next -> ExecutionState (next <$> Store.get key)
   UpdateExecutionState key value next -> ExecutionState (next <$  Store.put key value))
 
+-- | This typeclass describes a natural transformation between `ma` and `m` (if they are functors).
+-- | It allows us to transform naturally instances of `ma` to instances of `m`
 class Embeddable ma m where
   embed :: ∀ a. ma a -> m a
 

Diff for: stbx-service-rest/src/Statebox/Service/Error.purs

@@ -168,17 +168,17 @@ instance decodeJsonTxError :: DecodeJson TxError where
 
 processErrorToTxError :: ProcessError -> TxError
 processErrorToTxError = case _ of
-  NoUberRoot                                                        -> TxNoTxField -- TODO: wrong!
+  NoUberRoot                                                        -> TxNoTxField -- TODO: wrong, not the correct error message!
   InitialPreviousShouldBeUberRoot                  txId             -> RootNonexistPrev {previous: txId}
-  WiringPreviousShouldBeInitial                    txId             -> TxNoTxField -- TODO: wrong!
+  WiringPreviousShouldBeInitial                    txId             -> TxNoTxField -- TODO: wrong, not the correct error message!
   FiringInitialShouldBeCreatedOnlyOnce             txId             -> InitExecExists
   FiringInitialShouldHavePrevious                  txId             -> InitNonexistPrev {previous: txId}
-  FiringInitialPreviousShouldBeWiring              txId             -> InitNonexistPrev {previous: txId} -- TODO: wrong!
-  FiringInitialTransitionShouldBeInitial           txId             -> InitNonexistPrev {previous: txId} -- TODO: wrong!
-  FiringNormalShouldHaveExistingExecution          txId executionId -> InvalidState -- TODO: wrong!
+  FiringInitialPreviousShouldBeWiring              txId             -> InitNonexistPrev {previous: txId} -- TODO: wrong, not the correct error message!
+  FiringInitialTransitionShouldBeInitial           txId             -> InitNonexistPrev {previous: txId} -- TODO: wrong, not the correct error message!
+  FiringNormalShouldHaveExistingExecution          txId executionId -> InvalidState -- TODO: wrong, not the correct error message!
   FiringNormalPreviousShouldMatchCurrentState      txId executionId -> InvalidState
-  FiringNormalExecutionShouldPointToExistingWiring txId executionId -> InvalidState -- TODO: wrong!
-  FiringNormalExecutionWiringShouldBeAWiring       txId executionId -> InvalidState -- TODO: wrong!
+  FiringNormalExecutionShouldPointToExistingWiring txId executionId -> InvalidState -- TODO: wrong, not the correct error message!
+  FiringNormalExecutionWiringShouldBeAWiring       txId executionId -> InvalidState -- TODO: wrong, not the correct error message!
   FiringNormalTransitionShouldBeEnabled            txId executionId -> TxNotEnabled
 
 

Diff for: stbx-service-rest/src/Statebox/Service/Main.purs

@@ -36,7 +36,7 @@ import Statebox.Core.Transaction (TxId, Tx, TxSum(..), uberRootHash)
 import Statebox.Core.Transaction.Codec (encodeTxWith, encodeTxSum)
 import Statebox.Protocol (ProcessError, processTxSum)
 import Statebox.Protocol.ExecutionState (ExecutionState)
-import Statebox.Protocol.Store.Handler (eval) as Store
+import Statebox.Protocol.Store.TransactionExecutionStateHandler (eval) as Store
 import Statebox.Service.Codec (parseBodyToJson, jsonBodyToTxString, txStringToTxJsonString', txJsonStringToTxData', txDataToTxSum')
 import Statebox.Service.Error (ResponseError, TxError(..), processErrorToTxError, responseErrorToTxError, toTxErrorResponseBody)
 import Statebox.Service.Status (Status(..))