Restore Annotator-decoding functions

Author: teodanciu

libs/cardano-ledger-api/testlib/Test/Cardano/Ledger/Api/DebugTools.hs

@@ -14,6 +14,7 @@ import Cardano.Ledger.Binary (
   Version,
   decNoShareCBOR,
   decodeFull',
+  decodeFullAnnotator,
   decodeFullDecoder',
  )
 import Cardano.Ledger.Binary.Encoding (serialize')
@@ -22,7 +23,6 @@ import Control.Exception (Exception, throwIO)
 import Control.Monad.IO.Class (MonadIO (..))
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Lazy as LBS
-import Test.Cardano.Ledger.Binary.Annotator (decodeFullAnnotator)
 
 readCBORWith ::
   (MonadIO m, Exception e) => (Version -> BS.ByteString -> Either e a) -> Version -> FilePath -> m a

libs/cardano-ledger-binary/bench/Bench.hs

@@ -18,7 +18,6 @@ import qualified Data.Map.Strict as Map
 import Data.Set (Set)
 import qualified Data.Set as Set
 import System.Random.Stateful
-import Test.Cardano.Ledger.Binary.Annotator (decodeFullAnnotator)
 
 data Serialized a = Serialized !Version !BS.ByteString
 

libs/cardano-ledger-binary/src/Cardano/Ledger/Binary/Decoding.hs

@@ -11,6 +11,9 @@ module Cardano.Ledger.Binary.Decoding (
   decodeFullDecoder,
   decodeFullDecoder',
   decodeFullFromHexText,
+  decodeFullAnnotator,
+  decodeFullAnnotatedBytes,
+  decodeFullAnnotatorFromHexText,
   module Cardano.Ledger.Binary.Version,
   module Cardano.Ledger.Binary.Decoding.DecCBOR,
   module Cardano.Ledger.Binary.Decoding.Sharing,
@@ -159,6 +162,47 @@ supplyAllInput bs (Read.Partial k) = case bs of
 supplyAllInput _ (Read.Fail bs _ exn) = return (Left (exn, bs))
 {-# INLINE supplyAllInput #-}
 
+--------------------------------------------------------------------------------
+-- Annotator
+--------------------------------------------------------------------------------
+
+-- | Same as `decodeFullDecoder`, except it provdes the means of passing portion or all
+-- of the `BSL.ByteString` input argument to the decoding `Annotator`.
+decodeFullAnnotator ::
+  Version ->
+  Text ->
+  (forall s. Decoder s (Annotator a)) ->
+  BSL.ByteString ->
+  Either DecoderError a
+decodeFullAnnotator v lbl decoder bytes =
+  (\x -> runAnnotator x (Full bytes)) <$> decodeFullDecoder v lbl decoder bytes
+{-# INLINE decodeFullAnnotator #-}
+
+-- | Same as `decodeFullDecoder`, decodes a Haskell value from a lazy
+-- `BSL.ByteString`, requiring that the full ByteString is consumed, and
+-- replaces `ByteSpan` annotations with the corresponding slice of the input as
+-- a strict `BS.ByteString`.
+decodeFullAnnotatedBytes ::
+  Functor f =>
+  Version ->
+  Text ->
+  (forall s. Decoder s (f ByteSpan)) ->
+  BSL.ByteString ->
+  Either DecoderError (f BS.ByteString)
+decodeFullAnnotatedBytes v lbl decoder bytes =
+  annotationBytes bytes <$> decodeFullDecoder v lbl decoder bytes
+{-# INLINE decodeFullAnnotatedBytes #-}
+
+decodeFullAnnotatorFromHexText ::
+  Version ->
+  Text ->
+  (forall s. Decoder s (Annotator a)) ->
+  Text ->
+  Either DecoderError a
+decodeFullAnnotatorFromHexText v desc dec =
+  Plain.withHexText $ decodeFullAnnotator v desc dec . BSL.fromStrict
+{-# INLINE decodeFullAnnotatorFromHexText #-}
+
 --------------------------------------------------------------------------------
 -- Nested CBOR-in-CBOR
 -- https://tools.ietf.org/html/rfc7049#section-2.4.4.1

libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary.hs

@@ -17,7 +17,6 @@ import qualified Data.ByteString.Lazy as BSL
 import Data.Proxy
 import qualified Data.Text as T
 import Data.Typeable
-import Test.Cardano.Ledger.Binary.Annotator (decodeFullAnnotator)
 import Test.Cardano.Ledger.Binary.RoundTrip (embedTripAnnExpectation)
 import Test.Hspec
 import Test.Hspec.QuickCheck (prop)

libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary/Annotator.hs

@@ -30,51 +30,8 @@ module Test.Cardano.Ledger.Binary.Annotator (
 import Cardano.Ledger.Binary
 import qualified Cardano.Ledger.Binary.Plain as Plain
 import Control.Monad.Except (Except, MonadError (throwError))
-import qualified Data.ByteString as BS
-import qualified Data.ByteString.Lazy as BSL
 import Data.Text (Text)
 
---------------------------------------------------------------------------------
--- Annotator
---------------------------------------------------------------------------------
-
--- | Same as `decodeFullDecoder`, except it provdes the means of passing portion or all
--- of the `BSL.ByteString` input argument to the decoding `Annotator`.
-decodeFullAnnotator ::
-  Version ->
-  Text ->
-  (forall s. Decoder s (Annotator a)) ->
-  BSL.ByteString ->
-  Either DecoderError a
-decodeFullAnnotator v lbl decoder bytes =
-  (\x -> runAnnotator x (Full bytes)) <$> decodeFullDecoder v lbl decoder bytes
-{-# INLINE decodeFullAnnotator #-}
-
--- | Same as `decodeFullDecoder`, decodes a Haskell value from a lazy
--- `BSL.ByteString`, requiring that the full ByteString is consumed, and
--- replaces `ByteSpan` annotations with the corresponding slice of the input as
--- a strict `BS.ByteString`.
-decodeFullAnnotatedBytes ::
-  Functor f =>
-  Version ->
-  Text ->
-  (forall s. Decoder s (f ByteSpan)) ->
-  BSL.ByteString ->
-  Either DecoderError (f BS.ByteString)
-decodeFullAnnotatedBytes v lbl decoder bytes =
-  annotationBytes bytes <$> decodeFullDecoder v lbl decoder bytes
-{-# INLINE decodeFullAnnotatedBytes #-}
-
-decodeFullAnnotatorFromHexText ::
-  Version ->
-  Text ->
-  (forall s. Decoder s (Annotator a)) ->
-  Text ->
-  Either DecoderError a
-decodeFullAnnotatorFromHexText v desc dec =
-  Plain.withHexText $ decodeFullAnnotator v desc dec . BSL.fromStrict
-{-# INLINE decodeFullAnnotatorFromHexText #-}
-
 -- | Translation function between values through a related binary representation. This
 -- function allows you to translate one type into another (or the same one) through their
 -- common binary format. It is possible for the source type to be encoded with a different

libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary/Cddl.hs

@@ -46,7 +46,6 @@ import System.Process.Typed (
   setStdin,
  )
 import Test.Cardano.Ledger.Binary (decoderEquivalenceExpectation)
-import Test.Cardano.Ledger.Binary.Annotator (decodeFullAnnotator)
 import Test.Cardano.Ledger.Binary.RoundTrip
 import Test.Hspec
 import UnliftIO.Temporary (withTempFile)

libs/cardano-ledger-binary/testlib/Test/Cardano/Ledger/Binary/RoundTrip.hs

@@ -74,7 +74,6 @@ import Data.Functor
 import Data.Proxy
 import qualified Data.Text as T
 import Data.Typeable
-import Test.Cardano.Ledger.Binary.Annotator (decodeFullAnnotator)
 import Test.Cardano.Ledger.Binary.Plain.RoundTrip (
   showFailedTermsWithReSerialization,
   showMaybeDecoderError,