Add HasCallStack constraints to functions containing error calls

Add HasCallStack to standalone functions that call error directly or
indirectly (via fromMaybe impossible), so that call stacks are captured
in error messages. Class methods are left unconstrained since the
failing instances (castVerificationKey extended key conversions,
ByronKeyLegacy deterministicSigningKey) guard impossible code paths.
Also improve Dijkstra-era placeholder error messages to be more
descriptive.

Author: Jimbo4350

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

@@ -826,7 +826,7 @@ getAnchorDataFromCertificate c =
           Ledger.RetirePoolTxCert _ _ -> return Nothing
           Ledger.GenesisDelegTxCert{} -> return Nothing
           Ledger.MirTxCert _ -> return Nothing
-          _ -> error "dijkstra"
+          _ -> error "getAnchorDataFromCertificate: Dijkstra era not supported"
     ConwayCertificate ceo ccert ->
       conwayEraOnwardsConstraints ceo $
         case ccert of
@@ -843,7 +843,7 @@ getAnchorDataFromCertificate c =
           Ledger.UpdateDRepTxCert _ mAnchor -> return $ Ledger.strictMaybeToMaybe mAnchor
           Ledger.AuthCommitteeHotKeyTxCert _ _ -> return Nothing
           Ledger.ResignCommitteeColdTxCert _ mAnchor -> return $ Ledger.strictMaybeToMaybe mAnchor
-          _ -> error "dijkstra"
+          _ -> error "getAnchorDataFromCertificate: Dijkstra era not supported"
  where
   anchorDataFromPoolMetadata
     :: MonadError AnchorDataFromCertificateError m

cardano-api/src/Cardano/Api/Experimental/Tx/Internal/AnyWitness.hs

@@ -125,7 +125,7 @@ getPlutusDatum
 getPlutusDatum L.SPlutusV1 (SpendingScriptDatum d) = Just d
 getPlutusDatum L.SPlutusV2 (SpendingScriptDatum d) = Just d
 getPlutusDatum L.SPlutusV3 (SpendingScriptDatum d) = d
-getPlutusDatum L.SPlutusV4 (SpendingScriptDatum _d) = error "dijkstra"
+getPlutusDatum L.SPlutusV4 (SpendingScriptDatum _d) = error "getPlutusDatum: Dijkstra era not supported"
 getPlutusDatum _ InlineDatum = Nothing
 getPlutusDatum _ NoScriptDatum = Nothing
 

cardano-api/src/Cardano/Api/Key/Internal/Class.hs

@@ -22,6 +22,7 @@ import Cardano.Crypto.Seed qualified as Crypto
 
 import Control.Monad.IO.Class
 import Data.Kind (Type)
+import GHC.Stack (HasCallStack)
 import System.Random (StdGen)
 import System.Random qualified as Random
 
@@ -77,7 +78,8 @@ generateSigningKey keytype = do
   seedSize = deterministicSigningKeySeedSize keytype
 
 generateInsecureSigningKey
-  :: MonadIO m
+  :: HasCallStack
+  => MonadIO m
   => Key keyrole
   => SerialiseAsRawBytes (SigningKey keyrole)
   => StdGen

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

@@ -270,6 +270,7 @@ import Data.Word
 import Data.Yaml qualified as Yaml
 import Formatting.Buildable (build)
 import GHC.Exts (IsList (..))
+import GHC.Stack (HasCallStack)
 import Lens.Micro
 import Network.Mux qualified as Mux
 import Network.TypedProtocol.Core (Nat (..))
@@ -458,7 +459,7 @@ data FoldStatus
 -- the node's tip where @k@ is the security parameter.
 foldBlocks
   :: forall a t m
-   . ()
+   . HasCallStack
   => Show a
   => MonadIOTransError FoldBlocksError t m
   => NodeConfigFile 'In
@@ -715,7 +716,8 @@ foldBlocks nodeConfigFilePath socketPath validationMode state0 accumulate = hand
 -- | Wrap a 'ChainSyncClient' with logic that tracks the ledger state.
 chainSyncClientWithLedgerState
   :: forall m a
-   . Monad m
+   . HasCallStack
+  => Monad m
   => Env
   -> LedgerState
   -- ^ Initial ledger state
@@ -859,7 +861,8 @@ chainSyncClientWithLedgerState env ledgerState0 validationMode (CS.ChainSyncClie
 -- | See 'chainSyncClientWithLedgerState'.
 chainSyncClientPipelinedWithLedgerState
   :: forall m a
-   . Monad m
+   . HasCallStack
+  => Monad m
   => Env
   -> LedgerState
   -> ValidationMode
@@ -2308,7 +2311,8 @@ getLedgerTablesUTxOValues sbe tbs =
 -- provide a termination epoch otherwise blocks would be applied indefinitely.
 foldEpochState
   :: forall t m s
-   . MonadIOTransError FoldBlocksError t m
+   . HasCallStack
+  => MonadIOTransError FoldBlocksError t m
   => NodeConfigFile 'In
   -- ^ Path to the cardano-node config file (e.g. <path to cardano-node project>/configuration/cardano/mainnet-config.json)
   -> SocketPath

cardano-api/src/Cardano/Api/Network/Internal/NetworkId.hs

@@ -25,6 +25,8 @@ import Cardano.Crypto.ProtocolMagic qualified as Byron
 import Cardano.Ledger.BaseTypes qualified as Shelley (Network (..))
 import Ouroboros.Network.Magic (NetworkMagic (..))
 
+import GHC.Stack (HasCallStack)
+
 -- ----------------------------------------------------------------------------
 -- NetworkId type
 --
@@ -74,7 +76,7 @@ toShelleyNetwork :: NetworkId -> Shelley.Network
 toShelleyNetwork Mainnet = Shelley.Mainnet
 toShelleyNetwork (Testnet _) = Shelley.Testnet
 
-fromShelleyNetwork :: Shelley.Network -> NetworkMagic -> NetworkId
+fromShelleyNetwork :: HasCallStack => Shelley.Network -> NetworkMagic -> NetworkId
 fromShelleyNetwork Shelley.Testnet nm = Testnet nm
 fromShelleyNetwork Shelley.Mainnet nm
   | nm == mainnetNetworkMagic = Mainnet

cardano-api/src/Cardano/Api/Plutus/Internal/Script.hs

@@ -1416,7 +1416,8 @@ toShelleyMultiSig = go
   go _ = Left MultiSigErrorTimelockNotsupported
 
 -- | Conversion for the 'Shelley.MultiSig' language used by the Shelley era.
-fromShelleyMultiSig :: Shelley.MultiSig (ShelleyLedgerEra ShelleyEra) -> SimpleScript
+fromShelleyMultiSig
+  :: Shelley.MultiSig (ShelleyLedgerEra ShelleyEra) -> SimpleScript
 fromShelleyMultiSig = go
  where
   go (Shelley.RequireSignature kh) =
@@ -1425,7 +1426,7 @@ fromShelleyMultiSig = go
   go (Shelley.RequireAllOf s) = RequireAllOf (map go $ toList s)
   go (Shelley.RequireAnyOf s) = RequireAnyOf (map go $ toList s)
   go (Shelley.RequireMOf m s) = RequireMOf m (map go $ toList s)
-  go _ = error ""
+  go _ = error "fromShelleyMultiSig: Dijkstra era not supported"
 
 -- | Conversion for the 'Timelock.Timelock' language that is shared between the
 -- Allegra and Mary eras.
@@ -1459,7 +1460,7 @@ fromAllegraTimelock = go
   go (Shelley.RequireAllOf s) = RequireAllOf (map go (toList s))
   go (Shelley.RequireAnyOf s) = RequireAnyOf (map go (toList s))
   go (Shelley.RequireMOf i s) = RequireMOf i (map go (toList s))
-  go _ = error "dijkstra"
+  go _ = error "fromAllegraTimelock: Dijkstra era not supported"
 
 type family ToLedgerPlutusLanguage lang where
   ToLedgerPlutusLanguage PlutusScriptV1 = Plutus.PlutusV1

cardano-api/src/Cardano/Api/Query/Internal/Type/QueryInMode.hs

@@ -572,7 +572,7 @@ toConsensusQuery QueryLedgerConfig = Some Consensus.DebugLedgerConfig
 
 toConsensusQueryShelleyBased
   :: forall era protocol block result
-   . ()
+   . HasCallStack
   => ConsensusBlockForEra era ~ Consensus.ShelleyBlock protocol (ShelleyLedgerEra era)
   => Consensus.CardanoBlock StandardCrypto ~ block
   => L.EraGov (ShelleyLedgerEra era)

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

@@ -1185,7 +1185,7 @@ setTxTreasuryDonation
   :: Maybe (Featured ConwayEraOnwards era L.Coin) -> TxBodyContent build era -> TxBodyContent build era
 setTxTreasuryDonation v txBodyContent = txBodyContent{txTreasuryDonation = v}
 
-getTxIdByron :: Byron.ATxAux ByteString -> TxId
+getTxIdByron :: HasCallStack => Byron.ATxAux ByteString -> TxId
 getTxIdByron (Byron.ATxAux{Byron.aTaTx = txbody}) =
   TxId
     . fromMaybe impossible

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

@@ -115,6 +115,7 @@ import Data.Text qualified as Text
 import Data.Type.Equality (TestEquality (..), (:~:) (Refl))
 import Data.Validation qualified as Valid
 import GHC.Exts (IsList (..))
+import GHC.Stack (HasCallStack)
 import Lens.Micro
 
 -- ----------------------------------------------------------------------------
@@ -868,7 +869,8 @@ data ShelleySigningKey
     ShelleyExtendedSigningKey Crypto.HD.XPrv
 
 makeShelleySignature
-  :: Crypto.SignableRepresentation tosign
+  :: HasCallStack
+  => Crypto.SignableRepresentation tosign
   => tosign
   -> ShelleySigningKey
   -> (Crypto.SignedDSIGN Shelley.DSIGN) tosign