refactor tests of the effect

* test both the effect and governor in the spec
* test that the effect and governor will fail when try setting the
  governor state to a invalid one

agora-sample/Sample/Effect/GovernorMutation.hs

@@ -1,9 +1,14 @@
 module Sample.Effect.GovernorMutation (
-  validContext,
+  mkEffectTransaction,
   effectValidator,
   effectValidatorAddress,
   effectValidatorHash,
   atAssetClass,
+  govRef,
+  effectRef,
+  invalidNewGovernorDatum,
+  validNewGovernorDatum,
+  mkEffectDatum,
 ) where
 
 import Agora.Effect.GovernorMutation (
@@ -11,14 +16,13 @@ import Agora.Effect.GovernorMutation (
   mutateGovernorValidator,
  )
 import Agora.Governor (GovernorDatum (..))
-import Agora.Proposal (ProposalId (..))
+import Agora.Proposal (ProposalId (..), ProposalThresholds (..))
 import Plutarch.Api.V1 (mkValidator, validatorHash)
+import Plutarch.SafeMoney (Tagged (Tagged))
 import Plutus.V1.Ledger.Address (scriptHashAddress)
 import Plutus.V1.Ledger.Api (
   Address,
   Datum (..),
-  ScriptContext (..),
-  ScriptPurpose (Spending),
   ToData (..),
   TokenName (..),
   TxInInfo (..),
@@ -42,15 +46,19 @@ import Sample.Shared (
  )
 import Test.Util (datumPair, toDatumHash)
 
+-- | The effect validator instance.
 effectValidator :: Validator
 effectValidator = mkValidator $ mutateGovernorValidator governor
 
+-- | The hash of the validator instance.
 effectValidatorHash :: ValidatorHash
 effectValidatorHash = validatorHash effectValidator
 
+-- | The address of the validator.
 effectValidatorAddress :: Address
 effectValidatorAddress = scriptHashAddress effectValidatorHash
 
+-- | The assetclass of the authority token.
 atAssetClass :: AssetClass
 atAssetClass = assetClass authorityTokenSymbol tokenName
   where
@@ -58,20 +66,36 @@ atAssetClass = assetClass authorityTokenSymbol tokenName
     ValidatorHash bs = effectValidatorHash
     tokenName = TokenName bs
 
-validContext :: ScriptContext
-validContext =
+-- | The mock reference of the governor state UTXO.
+govRef :: TxOutRef
+govRef = TxOutRef "614481d2159bfb72350222d61fce17e548e0fc00e5a1f841ff1837c431346ce7" 1
+
+-- | The mock reference of the effect UTXO.
+effectRef :: TxOutRef
+effectRef = TxOutRef "c31164dc11835de7eb6187f67d0e1a19c1dfc0786a456923eef5043189cdb578" 1
+
+-- | The input effect datum in 'mkEffectTransaction'.
+mkEffectDatum :: GovernorDatum -> MutateGovernorDatum
+mkEffectDatum newGovDatum =
+  MutateGovernorDatum
+    { governorRef = govRef
+    , newDatum = newGovDatum
+    }
+
+{- | Given the new governor state, create an effect to update the governor's state.
+
+    Note that the transaction is valid only if the given new datum is valid.
+-}
+mkEffectTransaction :: GovernorDatum -> TxInfo
+mkEffectTransaction newGovDatum =
   let gst = Value.assetClassValue govAssetClass 1
       at = Value.assetClassValue atAssetClass 1
 
+      -- One authority token is burnt in the process.
       burnt = Value.assetClassValue atAssetClass (-1)
 
       --
 
-      governorInputRef :: TxOutRef
-      governorInputRef = TxOutRef "614481d2159bfb72350222d61fce17e548e0fc00e5a1f841ff1837c431346ce7" 1
-
-      --
-
       governorInputDatum' :: GovernorDatum
       governorInputDatum' =
         GovernorDatum
@@ -92,21 +116,14 @@ validContext =
 
       -- The effect should update 'nextProposalId'
       effectInputDatum' :: MutateGovernorDatum
-      effectInputDatum' =
-        MutateGovernorDatum
-          { governorRef = governorInputRef
-          , newDatum =
-              governorInputDatum'
-                { nextProposalId = ProposalId 42
-                }
-          }
+      effectInputDatum' = mkEffectDatum newGovDatum
       effectInputDatum :: Datum
       effectInputDatum = Datum $ toBuiltinData effectInputDatum'
       effectInput :: TxOut
       effectInput =
         TxOut
           { txOutAddress = effectValidatorAddress
-          , txOutValue = at
+          , txOutValue = at -- The effect carry an authotity token.
           , txOutDatumHash = Just $ toDatumHash effectInputDatum
           }
 
@@ -123,27 +140,35 @@ validContext =
           , txOutValue = mconcat [gst, minAda]
           , txOutDatumHash = Just $ toDatumHash governorOutputDatum
           }
-
-      --
-
-      ownInputRef :: TxOutRef
-      ownInputRef = TxOutRef "c31164dc11835de7eb6187f67d0e1a19c1dfc0786a456923eef5043189cdb578" 1
-   in ScriptContext
-        { scriptContextPurpose = Spending ownInputRef
-        , scriptContextTxInfo =
-            TxInfo
-              { txInfoInputs =
-                  [ TxInInfo ownInputRef effectInput
-                  , TxInInfo governorInputRef governorInput
-                  ]
-              , txInfoOutputs = [governorOutput]
-              , txInfoFee = Value.singleton "" "" 2
-              , txInfoMint = burnt
-              , txInfoDCert = []
-              , txInfoWdrl = []
-              , txInfoValidRange = Interval.always
-              , txInfoSignatories = [signer]
-              , txInfoData = datumPair <$> [governorInputDatum, governorOutputDatum, effectInputDatum]
-              , txInfoId = "4dae3806cc69615b721d52ed09b758f43f25a8f39b7934d6b28514caf71f5f7b"
-              }
+   in TxInfo
+        { txInfoInputs =
+            [ TxInInfo effectRef effectInput
+            , TxInInfo govRef governorInput
+            ]
+        , txInfoOutputs = [governorOutput]
+        , txInfoFee = Value.singleton "" "" 2
+        , txInfoMint = burnt
+        , txInfoDCert = []
+        , txInfoWdrl = []
+        , txInfoValidRange = Interval.always
+        , txInfoSignatories = [signer]
+        , txInfoData = datumPair <$> [governorInputDatum, governorOutputDatum, effectInputDatum]
+        , txInfoId = "4dae3806cc69615b721d52ed09b758f43f25a8f39b7934d6b28514caf71f5f7b"
         }
+
+validNewGovernorDatum :: GovernorDatum
+validNewGovernorDatum =
+  GovernorDatum
+    { proposalThresholds = defaultProposalThresholds
+    , nextProposalId = ProposalId 42
+    }
+
+invalidNewGovernorDatum :: GovernorDatum
+invalidNewGovernorDatum =
+  GovernorDatum
+    { proposalThresholds =
+        defaultProposalThresholds
+          { countVoting = Tagged (-1)
+          }
+    , nextProposalId = ProposalId 42
+    }

agora-sample/Sample/Governor.hs

@@ -502,7 +502,7 @@ mintGATs =
     The effect script should carry an valid tagged authority token,
       and said token will be burnt in the transaction. We use 'noOpValidator'
       here as a mock effect, so no actual change is done to the governor state.
-    TODO: use 'mutateGovernorEffect' as the mock effect in the future.
+    TODO: use 'Agora.Effect.GovernorMutation.mutateGovernorEffect' as the mock effect in the future.
 
     The governor will ensure the new governor state is valid.
 -}