Refactor: Move ?! and ?!& to Cardano.Api.Monad.Error

Author: carbolymer

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

@@ -92,8 +92,8 @@ where
 import Cardano.Api.Byron.Internal.Key
 import Cardano.Api.Era
 import Cardano.Api.HasTypeProxy
-import Cardano.Api.Internal.Utils
 import Cardano.Api.Key.Internal
+import Cardano.Api.Monad.Error
 import Cardano.Api.Network.Internal.NetworkId
 import Cardano.Api.Parser.Text qualified as P
 import Cardano.Api.Plutus.Internal.Script

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

@@ -5,24 +5,13 @@
 
 -- | Internal utils for the other Api modules
 module Cardano.Api.Internal.Utils
-  ( (?!)
-  , (?!.)
-  , (<<$>>)
+  ( (<<$>>)
   , (<<<$>>>)
   , noInlineMaybeToStrictMaybe
   )
 where
 
 import Cardano.Ledger.BaseTypes
-import Cardano.Ledger.Shelley ()
-
-(?!) :: Maybe a -> e -> Either e a
-Nothing ?! e = Left e
-Just x ?! _ = Right x
-
-(?!.) :: Either e a -> (e -> e') -> Either e' a
-Left e ?!. f = Left (f e)
-Right x ?!. _ = Right x
 
 infixl 4 <<$>>
 

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

@@ -15,6 +15,8 @@ module Cardano.Api.Monad.Error
   , liftMaybe
   , failEither
   , failEitherWith
+  , (?!)
+  , (?!&)
   , module Control.Monad.Except
   , module Control.Monad.IO.Class
   , module Control.Monad.Trans.Class
@@ -118,6 +120,18 @@ liftMaybe
   -> m a
 liftMaybe e = maybe (throwError e) pure
 
+-- | Infix 'liftMaybe', with arguments flipped
+(?!) :: MonadError e m => Maybe a -> e -> m a
+(?!) = flip liftMaybe
+
+infixl 8 ?!
+
+-- | Map over the 'Left' value of 'Either e a'. Infix 'first' with its arguments flipped.
+(?!&) :: Either e a -> (e -> e') -> Either e' a
+(?!&) = flip first
+
+infixl 8 ?!&
+
 -- | Lift 'Either' to `MonadFail`
 failEither
   :: MonadFail m

cardano-api/src/Cardano/Api/Serialise/Bech32.hs

@@ -18,7 +18,7 @@ where
 import Cardano.Api.Error
 import Cardano.Api.HasTypeProxy
 import Cardano.Api.Internal.Orphans.Misc ()
-import Cardano.Api.Internal.Utils
+import Cardano.Api.Monad.Error
 import Cardano.Api.Pretty
 import Cardano.Api.Serialise.Raw
 
@@ -52,7 +52,7 @@ deserialiseFromBech32
 deserialiseFromBech32 bech32Str = do
   (prefix, dataPart) <-
     Bech32.decodeLenient bech32Str
-      ?!. Bech32DecodingError
+      ?!& Bech32DecodingError
 
   let actualPrefix = Bech32.humanReadablePartToText prefix
       permittedPrefixes = bech32PrefixesPermitted (asType @a)
@@ -83,7 +83,7 @@ deserialiseAnyOfFromBech32
 deserialiseAnyOfFromBech32 types bech32Str = do
   (prefix, dataPart) <-
     Bech32.decodeLenient bech32Str
-      ?!. Bech32DecodingError
+      ?!& Bech32DecodingError
 
   let actualPrefix = Bech32.humanReadablePartToText prefix
 

cardano-api/src/Cardano/Api/Serialise/Cip129.hs

@@ -20,7 +20,7 @@ where
 import Cardano.Api.Governance.Internal.Action.ProposalProcedure
 import Cardano.Api.HasTypeProxy
 import Cardano.Api.Internal.Orphans (AsType (..))
-import Cardano.Api.Internal.Utils
+import Cardano.Api.Monad.Error
 import Cardano.Api.Serialise.Bech32
 import Cardano.Api.Serialise.Raw
 import Cardano.Api.Tx.Internal.TxIn
@@ -98,7 +98,7 @@ deserialiseFromBech32Cip129
 deserialiseFromBech32Cip129 bech32Str = do
   (prefix, dataPart) <-
     Bech32.decodeLenient bech32Str
-      ?!. Bech32DecodingError
+      ?!& Bech32DecodingError
 
   let actualPrefix = Bech32.humanReadablePartToText prefix
       permittedPrefixes = cip129Bech32PrefixesPermitted (asType @a)
@@ -160,7 +160,7 @@ deserialiseGovActionIdFromBech32Cip129 bech32Str = do
   let permittedPrefixes = ["gov_action"]
   (prefix, dataPart) <-
     Bech32.decodeLenient bech32Str
-      ?!. Bech32DecodingError
+      ?!& Bech32DecodingError
   let actualPrefix = Bech32.humanReadablePartToText prefix
   guard (actualPrefix `elem` permittedPrefixes)
     ?! Bech32UnexpectedPrefix actualPrefix (fromList permittedPrefixes)

cardano-api/src/Cardano/Api/Tx/Internal/Body.hs

@@ -248,9 +248,9 @@ import Cardano.Api.Experimental.Plutus.Internal.Shim.LegacyScripts
 import Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements
 import Cardano.Api.Governance.Internal.Action.ProposalProcedure
 import Cardano.Api.Governance.Internal.Action.VotingProcedure
-import Cardano.Api.Internal.Utils
 import Cardano.Api.Key.Internal
 import Cardano.Api.Ledger.Internal.Reexport qualified as Ledger
+import Cardano.Api.Monad.Error
 import Cardano.Api.Network.Internal.NetworkId
 import Cardano.Api.Plutus.Internal.Script
 import Cardano.Api.Plutus.Internal.ScriptData

cardano-api/src/Cardano/Api/Tx/Internal/Output.hs

@@ -63,8 +63,8 @@ import Cardano.Api.Era.Internal.Eon.Convert
 import Cardano.Api.Era.Internal.Eon.ShelleyBasedEra
 import Cardano.Api.Error (Error (..), displayError)
 import Cardano.Api.Hash
-import Cardano.Api.Internal.Utils
 import Cardano.Api.Ledger.Internal.Reexport qualified as Ledger
+import Cardano.Api.Monad.Error
 import Cardano.Api.Parser.Text qualified as P
 import Cardano.Api.Plutus.Internal.Script
 import Cardano.Api.Plutus.Internal.ScriptData