Address review

Author: Jimbo4350

cardano-api/cardano-api.cabal

@@ -85,7 +85,7 @@ library
     Cardano.Api.Internal.LedgerState
     Cardano.Api.Internal.Modes
     Cardano.Api.Internal.Orphans.All
-    Cardano.Api.Internal.Orphans.Serialization
+    Cardano.Api.Internal.Orphans.Serialisation
     Cardano.Api.Internal.Orphans.Misc
     Cardano.Api.Internal.Plutus
     Cardano.Api.Internal.Pretty

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,6 +13,7 @@ module Cardano.Api.Internal.CIP.Cip129
   , serialiseToBech32Cip129
   , serialiseGovActionIdToBech32CIP129
   , deserialiseGovActionIdFromBech32CIP129
+  , AsType (AsColdCommitteeCredential, AsDrepCredential, AsHotCommitteeCredential)
   )
 where
 
@@ -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/Orphans/All.hs

@@ -1,18 +1,3 @@
-{-# 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
@@ -24,10 +9,11 @@ module Cardano.Api.Internal.Orphans.All
 where
 
 import Cardano.Api.Internal.Orphans.Misc ()
-import Cardano.Api.Internal.Orphans.Serialization (AsType
-        ( AsColdCommitteeCredential
-        , AsHotCommitteeCredential
-        , AsDrepCredential
-        , AsGovActionId
-        ))
-import Cardano.Api.Internal.Orphans.Serialization ()
+import Cardano.Api.Internal.Orphans.Serialisation
+  ( AsType
+      ( AsColdCommitteeCredential
+      , AsDrepCredential
+      , AsGovActionId
+      , AsHotCommitteeCredential
+      )
+  )

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

@@ -13,7 +13,7 @@
 {-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -Wno-orphans -Wno-unused-imports #-}
 
-module Cardano.Api.Internal.Orphans.Serialization
+module Cardano.Api.Internal.Orphans.Serialisation
 
   ( AsType
         ( AsColdCommitteeCredential