Mark ControlParameters as deprecated

mlabs-haskell · Feb 6, 2025 · f7e9c5f · f7e9c5f
1 parent 71ca5cf
commit f7e9c5f
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/ytxp-sdk/src/Cardano/YTxP/SDK/ControlParameters.hs b/ytxp-sdk/src/Cardano/YTxP/SDK/ControlParameters.hs
@@ -1,7 +1,11 @@
-{- | Module: Cardano.YTxP.Control.Parameters
-Description: Data required to work with the compiled control scripts
+{- |
+Module      : Cardano.YTxP.Control.Parameters
+Description : Data required to work with the compiled control scripts
+
+This module is consider deprecated. Use Ply instead.
 -}
-module Cardano.YTxP.SDK.ControlParameters (
+module Cardano.YTxP.SDK.ControlParameters
+  {-# DEPRECATED "Use Ply instead." #-} (
   -- * Types
   YieldingScripts (..),
   ControlParameters (..),

diff --git a/ytxp-sdk/test/Main.hs b/ytxp-sdk/test/Main.hs
@@ -1,7 +1,25 @@
+{-# OPTIONS_GHC -Wno-deprecations #-}
+
 module Main (main) where
 
-import Cardano.YTxP.SDK.ControlParameters (ControlParameters (ControlParameters), HexStringScript (HexStringScript), YieldingScripts (YieldingScripts, yieldingMintingPolicies, yieldingStakingValidators, yieldingValidator), hexTextToSbs, sbsToHexText)
-import Cardano.YTxP.SDK.Redeemers (AuthorisedScriptIndex (AuthorisedScriptIndex), AuthorisedScriptProofIndex (AuthorisedScriptProofIndex), AuthorisedScriptPurpose (Minting), YieldingRedeemer (YieldingRedeemer))
+import Cardano.YTxP.SDK.ControlParameters (
+  ControlParameters (ControlParameters),
+  HexStringScript (HexStringScript),
+  YieldingScripts (
+    YieldingScripts,
+    yieldingMintingPolicies,
+    yieldingStakingValidators,
+    yieldingValidator
+  ),
+  hexTextToSbs,
+  sbsToHexText,
+ )
+import Cardano.YTxP.SDK.Redeemers (
+  AuthorisedScriptIndex (AuthorisedScriptIndex),
+  AuthorisedScriptProofIndex (AuthorisedScriptProofIndex),
+  AuthorisedScriptPurpose (Minting),
+  YieldingRedeemer (YieldingRedeemer),
+ )
 import Cardano.YTxP.SDK.SdkParameters (
   AuthorisedScriptsSTCS (AuthorisedScriptsSTCS),
   SdkParameters (SdkParameters),