Merge pull request #842 from IntersectMBO/mgalazyn/refactor/remove-partial-instances

Remove partial instances

Author: carbolymer

cardano-api/cardano-api.cabal

@@ -100,6 +100,7 @@ library
     Cardano.Api.Ledger
     Cardano.Api.Ledger.Lens
     Cardano.Api.Network
+    Cardano.Api.Parser.Text
     Cardano.Api.Shelley
     Cardano.Api.Tx.UTxO
 
@@ -322,6 +323,7 @@ test-suite cardano-api-test
   main-is: cardano-api-test.hs
   type: exitcode-stdio-1.0
   build-depends:
+    FailT,
     QuickCheck,
     aeson >=1.5.6.0,
     base16-bytestring,
@@ -420,7 +422,6 @@ test-suite cardano-api-golden
     hedgehog >=1.1,
     hedgehog-extras ^>=0.7,
     microlens,
-    parsec,
     plutus-core ^>=1.45,
     plutus-ledger-api,
     tasty,

cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs

@@ -156,6 +156,7 @@ import Cardano.Api.Internal.Error
 import Cardano.Api.Internal.Script (scriptInEraToRefScript)
 import Cardano.Api.Ledger qualified as L
 import Cardano.Api.Ledger.Lens qualified as A
+import Cardano.Api.Parser.Text qualified as P
 import Cardano.Api.Shelley
 import Cardano.Api.Shelley qualified as ShelleyApi
 
@@ -446,16 +447,23 @@ genAssetName :: Gen AssetName
 genAssetName =
   Gen.frequency
     -- mostly from a small number of choices, so we get plenty of repetition
-    [ (9, Gen.element ["", "a", "b", "c"])
-    , (1, AssetName <$> Gen.bytes (Range.singleton 32))
-    , (1, AssetName <$> Gen.bytes (Range.constant 1 31))
+    [ (9, UnsafeAssetName <$> Gen.element ["", "a", "b", "c"])
+    , (1, UnsafeAssetName <$> Gen.bytes (Range.singleton 32))
+    , (1, UnsafeAssetName <$> Gen.bytes (Range.constant 1 31))
     ]
 
 genPolicyId :: Gen PolicyId
 genPolicyId =
   Gen.frequency
     -- mostly from a small number of choices, so we get plenty of repetition
-    [ (9, Gen.element [fromString (x : replicate 55 '0') | x <- ['a' .. 'c']])
+    [
+      ( 9
+      , Gen.element
+          [ pid
+          | x <- ['a' .. 'c']
+          , pid <- P.runParserFail parsePolicyId (fromString $ x : replicate 55 '0')
+          ]
+      )
     , -- and some from the full range of the type
       (1, PolicyId <$> genScriptHash)
     ]

cardano-api/src/Cardano/Api.hs

@@ -216,10 +216,10 @@ module Cardano.Api
   , StakeAddressReference (..)
   , PaymentKey
   , PaymentExtendedKey
+  , parseHexHash
 
     -- ** Addresses in any era
   , AddressAny (..)
-  , lexPlausibleAddressString
   , parseAddressAny
 
     -- ** Addresses in specific eras
@@ -376,13 +376,16 @@ module Cardano.Api
 
     -- ** Transaction Ids
   , TxId (..)
+  , parseTxId
   , getTxId
   , getTxIdByron
 
     -- ** Transaction inputs
   , TxIn (TxIn)
+  , parseTxIn
   , TxIns
   , TxIx (TxIx)
+  , parseTxIx
   , renderTxIn
   , getReferenceInputsSizeForTxIds
 
@@ -397,7 +400,6 @@ module Cardano.Api
   , txOutValueToValue
   , lovelaceToTxOutValue
   , TxOutDatum (..)
-  , parseHash
 
     -- ** Other transaction body types
   , TxInsCollateral (..)
@@ -643,6 +645,7 @@ module Cardano.Api
   , getScriptData
   , unsafeHashableScriptData
   , ScriptData (..)
+  , parseScriptDataHash
 
     -- ** Validation
   , ScriptDataRangeError (..)
@@ -669,6 +672,7 @@ module Cardano.Api
 
     -- | Making addresses from scripts.
   , ScriptHash (..)
+  , parseScriptHash
   , hashScript
 
     -- * Serialisation
@@ -735,6 +739,7 @@ module Cardano.Api
   , serialiseToRawBytesHex
   , deserialiseFromRawBytesHex
   , serialiseToRawBytesHexText
+  , parseRawBytesHex
   , RawBytesHexError (..)
   , UsingRawBytes (..)
   , UsingRawBytesHex (..)
@@ -995,7 +1000,6 @@ module Cardano.Api
   , fromLedgerTxOuts
   , toLedgerUTxO
   , fromLedgerUTxO
-  , runParsecParser
   , SlotsInEpoch (..)
   , SlotsToEpochEnd (..)
   , slotToEpoch

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

@@ -31,7 +31,6 @@ module Cardano.Api.Internal.Address
 
     -- ** Addresses in any era
   , AddressAny (..)
-  , lexPlausibleAddressString
   , parseAddressAny
 
     -- ** Addresses in specific eras
@@ -101,6 +100,7 @@ import Cardano.Api.Internal.Script
 import Cardano.Api.Internal.SerialiseBech32
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.Utils
+import Cardano.Api.Parser.Text qualified as P
 
 import Cardano.Chain.Common qualified as Byron
 import Cardano.Ledger.Address qualified as Shelley
@@ -120,8 +120,6 @@ import Data.Either.Combinators (rightToMaybe)
 import Data.Text (Text)
 import Data.Text qualified as Text
 import Data.Text.Encoding qualified as Text
-import Text.Parsec qualified as Parsec
-import Text.Parsec.String qualified as Parsec
 
 -- ----------------------------------------------------------------------------
 -- Address Serialisation
@@ -248,10 +246,10 @@ instance SerialiseAsRawBytes (Address ShelleyAddr) where
       Just (Shelley.Addr nw pc scr) -> Right (ShelleyAddress nw pc scr)
 
 instance SerialiseAsBech32 (Address ShelleyAddr) where
-  bech32PrefixFor (ShelleyAddress Shelley.Mainnet _ _) = "addr"
-  bech32PrefixFor (ShelleyAddress Shelley.Testnet _ _) = "addr_test"
+  bech32PrefixFor (ShelleyAddress Shelley.Mainnet _ _) = unsafeHumanReadablePartFromText "addr"
+  bech32PrefixFor (ShelleyAddress Shelley.Testnet _ _) = unsafeHumanReadablePartFromText "addr_test"
 
-  bech32PrefixesPermitted (AsAddress AsShelleyAddr) = ["addr", "addr_test"]
+  bech32PrefixesPermitted (AsAddress AsShelleyAddr) = unsafeHumanReadablePartFromText <$> ["addr", "addr_test"]
 
 instance SerialiseAddress (Address ByronAddr) where
   serialiseAddress addr@ByronAddress{} =
@@ -381,20 +379,20 @@ instance IsShelleyBasedEra era => FromJSON (AddressInEra era) where
   parseJSON =
     let sbe = shelleyBasedEra @era
      in withText "AddressInEra" $ \txt -> do
-          addressAny <- runParsecParser parseAddressAny txt
+          addressAny <- P.runParserFail parseAddressAny txt
           pure $ anyAddressInShelleyBasedEra sbe addressAny
 
-parseAddressAny :: SerialiseAddress addr => Parsec.Parser addr
+-- | Parser for any address, supports both bech32 and base58 encodings
+parseAddressAny :: SerialiseAddress addr => P.Parser addr
 parseAddressAny = do
   str <- lexPlausibleAddressString
   case deserialiseAddress asType str of
     Nothing -> fail $ "invalid address: " <> Text.unpack str
     Just addr -> pure addr
-
-lexPlausibleAddressString :: Parsec.Parser Text
-lexPlausibleAddressString =
-  Text.pack <$> Parsec.many1 (Parsec.satisfy isPlausibleAddressChar)
  where
+  lexPlausibleAddressString :: P.Parser Text
+  lexPlausibleAddressString =
+    Text.pack <$> P.many1 (P.satisfy isPlausibleAddressChar)
   -- Covers both base58 and bech32 (with constrained prefixes)
   isPlausibleAddressChar c =
     isAsciiLower c
@@ -579,10 +577,10 @@ instance SerialiseAsRawBytes StakeAddress where
       Just (Shelley.RewardAccount nw sc) -> Right (StakeAddress nw sc)
 
 instance SerialiseAsBech32 StakeAddress where
-  bech32PrefixFor (StakeAddress Shelley.Mainnet _) = "stake"
-  bech32PrefixFor (StakeAddress Shelley.Testnet _) = "stake_test"
+  bech32PrefixFor (StakeAddress Shelley.Mainnet _) = unsafeHumanReadablePartFromText "stake"
+  bech32PrefixFor (StakeAddress Shelley.Testnet _) = unsafeHumanReadablePartFromText "stake_test"
 
-  bech32PrefixesPermitted AsStakeAddress = ["stake", "stake_test"]
+  bech32PrefixesPermitted AsStakeAddress = unsafeHumanReadablePartFromText <$> ["stake", "stake_test"]
 
 instance SerialiseAddress StakeAddress where
   serialiseAddress addr@StakeAddress{} =

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

@@ -81,7 +81,6 @@ import Data.Aeson qualified as Aeson
 import Data.ByteString qualified as BS
 import Data.ByteString.Short qualified as SBS
 import Data.Foldable (Foldable (toList))
-import Data.String (IsString)
 import Data.Text (Text)
 
 {- HLINT ignore "Use lambda" -}
@@ -236,7 +235,6 @@ data BlockHeader
 newtype instance Hash BlockHeader = HeaderHash SBS.ShortByteString
   deriving (Eq, Ord, Show)
   deriving (ToJSON, FromJSON) via UsingRawBytesHex (Hash BlockHeader)
-  deriving IsString via UsingRawBytesHex (Hash BlockHeader)
 
 instance SerialiseAsRawBytes (Hash BlockHeader) where
   serialiseToRawBytes (HeaderHash bs) = SBS.fromShort bs

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

@@ -54,13 +54,6 @@ class (SerialiseAsRawBytes a, HasTypeProxy a) => Cip129 a where
   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
-    . Bech32.humanReadablePartFromText
-
 instance Cip129 (Credential L.ColdCommitteeRole) where
   cip129Bech32PrefixFor _ = unsafeHumanReadablePartFromText "cc_cold"
   cip129Bech32PrefixesPermitted AsColdCommitteeCredential = ["cc_cold"]

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

@@ -8,6 +8,7 @@
 module Cardano.Api.Internal.Error
   ( Error (..)
   , throwErrorAsException
+  , failEitherError
   , ErrorAsException (..)
   , FileError (..)
   , fileIOExceptT
@@ -16,6 +17,7 @@ module Cardano.Api.Internal.Error
 where
 
 import Cardano.Api.Internal.Pretty
+import Cardano.Api.Internal.Utils
 
 import Control.Exception (Exception (..), IOException, throwIO)
 import Control.Monad.Except (throwError)
@@ -36,6 +38,9 @@ instance Error () where
 throwErrorAsException :: Error e => e -> IO a
 throwErrorAsException e = throwIO (ErrorAsException e)
 
+failEitherError :: MonadFail m => Error e => Either e a -> m a
+failEitherError = failEitherWith displayError
+
 data ErrorAsException where
   ErrorAsException :: Error e => e -> ErrorAsException
 

cardano-api/src/Cardano/Api/Internal/Governance/Poll.hs

@@ -41,6 +41,7 @@ import Cardano.Api.Internal.Eras
 import Cardano.Api.Internal.HasTypeProxy
 import Cardano.Api.Internal.Hash
 import Cardano.Api.Internal.Keys.Shelley
+import Cardano.Api.Internal.Pretty
 import Cardano.Api.Internal.Serialise.Cbor
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.SerialiseTextEnvelope
@@ -60,7 +61,6 @@ import Control.Monad (foldM, when)
 import Data.Either.Combinators (maybeToRight)
 import Data.Function ((&))
 import Data.Map.Strict qualified as Map
-import Data.String (IsString (..))
 import Data.Text (Text)
 import Data.Text qualified as Text
 import Data.Text.Lazy qualified as Text.Lazy
@@ -185,7 +185,7 @@ instance SerialiseAsCBOR GovernancePoll where
 newtype instance Hash GovernancePoll
   = GovernancePollHash {unGovernancePollHash :: Hash.Hash HASH GovernancePoll}
   deriving stock (Eq, Ord)
-  deriving (Show, IsString) via UsingRawBytesHex (Hash GovernancePoll)
+  deriving (Show, Pretty) via UsingRawBytesHex (Hash GovernancePoll)
 
 instance SerialiseAsRawBytes (Hash GovernancePoll) where
   serialiseToRawBytes =

cardano-api/src/Cardano/Api/Internal/Keys/Byron.hs

@@ -32,6 +32,7 @@ import Cardano.Api.Internal.HasTypeProxy
 import Cardano.Api.Internal.Hash
 import Cardano.Api.Internal.Keys.Class
 import Cardano.Api.Internal.Keys.Shelley
+import Cardano.Api.Internal.Pretty
 import Cardano.Api.Internal.Serialise.Cbor
 import Cardano.Api.Internal.SerialiseRaw
 import Cardano.Api.Internal.SerialiseTextEnvelope
@@ -52,7 +53,6 @@ import Control.Monad
 import Data.Bifunctor
 import Data.ByteString.Lazy qualified as LB
 import Data.Either.Combinators
-import Data.String (IsString)
 import Data.Text (Text)
 import Data.Text qualified as Text
 import Formatting (build, formatToString)
@@ -95,13 +95,13 @@ instance Key ByronKey where
   newtype VerificationKey ByronKey
     = ByronVerificationKey Crypto.VerificationKey
     deriving stock Eq
-    deriving (Show, IsString) via UsingRawBytesHex (VerificationKey ByronKey)
+    deriving (Show, Pretty) via UsingRawBytesHex (VerificationKey ByronKey)
     deriving newtype (ToCBOR, FromCBOR)
     deriving anyclass SerialiseAsCBOR
 
   newtype SigningKey ByronKey
     = ByronSigningKey Crypto.SigningKey
-    deriving (Show, IsString) via UsingRawBytesHex (SigningKey ByronKey)
+    deriving (Show, Pretty) via UsingRawBytesHex (SigningKey ByronKey)
     deriving newtype (ToCBOR, FromCBOR)
     deriving anyclass SerialiseAsCBOR
 
@@ -147,7 +147,7 @@ instance SerialiseAsRawBytes (SigningKey ByronKey) where
 
 newtype instance Hash ByronKey = ByronKeyHash Crypto.KeyHash
   deriving (Eq, Ord)
-  deriving (Show, IsString) via UsingRawBytesHex (Hash ByronKey)
+  deriving (Show, Pretty) via UsingRawBytesHex (Hash ByronKey)
   deriving (ToCBOR, FromCBOR) via UsingRawBytes (Hash ByronKey)
   deriving anyclass SerialiseAsCBOR
 
@@ -186,13 +186,13 @@ instance Key ByronKeyLegacy where
   newtype VerificationKey ByronKeyLegacy
     = ByronVerificationKeyLegacy Crypto.VerificationKey
     deriving stock Eq
-    deriving (Show, IsString) via UsingRawBytesHex (VerificationKey ByronKeyLegacy)
+    deriving (Show, Pretty) via UsingRawBytesHex (VerificationKey ByronKeyLegacy)
     deriving newtype (ToCBOR, FromCBOR)
     deriving anyclass SerialiseAsCBOR
 
   newtype SigningKey ByronKeyLegacy
     = ByronSigningKeyLegacy Crypto.SigningKey
-    deriving (Show, IsString) via UsingRawBytesHex (SigningKey ByronKeyLegacy)
+    deriving (Show, Pretty) via UsingRawBytesHex (SigningKey ByronKeyLegacy)
     deriving newtype (ToCBOR, FromCBOR)
     deriving anyclass SerialiseAsCBOR
 
@@ -222,7 +222,7 @@ instance HasTextEnvelope (SigningKey ByronKeyLegacy) where
 
 newtype instance Hash ByronKeyLegacy = ByronKeyHashLegacy Crypto.KeyHash
   deriving (Eq, Ord)
-  deriving (Show, IsString) via UsingRawBytesHex (Hash ByronKeyLegacy)
+  deriving (Show, Pretty) via UsingRawBytesHex (Hash ByronKeyLegacy)
   deriving (ToCBOR, FromCBOR) via UsingRawBytes (Hash ByronKeyLegacy)
   deriving anyclass SerialiseAsCBOR