Add haddock for parameters of testNoConfidenceProposal and review

IntersectMBO · May 3, 2024 · 05bcad3 · 05bcad3
1 parent 22df072
commit 05bcad3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 14 deletions.
diff --git a/.../test/cardano-testnet-test/Cardano/Testnet/Test/LedgerEvents/Gov/PredefinedAbstainDRep.hs b/.../test/cardano-testnet-test/Cardano/Testnet/Test/LedgerEvents/Gov/PredefinedAbstainDRep.hs
@@ -148,7 +148,7 @@ delegateToAlwaysAbstain execConfig epochStateView configurationFile socketPath s
   delegateToAutomaticDRep execConfig epochStateView configurationFile socketPath sbe work prefix
                           "--always-abstain"
 
--- | Delegates to a staking key pair with the delegation preference set to automatic.
+-- | Delegates a staking key pair to an automatic DRep.
 delegateToAutomaticDRep
   :: (HasCallStack, MonadTest m, MonadIO m, H.MonadAssertion m, MonadCatch m)  
   => H.ExecConfig -- ^ Specifies the CLI execution configuration.
@@ -159,7 +159,7 @@ delegateToAutomaticDRep
   -> ShelleyBasedEra ConwayEra -- ^ The Shelley based era witness for ConwayEra
   -> FilePath -- ^ Base directory path where generated files will be stored.
   -> String -- ^ Name for the subfolder that will be created under 'work' folder.
-  -> String -- ^ Additional command-line arguments for the delegation.
+  -> String -- ^ Additional command-line argument for the delegation.
   -> PaymentKeyInfo -- ^ Wallet that will pay for the transaction.
   -> StakingKeyPair -- ^ Staking key pair used for delegation.
   -> m ()

diff --git a/.../cardano-testnet-test/Cardano/Testnet/Test/LedgerEvents/Gov/PredefinedNoConfidenceDRep.hs b/.../cardano-testnet-test/Cardano/Testnet/Test/LedgerEvents/Gov/PredefinedNoConfidenceDRep.hs
@@ -317,7 +317,7 @@ makeUpdateConstitutionalCommitteeProposal execConfig epochStateView configuratio
 
   return (governanceActionTxId, governanceActionIndex)
 
--- | Delegate to a staking key pair with the delegation preference set to always no confidence.
+-- | Delegate a staking key pair to the automated no confidence DRep.
 delegateToAlwaysNoConfidence
   :: (MonadTest m, MonadIO m, H.MonadAssertion m, MonadCatch m, HasCallStack)
   => H.ExecConfig -- ^ Specifies the CLI execution configuration.
@@ -335,19 +335,24 @@ delegateToAlwaysNoConfidence execConfig epochStateView configurationFile socketP
   delegateToAutomaticDRep execConfig epochStateView configurationFile socketPath sbe work prefix
                           "--always-no-confidence"
 
+-- Run a no confidence motion and check the result. Vote "yes" with 3 SPOs. Check the no
+-- confidence motion passes.
 testNoConfidenceProposal
   :: (MonadTest m, MonadIO m, H.MonadAssertion m, MonadCatch m, Foldable t, HasCallStack)
-  => H.ExecConfig
-  -> EpochStateView
-  -> FilePath
-  -> FilePath
-  -> ConwayEraOnwards ConwayEra
-  -> FilePath
-  -> FilePath
-  -> PaymentKeyInfo
-  -> (String, Word32)
-  -> t (Int, String)
-  -> Integer
+  => H.ExecConfig -- ^ Specifies the CLI execution configuration.
+  -> EpochStateView -- ^ Current epoch state view for transaction building. It can be obtained
+                    -- using the 'getEpochStateView' function.
+  -> FilePath -- ^ Path to the node configuration file as returned by 'cardanoTestnetDefault'.
+  -> FilePath -- ^ Path to the cardano-node unix socket file.
+  -> ConwayEraOnwards ConwayEra -- ^ The Shelley based era witness for ConwayEra onwards.
+  -> FilePath -- ^ Base directory path where generated files will be stored.
+  -> String -- ^ Name for the subfolder that will be created under 'work' folder.
+  -> PaymentKeyInfo -- ^ Wallet that will pay for the transaction.
+  -> (String, Word32) -- ^ Tuple containing the preivous proposal transaction id and index.
+  -> t (Int, String) -- ^ Model of DRep votes for proposal, list of pairs with an amount
+                     -- of votes and the and type of vote (i.e: "yes", "no", or "abstain").
+  -> Integer -- ^ Epoch till which to wait before checking the result of the no
+             -- confidence proposal passes.
   -> m (String, Word32)
 testNoConfidenceProposal execConfig epochStateView configurationFile socketPath ceo work prefix
                          wallet previousProposalInfo votes waitTillEpoch = do