convert to Word64 at Parser level

Author: Cmdv

cardano-db-sync/app/cardano-db-sync.hs

@@ -229,10 +229,11 @@ pSlotNo =
           <> Opt.metavar "WORD"
       )
 
-pKeepTxMetadata :: Parser [Text]
+pKeepTxMetadata :: Parser [Word64]
 pKeepTxMetadata =
   Opt.many
-    ( Opt.strOption
+    ( Opt.option
+        Opt.auto
         ( Opt.long "keep-tx-metadata"
             <> Opt.help "Insert a specific set of tx metadata, based on the tx metadata key names"
         )

cardano-db-sync/src/Cardano/DbSync.hs

@@ -56,6 +56,7 @@ import Cardano.Prelude hiding (Nat, (%))
 import Cardano.Slotting.Slot (EpochNo (..))
 import Control.Concurrent.Async
 import Control.Monad.Extra (whenJust)
+import qualified Data.Strict.Maybe as Strict
 import qualified Data.Text as Text
 import Data.Version (showVersion)
 import Database.Persist.Postgresql (ConnectionString, withPostgresqlConn)
@@ -232,10 +233,15 @@ extractSyncOptions snp aop =
     , snapshotEveryLagging = enpSnEveryLagging snp
     }
   where
+    maybeKeepMNames =
+      if null (enpKeepMetadataNames snp)
+        then Strict.Just (enpKeepMetadataNames snp)
+        else Strict.Nothing
+
     iopts
       | enpOnlyGov snp = onlyGovInsertOptions useLedger
       | enpOnlyUTxO snp = onlyUTxOInsertOptions
-      | enpFullMode snp = fullInsertOptions useLedger (enpKeepMetadataNames snp)
+      | enpFullMode snp = fullInsertOptions useLedger maybeKeepMNames
       | enpDisableAllMode snp = disableAllInsertOptions useLedger
       | otherwise =
           InsertOptions
@@ -245,7 +251,7 @@ extractSyncOptions snp aop =
             , ioRewards = True
             , ioMultiAssets = enpHasMultiAssets snp
             , ioMetadata = enpHasMetadata snp
-            , ioKeepMetadataNames = enpKeepMetadataNames snp
+            , ioKeepMetadataNames = maybeKeepMNames
             , ioPlutusExtra = enpHasPlutusExtra snp
             , ioOffChainPoolData = enpHasOffChainPoolData snp
             , ioGov = enpHasGov snp

cardano-db-sync/src/Cardano/DbSync/Api.hs

@@ -199,8 +199,8 @@ getPrunes :: SyncEnv -> Bool
 getPrunes = do
   DB.pcmPruneTxOut . getPruneConsume
 
-fullInsertOptions :: Bool -> [Text] -> InsertOptions
-fullInsertOptions useLedger keepTxMDNames = InsertOptions True useLedger True True True True keepTxMDNames True True True
+fullInsertOptions :: Bool -> Strict.Maybe [Word64] -> InsertOptions
+fullInsertOptions useLedger maybeKeepMNames = InsertOptions True useLedger True True True True maybeKeepMNames True True True
 
 onlyUTxOInsertOptions :: InsertOptions
 onlyUTxOInsertOptions =
@@ -211,7 +211,7 @@ onlyUTxOInsertOptions =
     , ioRewards = False
     , ioMultiAssets = True
     , ioMetadata = False
-    , ioKeepMetadataNames = []
+    , ioKeepMetadataNames = Strict.Nothing
     , ioPlutusExtra = False
     , ioOffChainPoolData = False
     , ioGov = False
@@ -221,7 +221,7 @@ onlyGovInsertOptions :: Bool -> InsertOptions
 onlyGovInsertOptions useLedger = (disableAllInsertOptions useLedger) {ioGov = True}
 
 disableAllInsertOptions :: Bool -> InsertOptions
-disableAllInsertOptions useLedger = InsertOptions False useLedger False False False False [] False False False
+disableAllInsertOptions useLedger = InsertOptions False useLedger False False False False Strict.Nothing False False False
 
 initEpochState :: EpochState
 initEpochState =

cardano-db-sync/src/Cardano/DbSync/Api/Types.hs

@@ -23,7 +23,7 @@ import Cardano.DbSync.Types (
   OffChainVoteResult,
   OffChainVoteWorkQueue,
  )
-import Cardano.Prelude (Bool, Eq, IO, Show, Text, Word64)
+import Cardano.Prelude (Bool, Eq, IO, Show, Word64)
 import Cardano.Slotting.Slot (EpochNo (..))
 import Control.Concurrent.Class.MonadSTM.Strict (
   StrictTVar,
@@ -78,7 +78,7 @@ data InsertOptions = InsertOptions
   , ioRewards :: !Bool
   , ioMultiAssets :: !Bool
   , ioMetadata :: !Bool
-  , ioKeepMetadataNames :: ![Text]
+  , ioKeepMetadataNames :: Strict.Maybe [Word64]
   , ioPlutusExtra :: !Bool
   , ioOffChainPoolData :: !Bool
   , ioGov :: !Bool

cardano-db-sync/src/Cardano/DbSync/Config/Types.hs

@@ -72,7 +72,7 @@ data SyncNodeParams = SyncNodeParams
   , enpHasShelley :: !Bool
   , enpHasMultiAssets :: !Bool
   , enpHasMetadata :: !Bool
-  , enpKeepMetadataNames :: ![Text]
+  , enpKeepMetadataNames :: ![Word64]
   , enpHasPlutusExtra :: !Bool
   , enpHasGov :: !Bool
   , enpHasOffChainPoolData :: !Bool

cardano-db-sync/src/Cardano/DbSync/Era/Shelley/Insert.hs

@@ -88,12 +88,11 @@ import qualified Data.ByteString.Lazy.Char8 as LBS
 import Data.Either.Extra (eitherToMaybe)
 import Data.Group (invert)
 import qualified Data.Map.Strict as Map
-import qualified Data.Text as Text
+import qualified Data.Strict.Maybe as Strict
 import qualified Data.Text.Encoding as Text
 import Database.Persist.Sql (SqlBackend)
 import Lens.Micro
 import Ouroboros.Consensus.Cardano.Block (StandardConway, StandardCrypto)
-import Prelude (read)
 
 {- HLINT ignore "Reduce duplication" -}
 
@@ -1221,25 +1220,31 @@ prepareTxMetadata tracer txId inOpts mmetadata = do
       (Word64, TxMetadataValue) ->
       ExceptT SyncNodeError (ReaderT SqlBackend m) (Maybe DB.TxMetadata)
     prepare (key, md) = do
-      let metadataNames = ioKeepMetadataNames inOpts
-          isMatchingKey = key `elem` map (read . Text.unpack) metadataNames
-          isMetadataNamesEmpty = null metadataNames
-      -- if the metadata names list is empty then nothing was passed to the command line flag
-      -- so we just return all metadata as normal overiding isMatchingKey.
-      if isMetadataNamesEmpty || isMatchingKey
-        then do
-          let jsonbs = LBS.toStrict $ Aeson.encode (metadataValueToJsonNoSchema md)
-              singleKeyCBORMetadata = serialiseTxMetadataToCbor $ Map.singleton key md
-          mjson <- safeDecodeToJson tracer "prepareTxMetadata" jsonbs
-          pure $
-            Just $
-              DB.TxMetadata
-                { DB.txMetadataKey = DbWord64 key
-                , DB.txMetadataJson = mjson
-                , DB.txMetadataBytes = singleKeyCBORMetadata
-                , DB.txMetadataTxId = txId
-                }
-        else pure Nothing
+      case ioKeepMetadataNames inOpts of
+        Strict.Just metadataNames -> do
+          let isMatchingKey = key `elem` metadataNames
+          if isMatchingKey
+            then mkDbTxMetadata (key, md)
+            else pure Nothing
+        -- if we have TxMetadata and keepMetadataNames is Nothing then we want to keep all metadata
+        Strict.Nothing -> mkDbTxMetadata (key, md)
+
+    mkDbTxMetadata ::
+      (MonadBaseControl IO m, MonadIO m) =>
+      (Word64, TxMetadataValue) ->
+      ExceptT SyncNodeError (ReaderT SqlBackend m) (Maybe DB.TxMetadata)
+    mkDbTxMetadata (key, md) = do
+      let jsonbs = LBS.toStrict $ Aeson.encode (metadataValueToJsonNoSchema md)
+          singleKeyCBORMetadata = serialiseTxMetadataToCbor $ Map.singleton key md
+      mjson <- safeDecodeToJson tracer "prepareTxMetadata" jsonbs
+      pure $
+        Just $
+          DB.TxMetadata
+            { DB.txMetadataKey = DbWord64 key
+            , DB.txMetadataJson = mjson
+            , DB.txMetadataBytes = singleKeyCBORMetadata
+            , DB.txMetadataTxId = txId
+            }
 
 insertCostModel ::
   (MonadBaseControl IO m, MonadIO m) =>