Reorganize Orphans module to avoid cyclical dependencies

Author: Jimbo4350

cardano-api/cardano-api.cabal

@@ -84,7 +84,9 @@ library
     Cardano.Api.Internal.IO
     Cardano.Api.Internal.LedgerState
     Cardano.Api.Internal.Modes
-    Cardano.Api.Internal.Orphans
+    Cardano.Api.Internal.Orphans.All
+    Cardano.Api.Internal.Orphans.Serialization
+    Cardano.Api.Internal.Orphans.Misc
     Cardano.Api.Internal.Plutus
     Cardano.Api.Internal.Pretty
     Cardano.Api.Internal.ProtocolParameters

cardano-api/src/Cardano/Api.hs

@@ -1156,7 +1156,7 @@ import Cardano.Api.Internal.Modes
 import Cardano.Api.Internal.Monad.Error
 import Cardano.Api.Internal.NetworkId
 import Cardano.Api.Internal.OperationalCertificate
-import Cardano.Api.Internal.Orphans ()
+import Cardano.Api.Internal.Orphans.All ()
 import Cardano.Api.Internal.Plutus
 import Cardano.Api.Internal.Pretty
 import Cardano.Api.Internal.Protocol

cardano-api/src/Cardano/Api/Internal/CIP/CIP129.hs

@@ -17,31 +17,29 @@ where
 
 import Cardano.Api.Internal.Governance.Actions.ProposalProcedure
 import Cardano.Api.Internal.HasTypeProxy
-import Cardano.Api.Internal.Orphans ()
+import Cardano.Api.Internal.Orphans.All (AsType (..))
 import Cardano.Api.Internal.SerialiseBech32
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.TxIn
 import Cardano.Api.Internal.Utils
 
-import Cardano.Binary qualified as CBOR
 import Cardano.Ledger.Conway.Governance qualified as Gov
 import Cardano.Ledger.Credential (Credential (..))
 import Cardano.Ledger.Credential qualified as L
 import Cardano.Ledger.Keys qualified as L
 
 import Codec.Binary.Bech32 qualified as Bech32
 import Control.Monad (guard)
-import Data.Bifunctor
 import Data.ByteString (ByteString)
 import Data.ByteString qualified as BS
 import Data.ByteString.Base16 qualified as Base16
 import Data.ByteString.Char8 qualified as C8
 import Data.Text (Text)
 import Data.Text.Encoding qualified as Text
 import GHC.Exts (IsList (..))
-import Text.Read
 
 -- | CIP129 is a typeclass that captures the serialisation requirements of https://cips.cardano.org/cip/CIP-0129
+-- which pertain to governance credentials and governance action ids.
 class (SerialiseAsRawBytes a, HasTypeProxy a) => CIP129 a where
   cip129Bech32PrefixFor :: AsType a -> Text
 
@@ -59,20 +57,6 @@ instance CIP129 (Credential L.ColdCommitteeRole) where
       L.KeyHashObj{} -> BS.singleton 0x12 -- 0001 0010
       L.ScriptHashObj{} -> BS.singleton 0x13 -- 0001 0011
 
-instance HasTypeProxy (Credential L.ColdCommitteeRole) where
-  data AsType (Credential L.ColdCommitteeRole) = AsColdCommitteeCredential
-  proxyToAsType _ = AsColdCommitteeCredential
-
-instance SerialiseAsRawBytes (Credential L.ColdCommitteeRole) where
-  serialiseToRawBytes = CBOR.serialize'
-  deserialiseFromRawBytes AsColdCommitteeCredential =
-    first
-      ( \e ->
-          SerialiseAsRawBytesError
-            ("Unable to deserialise Credential ColdCommitteeRole: " ++ show e)
-      )
-      . CBOR.decodeFull'
-
 instance CIP129 (Credential L.HotCommitteeRole) where
   cip129Bech32PrefixFor _ = "cc_hot"
   cip129Bech32PrefixesPermitted AsHotCommitteeCredential = ["cc_hot"]
@@ -81,20 +65,6 @@ instance CIP129 (Credential L.HotCommitteeRole) where
       L.KeyHashObj{} -> BS.singleton 0x02 -- 0000 0010
       L.ScriptHashObj{} -> BS.singleton 0x03 -- 0000 0011
 
-instance HasTypeProxy (Credential L.HotCommitteeRole) where
-  data AsType (Credential L.HotCommitteeRole) = AsHotCommitteeCredential
-  proxyToAsType _ = AsHotCommitteeCredential
-
-instance SerialiseAsRawBytes (Credential L.HotCommitteeRole) where
-  serialiseToRawBytes = CBOR.serialize'
-  deserialiseFromRawBytes AsHotCommitteeCredential =
-    first
-      ( \e ->
-          SerialiseAsRawBytesError
-            ("Unable to deserialise Credential HotCommitteeRole: " ++ show e)
-      )
-      . CBOR.decodeFull'
-
 instance CIP129 (Credential L.DRepRole) where
   cip129Bech32PrefixFor _ = "drep"
   cip129Bech32PrefixesPermitted AsDrepCredential = ["drep"]
@@ -103,19 +73,6 @@ instance CIP129 (Credential L.DRepRole) where
       L.KeyHashObj{} -> BS.singleton 0x22 -- 0010 0010
       L.ScriptHashObj{} -> BS.singleton 0x23 -- 0010 0011
 
-instance HasTypeProxy (Credential L.DRepRole) where
-  data AsType (Credential L.DRepRole) = AsDrepCredential
-  proxyToAsType _ = AsDrepCredential
-
-instance SerialiseAsRawBytes (Credential L.DRepRole) where
-  serialiseToRawBytes = CBOR.serialize'
-  deserialiseFromRawBytes AsDrepCredential =
-    first
-      ( \e ->
-          SerialiseAsRawBytesError ("Unable to deserialise Credential DRepRole: " ++ show e)
-      )
-      . CBOR.decodeFull'
-
 serialiseToBech32CIP129 :: forall a. CIP129 a => a -> Text
 serialiseToBech32CIP129 a =
   Bech32.encodeLenient
@@ -150,7 +107,10 @@ deserialiseFromBech32CIP129 asType bech32Str = do
     Bech32.dataPartToBytes dataPart
       ?! Bech32DataPartToBytesError (Bech32.dataPartToText dataPart)
 
-  let (header, credential) = BS.uncons payload
+  (header, credential) <-
+    case C8.uncons payload of
+      Just (header, credential) -> return (C8.singleton header, credential)
+      Nothing -> Left $ Bech32DeserialiseFromBytesError payload
 
   value <- case deserialiseFromRawBytes asType credential of
     Right a -> Right a
@@ -210,21 +170,3 @@ deserialiseGovActionIdFromBech32CIP129 bech32Str = do
   case deserialiseFromRawBytes AsGovActionId payload of
     Right a -> Right a
     Left _ -> Left $ Bech32DeserialiseFromBytesError payload
-
-instance HasTypeProxy Gov.GovActionId where
-  data AsType Gov.GovActionId = AsGovActionId
-  proxyToAsType _ = AsGovActionId
-
-instance SerialiseAsRawBytes Gov.GovActionId where
-  serialiseToRawBytes (Gov.GovActionId txid (Gov.GovActionIx ix)) =
-    let hex = Base16.encode $ C8.pack $ show ix
-     in mconcat [serialiseToRawBytes $ fromShelleyTxId txid, hex]
-  deserialiseFromRawBytes AsGovActionId bytes = do
-    let (txidBs, index) = BS.splitAt 32 bytes
-
-    txid <- deserialiseFromRawBytes AsTxId txidBs
-    let asciiIndex = C8.unpack $ Base16.decodeLenient index
-    case readMaybe asciiIndex of
-      Just ix -> return $ Gov.GovActionId (toShelleyTxId txid) (Gov.GovActionIx ix)
-      Nothing ->
-        Left $ SerialiseAsRawBytesError $ "Unable to deserialise GovActionId: invalid index: " <> asciiIndex

cardano-api/src/Cardano/Api/Internal/DeserialiseAnyOf.hs

@@ -39,7 +39,7 @@ import Data.Bifunctor (first)
 import Data.ByteString (ByteString)
 import Data.ByteString.Char8 qualified as BSC
 import Data.Char (toLower)
-import Data.Data (Data)
+import Data.Data
 import Data.List.NonEmpty (NonEmpty)
 import Data.Text (Text)
 import Data.Text.Encoding qualified as Text

cardano-api/src/Cardano/Api/Internal/Eon/ShelleyBasedEra.hs

@@ -39,7 +39,7 @@ where
 import Cardano.Api.Internal.Eon.Convert
 import Cardano.Api.Internal.Eras.Core
 import Cardano.Api.Internal.Modes
-import Cardano.Api.Internal.Orphans ()
+import Cardano.Api.Internal.Orphans.All ()
 import Cardano.Api.Internal.Pretty (Pretty)
 
 import Cardano.Crypto.Hash.Blake2b qualified as Blake2b

cardano-api/src/Cardano/Api/Internal/InMode.hs

@@ -30,7 +30,7 @@ where
 import Cardano.Api.Internal.Eon.ShelleyBasedEra
 import Cardano.Api.Internal.Eras
 import Cardano.Api.Internal.Modes
-import Cardano.Api.Internal.Orphans ()
+import Cardano.Api.Internal.Orphans.All ()
 import Cardano.Api.Internal.Tx.Body
 import Cardano.Api.Internal.Tx.Sign
 import Cardano.Api.Internal.Utils (textShow)

cardano-api/src/Cardano/Api/Internal/Orphans/All.hs

@@ -0,0 +1,33 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE DerivingVia #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
+{-# LANGUAGE NamedFieldPuns #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE StandaloneDeriving #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE UndecidableInstances #-}
+{-# OPTIONS_GHC -Wno-orphans -Wno-unused-imports #-}
+
+module Cardano.Api.Internal.Orphans.All
+  ( AsType
+        ( AsColdCommitteeCredential
+        , AsHotCommitteeCredential
+        , AsDrepCredential
+        , AsGovActionId
+        )
+  )
+where
+
+import Cardano.Api.Internal.Orphans.Misc ()
+import Cardano.Api.Internal.Orphans.Serialization (AsType
+        ( AsColdCommitteeCredential
+        , AsHotCommitteeCredential
+        , AsDrepCredential
+        , AsGovActionId
+        ))
+import Cardano.Api.Internal.Orphans.Serialization ()