Deprecate a lot of patterns

cardano-api/internal/Cardano/Api/Address.hs

@@ -211,11 +211,13 @@ instance HasTypeProxy addrtype => HasTypeProxy (Address addrtype) where
   data AsType (Address addrtype) = AsAddress (AsType addrtype)
   proxyToAsType _ = AsAddress (proxyToAsType (Proxy :: Proxy addrtype))
 
+{-# DEPRECATED AsByronAddress "Use AsAddress AsByronAddr instead" #-}
 pattern AsByronAddress :: AsType (Address ByronAddr)
 pattern AsByronAddress = AsAddress AsByronAddr
 
 {-# COMPLETE AsByronAddress #-}
 
+{-# DEPRECATED AsShelleyAddress "Use AsAddress AsShelleyAddr instead" #-}
 pattern AsShelleyAddress :: AsType (Address ShelleyAddr)
 pattern AsShelleyAddress = AsAddress AsShelleyAddr
 

cardano-api/internal/Cardano/Api/Block.hs

@@ -11,6 +11,8 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE ViewPatterns #-}
+-- TODO Delete me when the patterns of this file are removed (they are the ones using deprecated - other - patterns)
+{-# OPTIONS_GHC -Wno-deprecations #-}
 
 -- | Blocks in the blockchain
 module Cardano.Api.Block

cardano-api/internal/Cardano/Api/LedgerState.hs

@@ -325,36 +325,43 @@ applyBlock
 applyBlock env oldState validationMode =
   applyBlock' env oldState validationMode . toConsensusBlock
 
+{-# DEPRECATED LedgerStateByron "Use 'LedgerState $ Consensus.LedgerStateByron' instead" #-}
 pattern LedgerStateByron
   :: Ledger.LedgerState Byron.ByronBlock
   -> LedgerState
 pattern LedgerStateByron st <- LedgerState (Consensus.LedgerStateByron st)
 
+{-# DEPRECATED LedgerStateShelley "Use 'LedgerState $ Consensus.LedgerStateShelley' instead" #-}
 pattern LedgerStateShelley
   :: Ledger.LedgerState Shelley.StandardShelleyBlock
   -> LedgerState
 pattern LedgerStateShelley st <- LedgerState (Consensus.LedgerStateShelley st)
 
+{-# DEPRECATED LedgerStateAllegra "Use 'LedgerState $ Consensus.LedgerStateAllegra' instead" #-}
 pattern LedgerStateAllegra
   :: Ledger.LedgerState Shelley.StandardAllegraBlock
   -> LedgerState
 pattern LedgerStateAllegra st <- LedgerState (Consensus.LedgerStateAllegra st)
 
+{-# DEPRECATED LedgerStateMary "Use 'LedgerState $ Consensus.LedgerStateMary' instead" #-}
 pattern LedgerStateMary
   :: Ledger.LedgerState Shelley.StandardMaryBlock
   -> LedgerState
 pattern LedgerStateMary st <- LedgerState (Consensus.LedgerStateMary st)
 
+{-# DEPRECATED LedgerStateAlonzo "Use 'LedgerState $ Consensus.LedgerAlonzo' instead" #-}
 pattern LedgerStateAlonzo
   :: Ledger.LedgerState Shelley.StandardAlonzoBlock
   -> LedgerState
 pattern LedgerStateAlonzo st <- LedgerState (Consensus.LedgerStateAlonzo st)
 
+{-# DEPRECATED LedgerStateBabbage "Use 'LedgerState $ Consensus.LedgerBabbage' instead" #-}
 pattern LedgerStateBabbage
   :: Ledger.LedgerState Shelley.StandardBabbageBlock
   -> LedgerState
 pattern LedgerStateBabbage st <- LedgerState (Consensus.LedgerStateBabbage st)
 
+{-# DEPRECATED LedgerStateConway "Use 'LedgerState $ Consensus.LedgerConway' instead" #-}
 pattern LedgerStateConway
   :: Ledger.LedgerState Shelley.StandardConwayBlock
   -> LedgerState

cardano-api/internal/Cardano/Api/Script.hs

@@ -929,6 +929,7 @@ fromAlonzoExUnits Alonzo.ExUnits{Alonzo.exUnitsSteps, Alonzo.exUnitsMem} =
 -- Alonzo mediator pattern
 --
 
+{-# DEPRECATED PlutusScriptBinary "Use Plutus.Plutus (Plutus.PlutusBinary script) instead" #-}
 pattern PlutusScriptBinary :: Plutus.PlutusLanguage l => ShortByteString -> Plutus.Plutus l
 pattern PlutusScriptBinary script = Plutus.Plutus (Plutus.PlutusBinary script)
 

cardano-api/internal/Cardano/Api/Tx/Sign.hs

@@ -183,16 +183,19 @@ instance HasTypeProxy era => HasTypeProxy (Tx era) where
   data AsType (Tx era) = AsTx (AsType era)
   proxyToAsType _ = AsTx (proxyToAsType (Proxy :: Proxy era))
 
+{-# DEPRECATED AsMaryTx "Use 'AsTx AsMaryEra' instead." #-}
 pattern AsMaryTx :: AsType (Tx MaryEra)
 pattern AsMaryTx = AsTx AsMaryEra
 
 {-# COMPLETE AsMaryTx #-}
 
+{-# DEPRECATED AsAllegraTx "Use 'AsTx AsAllegraEra' instead." #-}
 pattern AsAllegraTx :: AsType (Tx AllegraEra)
 pattern AsAllegraTx = AsTx AsAllegraEra
 
 {-# COMPLETE AsAllegraTx #-}
 
+{-# DEPRECATED AsAlonzoTx "Use 'AsTx AsAlonzoEra' instead." #-}
 pattern AsAlonzoTx :: AsType (Tx AlonzoEra)
 pattern AsAlonzoTx = AsTx AsAlonzoEra
 
@@ -473,16 +476,19 @@ instance HasTypeProxy era => HasTypeProxy (TxBody era) where
   data AsType (TxBody era) = AsTxBody (AsType era)
   proxyToAsType _ = AsTxBody (proxyToAsType (Proxy :: Proxy era))
 
+{-# DEPRECATED AsByronTxBody "Use 'AsTxBody AsByronEra' instead." #-}
 pattern AsByronTxBody :: AsType (TxBody ByronEra)
 pattern AsByronTxBody = AsTxBody AsByronEra
 
 {-# COMPLETE AsByronTxBody #-}
 
+{-# DEPRECATED AsShelleyTxBody "Use 'AsTxBody AsShelleyEra' instead." #-}
 pattern AsShelleyTxBody :: AsType (TxBody ShelleyEra)
 pattern AsShelleyTxBody = AsTxBody AsShelleyEra
 
 {-# COMPLETE AsShelleyTxBody #-}
 
+{-# DEPRECATED AsMaryTxBody "Use 'AsTxBody AsMaryEra' instead." #-}
 pattern AsMaryTxBody :: AsType (TxBody MaryEra)
 pattern AsMaryTxBody = AsTxBody AsMaryEra
 
@@ -658,11 +664,13 @@ instance HasTypeProxy era => HasTypeProxy (KeyWitness era) where
   data AsType (KeyWitness era) = AsKeyWitness (AsType era)
   proxyToAsType _ = AsKeyWitness (proxyToAsType (Proxy :: Proxy era))
 
+{-# DEPRECATED AsByronWitness "Use AsKeyWitness AsByronEra instead" #-}
 pattern AsByronWitness :: AsType (KeyWitness ByronEra)
 pattern AsByronWitness = AsKeyWitness AsByronEra
 
 {-# COMPLETE AsByronWitness #-}
 
+{-# DEPRECATED AsShelleyWitness "Use AsKeyWitness AsShelleyEra instead" #-}
 pattern AsShelleyWitness :: AsType (KeyWitness ShelleyEra)
 pattern AsShelleyWitness = AsKeyWitness AsShelleyEra
 
@@ -741,6 +749,7 @@ instance IsCardanoEra era => HasTextEnvelope (KeyWitness era) where
 getTxBodyAndWitnesses :: Tx era -> (TxBody era, [KeyWitness era])
 getTxBodyAndWitnesses tx = (getTxBody tx, getTxWitnesses tx)
 
+-- | This pattern will be deprecated in the future. We advise against introducing new usage of it.
 pattern Tx :: TxBody era -> [KeyWitness era] -> Tx era
 pattern Tx txbody ws <- (getTxBodyAndWitnesses -> (txbody, ws))
   where

cardano-api/test/cardano-api-test/Test/Cardano/Api/Address.hs

@@ -24,11 +24,11 @@ import           Test.Tasty.Hedgehog (testProperty)
 
 prop_roundtrip_shelley_address :: Property
 prop_roundtrip_shelley_address =
-  roundtrip_serialise_address AsShelleyAddress genAddressShelley
+  roundtrip_serialise_address (AsAddress AsShelleyAddr) genAddressShelley
 
 prop_roundtrip_byron_address :: Property
 prop_roundtrip_byron_address =
-  roundtrip_serialise_address AsByronAddress genAddressByron
+  roundtrip_serialise_address (AsAddress AsByronAddr) genAddressByron
 
 -- -----------------------------------------------------------------------------
 

cardano-api/test/cardano-api-test/Test/Cardano/Api/Bech32.hs

@@ -3,7 +3,7 @@ module Test.Cardano.Api.Bech32
   )
 where
 
-import           Cardano.Api (AsType (AsShelleyAddress, AsStakeAddress))
+import           Cardano.Api (AsType (AsAddress, AsShelleyAddr, AsStakeAddress))
 
 import           Test.Gen.Cardano.Api.Typed (genAddressShelley, genStakeAddress)
 
@@ -13,7 +13,7 @@ import           Test.Tasty (TestTree, testGroup)
 import           Test.Tasty.Hedgehog (testProperty)
 
 prop_roundtrip_Address_Shelley :: Property
-prop_roundtrip_Address_Shelley = roundtrip_Bech32 AsShelleyAddress genAddressShelley
+prop_roundtrip_Address_Shelley = roundtrip_Bech32 (AsAddress AsShelleyAddr) genAddressShelley
 
 prop_roundtrip_StakeAddress :: Property
 prop_roundtrip_StakeAddress = roundtrip_Bech32 AsStakeAddress genStakeAddress

cardano-api/test/cardano-api-test/Test/Cardano/Api/RawBytes.hs

@@ -23,11 +23,11 @@ import           Test.Tasty.Hedgehog (testProperty)
 
 prop_roundtrip_shelley_address_raw :: Property
 prop_roundtrip_shelley_address_raw =
-  roundtrip_raw_bytes AsShelleyAddress genAddressShelley
+  roundtrip_raw_bytes (AsAddress AsShelleyAddr) genAddressShelley
 
 prop_roundtrip_byron_address_raw :: Property
 prop_roundtrip_byron_address_raw =
-  roundtrip_raw_bytes AsByronAddress genAddressByron
+  roundtrip_raw_bytes (AsAddress AsByronAddr) genAddressByron
 
 prop_roundtrip_stake_address_raw :: Property
 prop_roundtrip_stake_address_raw =