chore: cosmetics

Author: euonymos

example/CEM/Example/Auction.hs

@@ -16,8 +16,8 @@ data SimpleAuction
 
 -- | A bid
 data Bid = MkBet
-  { better :: PubKeyHash
-  , betAmount :: Integer
+  { bidder :: PubKeyHash -- FIXME: rename to bidder
+  , bidAmount :: Integer -- FIXME: rename to bidder
   }
   deriving stock (Prelude.Eq, Prelude.Show)
 
@@ -69,8 +69,8 @@ instance CEMScript SimpleAuction where
       initialBid =
         cOfSpine
           MkBetSpine
-          [ #better ::= ctxParams.seller
-          , #betAmount ::= lift 0
+          [ #bidder ::= ctxParams.seller
+          , #bidAmount ::= lift 0
           ]
 
       auctionValue = cMinLovelace @<> ctxParams.lot
@@ -96,7 +96,7 @@ instance CEMScript SimpleAuction where
           ,
             [ input (ownUtxo $ inState CurrentBidSpine) auctionValue
             , byFlagError
-                (ctxTransition.bid.betAmount @<= ctxState.bid.betAmount)
+                (ctxTransition.bid.bidAmount @<= ctxState.bid.bidAmount)
                 "Bid amount is less or equal to current bid"
             , output
                 ( ownUtxo
@@ -105,7 +105,7 @@ instance CEMScript SimpleAuction where
                       [#bid ::= ctxTransition.bid]
                 )
                 auctionValue
-            , signedBy ctxTransition.bid.better
+            , signedBy ctxTransition.bid.bidder
             ]
           )
         ,
@@ -124,31 +124,28 @@ instance CEMScript SimpleAuction where
           ( BuyoutSpine
           ,
             [ input (ownUtxo $ inState WinnerSpine) auctionValue
+            , byFlagError (lift False) "Some err"
+            , byFlagError (lift False) "Another err"
             , -- Example: In constraints redundant for on-chain
               offchainOnly
-                ( spentBy
-                    buyoutBid.better
-                    ( cMkAdaOnlyValue buyoutBid.betAmount
-                        @<> cMinLovelace
-                    )
+                (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
+                auctionValue
             , if'
-                (ctxParams.seller `eq'` buyoutBid.better)
-                ( output
-                    (userUtxo ctxParams.seller)
-                    (cMinLovelace @<> ctxParams.lot)
-                )
-                ( output
-                    (userUtxo buyoutBid.better)
-                    (cMinLovelace @<> ctxParams.lot)
-                )
-            , if'
-                (ctxParams.seller `eq'` buyoutBid.better)
+                (ctxParams.seller `eq'` buyoutBid.bidder)
                 noop
                 ( output
-                    (userUtxo ctxParams.seller)
-                    (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.betAmount)
+                  (userUtxo ctxParams.seller)
+                  (cMinLovelace @<> cMkAdaOnlyValue buyoutBid.bidAmount)
                 )
             ]
           )

src/Cardano/CEM/Testing/StateMachine.hs

@@ -90,7 +90,7 @@ import Prelude
 -- We use mutations to verify that on-chain and off-chain implementations
 -- work the same way:
 --  1. The order of constrainsts doesn't matter
---  2. All non-noop constraints are important - if we remove them both impls stop working.
+--  2. All non-noop constraints are important - if we remove any the app stops working.
 
 data TxMutation
   = RemoveConstraint {num :: Int}
@@ -110,6 +110,7 @@ isNegativeMutation (Just (ShuffleConstraints {})) _ = False
 applyMutation ::
   Maybe TxMutation ->
   [TxConstraint True script] ->
+  -- (mutated, maybe removed constraint)
   ([TxConstraint True script], Maybe (TxConstraint True script))
 applyMutation Nothing cs = (cs, Nothing)
 -- \| Removes num+1 element from the list of constraints

test/CEM/Test/Auction.hs

@@ -58,8 +58,8 @@ auctionSpec = describe "AuctionSpec" $ do
     let
       bid1 =
         MkBet
-          { better = signingKeyToPKH bidder1
-          , betAmount = 1_000_000
+          { bidder = signingKeyToPKH bidder1
+          , bidAmount = 1_000_000
           }
 
     result <-
@@ -111,8 +111,8 @@ auctionSpec = describe "AuctionSpec" $ do
     let
       bid1 =
         MkBet
-          { better = signingKeyToPKH bidder1
-          , betAmount = 0
+          { bidder = signingKeyToPKH bidder1
+          , bidAmount = 0
           }
 
     result <-
@@ -164,18 +164,18 @@ auctionSpec = describe "AuctionSpec" $ do
     let
       initBid =
         MkBet
-          { better = signingKeyToPKH seller
-          , betAmount = 0
+          { bidder = signingKeyToPKH seller
+          , bidAmount = 0
           }
       bid1 =
         MkBet
-          { better = signingKeyToPKH bidder1
-          , betAmount = 3_000_000
+          { bidder = signingKeyToPKH bidder1
+          , bidAmount = 3_000_000
           }
       bid2 =
         MkBet
-          { better = signingKeyToPKH bidder1
-          , betAmount = 4_000_000
+          { bidder = signingKeyToPKH bidder1
+          , bidAmount = 4_000_000
           }
 
     (preBody, utxo) <-
@@ -288,8 +288,8 @@ auctionSpec = describe "AuctionSpec" $ do
     let
       initBid =
         MkBet
-          { better = signingKeyToPKH seller
-          , betAmount = 0
+          { bidder = signingKeyToPKH seller
+          , bidAmount = 0
           }
 
     submitAndCheck $

test/CEM/Test/Dynamic.hs

@@ -63,7 +63,7 @@ instance CEMScriptArbitrary SimpleAuction where
     Just (Winner {}) -> return Buyout
     where
       genBidder = elements (map signingKeyToPKH $ actors $ config dappParams)
-      genBid bid = (betAmount bid +) <$> chooseInteger (0, 100_500)
+      genBid bid = (bidAmount bid +) <$> chooseInteger (0, 100_500)
 
 instance CEMScriptRunModel SimpleAuction where
   performHook