chore: comments in the code, reformat

Author: euonymos

docs/getting_started.md

@@ -175,8 +175,7 @@ data ResolvedTx = MkResolvedTx
   , toMint :: TxMintValue BuildTx Era
   , interval :: Interval POSIXTime
   , additionalSigners :: [PubKeyHash]
-  , -- FIXME
-    signer :: ~(SigningKey PaymentKey)
+  , signer :: ~(SigningKey PaymentKey)
   }
   deriving stock (Show, Eq)
 
@@ -302,7 +301,7 @@ data TxConstraint (resolved :: Bool) script
       -- | Value being matched by its Spine
       (DSLPattern resolved script sop)
       -- | Case switch
-      -- FIXME: might use function instead, will bring `_` syntax,
+      -- TODO: might use function instead, will bring `_` syntax,
       -- reusing matched var and probably implicitly type-checking spine
       -- by saving it to such var DSL value
       (Map.Map (Spine sop) (TxConstraint resolved script))

example/CEM/Example/Auction.hs

@@ -16,8 +16,8 @@ data SimpleAuction
 
 -- | A bid
 data Bid = MkBet
-  { bidder :: PubKeyHash -- FIXME: rename to bidder
-  , bidAmount :: Integer -- FIXME: rename to bidder
+  { bidder :: PubKeyHash
+  , bidAmount :: Integer
   }
   deriving stock (Prelude.Eq, Prelude.Show)
 
@@ -128,14 +128,14 @@ instance CEMScript SimpleAuction where
             , byFlagError (lift False) "Another err"
             , -- Example: In constraints redundant for on-chain
               offchainOnly
-                (if'
-                  (ctxParams.seller `eq'` buyoutBid.bidder)
-                  (signedBy ctxParams.seller)
-                  (spentBy
-                    buyoutBid.bidder
-                    (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.bidAmount)
-                    cEmptyValue
-                  )
+                ( if'
+                    (ctxParams.seller `eq'` buyoutBid.bidder)
+                    (signedBy ctxParams.seller)
+                    ( spentBy
+                        buyoutBid.bidder
+                        (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.bidAmount)
+                        cEmptyValue
+                    )
                 )
             , output
                 (userUtxo buyoutBid.bidder) -- NOTE: initial zero bidder is seller
@@ -144,8 +144,8 @@ instance CEMScript SimpleAuction where
                 (ctxParams.seller `eq'` buyoutBid.bidder)
                 noop
                 ( output
-                  (userUtxo ctxParams.seller)
-                  (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.bidAmount)
+                    (userUtxo ctxParams.seller)
+                    (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.bidAmount)
                 )
             ]
           )

src/Cardano/CEM.hs

@@ -8,7 +8,6 @@ import Cardano.CEM.Address as X (
   cemScriptPlutusCredential,
  )
 import Cardano.CEM.Compile as X
-import Cardano.CEM.Documentation as X (genCemGraph)
 import Cardano.CEM.DSL as X (
   CEMScript (..),
   CEMScriptDatum,
@@ -17,6 +16,7 @@ import Cardano.CEM.DSL as X (
   RecordSetter ((::=)),
   TxConstraint,
  )
+import Cardano.CEM.Documentation as X (genCemGraph)
 import Cardano.CEM.Monads as X
 import Cardano.CEM.Monads.CLB as X
 import Cardano.CEM.OffChain as X

src/Cardano/CEM/DSL.hs

@@ -122,7 +122,7 @@ data ConstraintDSL script value where
     Proxy label ->
     ConstraintDSL script value
   -- | Builds a datatype value from the spine and field setters.
-  -- Used in Utxo Out spec.
+  -- Used in Utxo Out spec. Only specified fields are compared.
   UnsafeOfSpine ::
     forall script datatype spine.
     ( spine ~ Spine datatype
@@ -173,7 +173,7 @@ instance Show (ConstraintDSL x y) where
     (GetField valueDsl proxyLabel) ->
       show valueDsl <> "." <> symbolVal proxyLabel
     Eq x y -> show x <> " @== " <> show y
-    -- FIXME: add user annotations
+    -- TODO: add user annotations
     LiftPlutarch _ x -> "somePlutarchCode (" <> show x <> ")"
     LiftPlutarch2 _ x y ->
       "somePlutarchCode (" <> show x <> ") (" <> show y <> ")"
@@ -346,9 +346,10 @@ class
   -- | The crux part - a map that defines constraints for each transition via DSL.
   transitionSpec :: CEMScriptSpec False script
 
-  -- | Optional Plutus script to calculate things, which can be used in the cases
-  -- when CEM constraints and/or inlining Plutarch functions are not expressible
-  -- enough.
+  -- | Optional Plutus script to calculate a value of type
+  -- (TransitionComp script), which can be used in the cases
+  -- when CEM constraints and/or inlining Plutarch functions
+  -- are not expressive enough.
   transitionComp ::
     Maybe
       ( Params script ->
@@ -385,6 +386,7 @@ class CEMScriptTypes script where
   -- | See 'transitionComp'
   type TransitionComp script
 
+  -- | By default it's not set.
   type TransitionComp script = Void
 
 -- | Options used for compiling.

src/Cardano/CEM/OffChain.hs

@@ -118,7 +118,6 @@ queryScriptState params = do
   mTxInOut <- queryScriptTxInOut params
   return (cemTxOutState . snd =<< mTxInOut)
 
--- FIXME: doc, naming
 data OffchainTxIR
   = TxInR (TxIn, TxInWitness)
   | TxInRefR (TxIn, TxInWitness)
@@ -171,15 +170,16 @@ compileActionConstraints
         throwError CEMScriptTxInResolutionError
 
       let
-        -- FIXME: fromJust laziness trick
+        -- TODO: fromJust laziness trick
         datum = (params, fromJust mState)
         compiled' = map (compileConstraint datum transition) uncompiled
 
-      -- FIXME: raise lefts from compiled
+      -- NB: raise lefts from compiled
       let f x = case x of
             Left message -> throwError $ PerTransitionErrors [CompilationError message]
             Right x' -> return x'
-      -- FIXME: add resolution logging
+
+      -- TODO: add resolution logging
       mapM f compiled'
 
 process ::
@@ -194,7 +194,7 @@ process (MkCEMAction params transition) ec = case ec of
     utxo <- lift $ queryUtxo $ ByAddresses [pubKeyHashAddress $ user c]
     let utxoPairs =
           map (withKeyWitness . fst) $ Map.toList $ unUTxO utxo
-    -- FIXME: do actuall coin selection
+    -- TODO: do actuall coin selection
     return $ TxInR $ head utxoPairs
   c@(Utxo kind fanFilter value) -> do
     case kind of
@@ -213,7 +213,7 @@ process (MkCEMAction params transition) ec = case ec of
             map (addWittness . fst) $ filter predicate utxoPairs
         case matchingUtxos of
           x : _ -> return $ case someIn of
-            -- FIXME: log/fail on >1 options to choose for script
+            -- TODO: log/fail on >1 options to choose for script
             In -> TxInR x
             InRef -> TxInRefR x
           [] ->
@@ -222,7 +222,7 @@ process (MkCEMAction params transition) ec = case ec of
       predicate (_, txOut) =
         txOutValue txOut == fromPlutusValue value
           && case fanFilter of
-            -- FIXME: refactor DRY
+            -- TODO: refactor DRY
             SameScript (MkSameScriptArg state) ->
               cemTxOutDatum txOut
                 == Just
@@ -240,9 +240,10 @@ process (MkCEMAction params transition) ec = case ec of
               , state
               )
           )
-      -- FIXME: understand what is happening
+
       convertTxOut x =
         TxOutValueShelleyBased shelleyBasedEra $ toMaryValue x
+
       addWittness = case fanFilter of
         UserAddress {} -> withKeyWitness
         SameScript {} -> (,scriptWitness)
@@ -315,7 +316,7 @@ awaitTx txId = do
   go 5
   where
     go :: Integer -> m ()
-    go 0 = liftIO $ fail "Tx was not awaited." -- FIXME:
+    go 0 = liftIO $ fail "Tx was not awaited."
     go n = do
       exists <- checkTxIdExists
       liftIO $ threadDelay 1_000_000
@@ -404,7 +405,7 @@ compileDsl datum@(params, state) transition dsl = case dsl of
   UnsafeUpdateOfSpine valueDsl _spine setters -> do
     case setters of
       [] -> recur valueDsl
-      _ -> error "FIXME: not implemented"
+      _ -> error "Not implemented yet."
   LiftPlutarch pterm argDsl -> do
     arg <- recur argDsl
     case evalTerm NoTracing $ pterm # pconstant arg of

src/Cardano/CEM/Smart.hs

@@ -68,7 +68,7 @@ cOfSpine ::
   Spine datatype ->
   [RecordSetter (ConstraintDSL script) datatype] ->
   ConstraintDSL script datatype
--- FIXME: should it be ordered?
+-- TODO: should it be ordered?
 cOfSpine spine setters =
   if toInteger (length setters) == toInteger (spineFieldsNum spine)
     then UnsafeOfSpine spine setters