Address review

Author: Jimbo4350

cardano-api/cardano-api.cabal

@@ -84,9 +84,9 @@ library
     Cardano.Api.Internal.IO
     Cardano.Api.Internal.LedgerState
     Cardano.Api.Internal.Modes
-    Cardano.Api.Internal.Orphans.All
-    Cardano.Api.Internal.Orphans.Serialization
+    Cardano.Api.Internal.Orphans
     Cardano.Api.Internal.Orphans.Misc
+    Cardano.Api.Internal.Orphans.Serialisation
     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.All ()
+import Cardano.Api.Internal.Orphans ()
 import Cardano.Api.Internal.Plutus
 import Cardano.Api.Internal.Pretty
 import Cardano.Api.Internal.Protocol

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

@@ -1,6 +1,7 @@
 {-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DefaultSignatures #-}
 {-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
@@ -12,12 +13,13 @@ module Cardano.Api.Internal.CIP.Cip129
   , serialiseToBech32Cip129
   , serialiseGovActionIdToBech32CIP129
   , deserialiseGovActionIdFromBech32CIP129
+  , AsType (AsColdCommitteeCredential, AsDrepCredential, AsHotCommitteeCredential)
   )
 where
 
 import Cardano.Api.Internal.Governance.Actions.ProposalProcedure
 import Cardano.Api.Internal.HasTypeProxy
-import Cardano.Api.Internal.Orphans.All (AsType (..))
+import Cardano.Api.Internal.Orphans (AsType (..))
 import Cardano.Api.Internal.SerialiseBech32
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.TxIn
@@ -38,17 +40,22 @@ import Data.Text (Text)
 import Data.Text.Encoding qualified as Text
 import GHC.Exts (IsList (..))
 
--- | Cip129 is a typeclass that captures the serialisation requirements of https://cips.cardano.org/cip/CIP-0129
+-- | Cip-129 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
+  -- | The human readable part of the Bech32 encoding for the credential.
   cip129Bech32PrefixFor :: AsType a -> Bech32.HumanReadablePart
 
+  -- | The header byte that identifies the credential type according to Cip-129.
   cip129HeaderHexByte :: a -> ByteString
 
+  -- | Permitted bech32 prefixes according to Cip-129.
   cip129Bech32PrefixesPermitted :: AsType a -> [Text]
   default cip129Bech32PrefixesPermitted :: AsType a -> [Text]
   cip129Bech32PrefixesPermitted = return . Bech32.humanReadablePartToText . cip129Bech32PrefixFor
 
+-- | The human readable part of the Bech32 encoding for the credential. This will
+-- error if the prefix is not valid.
 unsafeHumanReadablePartFromText :: Text -> Bech32.HumanReadablePart
 unsafeHumanReadablePartFromText =
   either (error . ("Error while parsing Bech32: " <>) . show) id
@@ -57,26 +64,27 @@ unsafeHumanReadablePartFromText =
 instance Cip129 (Credential L.ColdCommitteeRole) where
   cip129Bech32PrefixFor _ = unsafeHumanReadablePartFromText "cc_cold"
   cip129Bech32PrefixesPermitted AsColdCommitteeCredential = ["cc_cold"]
-  cip129HeaderHexByte c =
-    case c of
-      L.KeyHashObj{} -> BS.singleton 0x12 -- 0001 0010
-      L.ScriptHashObj{} -> BS.singleton 0x13 -- 0001 0011
+
+  cip129HeaderHexByte =
+    BS.singleton . \case
+      L.KeyHashObj{} -> 0x12 -- 0001 0010
+      L.ScriptHashObj{} -> 0x13 -- 0001 0011
 
 instance Cip129 (Credential L.HotCommitteeRole) where
   cip129Bech32PrefixFor _ = unsafeHumanReadablePartFromText "cc_hot"
   cip129Bech32PrefixesPermitted AsHotCommitteeCredential = ["cc_hot"]
-  cip129HeaderHexByte c =
-    case c of
-      L.KeyHashObj{} -> BS.singleton 0x02 -- 0000 0010
-      L.ScriptHashObj{} -> BS.singleton 0x03 -- 0000 0011
+  cip129HeaderHexByte =
+    BS.singleton . \case
+      L.KeyHashObj{} -> 0x02 -- 0000 0010
+      L.ScriptHashObj{} -> 0x03 -- 0000 0011
 
 instance Cip129 (Credential L.DRepRole) where
   cip129Bech32PrefixFor _ = unsafeHumanReadablePartFromText "drep"
   cip129Bech32PrefixesPermitted AsDrepCredential = ["drep"]
-  cip129HeaderHexByte c =
-    case c of
-      L.KeyHashObj{} -> BS.singleton 0x22 -- 0010 0010
-      L.ScriptHashObj{} -> BS.singleton 0x23 -- 0010 0011
+  cip129HeaderHexByte =
+    BS.singleton . \case
+      L.KeyHashObj{} -> 0x22 -- 0010 0010
+      L.ScriptHashObj{} -> 0x23 -- 0010 0011
 
 -- | Serialize a accoding to the serialisation requirements of https://cips.cardano.org/cip/CIP-0129
 -- which currently pertain to governance credentials. Governance action ids are dealt separately with

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.All ()
+import Cardano.Api.Internal.Orphans ()
 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.All ()
+import Cardano.Api.Internal.Orphans ()
 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.hs

@@ -0,0 +1,19 @@
+module Cardano.Api.Internal.Orphans
+  ( AsType
+        ( AsColdCommitteeCredential
+        , AsDrepCredential
+        , AsGovActionId
+        , AsHotCommitteeCredential
+        )
+  )
+where
+
+import Cardano.Api.Internal.Orphans.Misc ()
+import Cardano.Api.Internal.Orphans.Serialisation
+  ( AsType
+      ( AsColdCommitteeCredential
+      , AsDrepCredential
+      , AsGovActionId
+      , AsHotCommitteeCredential
+      )
+  )

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

@@ -11,35 +11,35 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE UndecidableInstances #-}
-
-
-{-# OPTIONS_GHC -Wno-orphans  #-}
+{-# OPTIONS_GHC -Wno-orphans #-}
 
 module Cardano.Api.Internal.Orphans.Misc
-  ( 
-  ) where
+  (
+  )
+where
 
-import Cardano.Ledger.Binary
-import Codec.Binary.Bech32 qualified as Bech32
-import Codec.CBOR.Read qualified as CBOR
-import Data.Data (Data)
 import Cardano.Api.Internal.Pretty (Pretty (..), prettyException, (<+>))
+
 import Cardano.Ledger.Alonzo.PParams qualified as Ledger
 import Cardano.Ledger.Babbage.PParams qualified as Ledger
 import Cardano.Ledger.BaseTypes (strictMaybeToMaybe)
 import Cardano.Ledger.BaseTypes qualified as Ledger
+import Cardano.Ledger.Binary
 import Cardano.Ledger.Coin qualified as L
 import Cardano.Ledger.Conway.PParams qualified as Ledger
 import Cardano.Ledger.HKD (NoUpdate (..))
 import Cardano.Ledger.Shelley.PParams qualified as Ledger
+
+import Codec.Binary.Bech32 qualified as Bech32
+import Codec.CBOR.Read qualified as CBOR
+import Data.Data (Data)
 import Data.ListMap (ListMap)
 import Data.ListMap qualified as ListMap
 import Data.Maybe.Strict (StrictMaybe (..))
 import Data.Monoid
 import GHC.Exts (IsList (..))
 import Network.Mux qualified as Mux
 
-
 deriving instance Data DecoderError
 
 deriving instance Data CBOR.DeserialiseFailure
@@ -60,8 +60,6 @@ deriving newtype instance Integral L.Coin
 
 deriving newtype instance Num L.Coin
 
-
-
 -- We wrap the individual records with Last and use Last's Semigroup instance.
 -- In this instance we take the last 'Just' value or the only 'Just' value
 instance Semigroup (Ledger.ShelleyPParams StrictMaybe era) where
@@ -266,4 +264,4 @@ instance Pretty Mux.Error where
 instance IsList (ListMap k a) where
   type Item (ListMap k a) = (k, a)
   fromList = ListMap.fromList
-  toList = ListMap.toList
+  toList = ListMap.toList

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

@@ -1,6 +1,5 @@
 {-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DeriveAnyClass #-}
-{-# LANGUAGE DeriveDataTypeable #-}
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE FlexibleContexts #-}
@@ -13,8 +12,7 @@
 {-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -Wno-orphans -Wno-unused-imports #-}
 
-module Cardano.Api.Internal.Orphans.Serialization
-  
+module Cardano.Api.Internal.Orphans.Serialisation
   ( AsType
         ( AsColdCommitteeCredential
         , AsHotCommitteeCredential
@@ -25,12 +23,13 @@ module Cardano.Api.Internal.Orphans.Serialization
 where
 
 import Cardano.Api.Internal.HasTypeProxy
+import Cardano.Api.Internal.Orphans.Misc
 import Cardano.Api.Internal.Pretty (Pretty (..), prettyException, (<+>))
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.TxIn
 import Cardano.Api.Internal.Via.ShowOf
 import Cardano.Api.Ledger qualified as Ledger
-import Cardano.Api.Internal.Orphans.Misc
+
 import Cardano.Binary (DecoderError (..))
 import Cardano.Binary qualified as CBOR
 import Cardano.Chain.Byron.API qualified as L
@@ -255,7 +254,6 @@ deriving via ShowOf L.KeyHash instance ToJSON L.KeyHash
 
 deriving via ShowOf L.ApplicationName instance ToJSONKey L.ApplicationName
 
-
 instance Pretty L.Coin where
   pretty (L.Coin n) = pretty n <+> "Lovelace"
 
@@ -370,7 +368,6 @@ instance ToJSON PraosState where
       , "lastEpochBlockNonce" .= Consensus.praosStateLastEpochBlockNonce s
       ]
 
-
 instance A.FromJSON V2.ParamName where
   parseJSON = A.withText "ParamName" parsePlutusParamName
 
@@ -385,7 +382,6 @@ parsePlutusParamName t =
 
 deriving instance Show V2.ParamName
 
-
 instance HasTypeProxy (Ledger.Credential L.ColdCommitteeRole) where
   data AsType (Ledger.Credential L.ColdCommitteeRole) = AsColdCommitteeCredential
   proxyToAsType _ = AsColdCommitteeCredential

cardano-api/src/Cardano/Api/Internal/Orphans/Serialization.hs renamed to cardano-api/src/Cardano/Api/Internal/Orphans/Serialisation.hs

@@ -101,7 +101,7 @@ import Cardano.Api.Internal.Hash
 import Cardano.Api.Internal.Json (toRationalJSON)
 import Cardano.Api.Internal.Keys.Byron
 import Cardano.Api.Internal.Keys.Shelley
-import Cardano.Api.Internal.Orphans.All ()
+import Cardano.Api.Internal.Orphans ()
 import Cardano.Api.Internal.Pretty
 import Cardano.Api.Internal.Script
 import Cardano.Api.Internal.Serialise.Cbor