feature: Add multi-asset metadata to tx_out

sgillespie · sgillespie · commit 22b99f3d45e8 · 2024-12-04T13:49:47.000-05:00
diff --git a/cardano-db-sync/src/Cardano/DbSync/Era/Byron/Genesis.hs b/cardano-db-sync/src/Cardano/DbSync/Era/Byron/Genesis.hs
@@ -224,6 +224,7 @@ insertTxOutsByron syncEnv disInOut blkId (address, value) = do
                   , C.txOutInlineDatumId = Nothing
                   , C.txOutReferenceScriptId = Nothing
                   , C.txOutConsumedByTxId = Nothing
+                  , C.txOutMaTxOut = Nothing
                   }
           DB.TxOutVariantAddress -> do
             let addrRaw = serialize' address
@@ -244,6 +245,7 @@ insertTxOutsByron syncEnv disInOut blkId (address, value) = do
         , V.txOutAddressId = addrDetailId
         , V.txOutConsumedByTxId = Nothing
         , V.txOutStakeAddressId = Nothing
+        , V.txOutMaTxOut = Nothing
         }
 
     mkVAddress :: ByteString -> V.Address
diff --git a/cardano-db-sync/src/Cardano/DbSync/Era/Byron/Insert.hs b/cardano-db-sync/src/Cardano/DbSync/Era/Byron/Insert.hs
@@ -363,6 +363,7 @@ insertTxOutByron syncEnv _hasConsumed bootStrap txId index txout =
               , C.txOutReferenceScriptId = Nothing
               , C.txOutStakeAddressId = Nothing -- Byron does not have a stake address.
               , C.txOutTxId = txId
+              , C.txOutMaTxOut = Nothing
               , C.txOutValue = DbLovelace (Byron.unsafeGetLovelace $ Byron.txOutValue txout)
               }
       DB.TxOutVariantAddress -> do
@@ -382,6 +383,7 @@ insertTxOutByron syncEnv _hasConsumed bootStrap txId index txout =
         , V.txOutInlineDatumId = Nothing
         , V.txOutReferenceScriptId = Nothing
         , V.txOutTxId = txId
+        , V.txOutMaTxOut = Nothing
         , V.txOutValue = DbLovelace (Byron.unsafeGetLovelace $ Byron.txOutValue txout)
         , V.txOutStakeAddressId = Nothing
         }
diff --git a/cardano-db-sync/src/Cardano/DbSync/Era/Shelley/Generic/Tx/Types.hs b/cardano-db-sync/src/Cardano/DbSync/Era/Shelley/Generic/Tx/Types.hs
@@ -1,6 +1,8 @@
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE UndecidableSuperClasses #-}
 {-# LANGUAGE NoImplicitPrelude #-}
 
@@ -13,6 +15,7 @@ module Cardano.DbSync.Era.Shelley.Generic.Tx.Types (
   TxWithdrawal (..),
   TxIn (..),
   TxOut (..),
+  TxOutMultiAsset (..),
   TxRedeemer (..),
   TxScript (..),
   PlutusData (..),
@@ -26,6 +29,7 @@ module Cardano.DbSync.Era.Shelley.Generic.Tx.Types (
   getMaybeDatumHash,
   sumTxOutCoin,
   toTxHash,
+  fromMultiAssetMap,
 ) where
 
 import qualified Cardano.Db as DB
@@ -42,12 +46,16 @@ import Cardano.Ledger.Conway.Governance
 import Cardano.Ledger.Conway.Scripts
 import Cardano.Ledger.Conway.TxCert (ConwayTxCert)
 import Cardano.Ledger.Core (TxBody)
-import Cardano.Ledger.Mary.Value (AssetName, MultiAsset, PolicyID)
+import Cardano.Ledger.Mary.Value (AssetName (..), MultiAsset, PolicyID)
 import qualified Cardano.Ledger.Shelley.TxBody as Shelley
 import Cardano.Ledger.Shelley.TxCert
 import qualified Cardano.Ledger.TxIn as Ledger
 import Cardano.Prelude
 import Cardano.Slotting.Slot (SlotNo (..))
+import Data.Aeson (FromJSON (..), ToJSON (..), (.:), (.=))
+import Data.Aeson.Types (object, withObject)
+import Data.ByteString.Short (toShort)
+import qualified Data.Map as Map
 import Ouroboros.Consensus.Cardano.Block (StandardAlonzo, StandardBabbage, StandardConway, StandardCrypto, StandardShelley)
 
 data Tx = Tx
@@ -114,6 +122,13 @@ data TxOut = TxOut
   , txOutDatum :: !TxOutDatum
   }
 
+data TxOutMultiAsset = TxOutMultiAsset
+  { txOutMaPolicyId :: !(PolicyID StandardCrypto)
+  , txOutMaAssetName :: !AssetName
+  , txOutMaAmount :: !Integer
+  }
+  deriving (Eq, Show)
+
 data TxRedeemer = TxRedeemer
   { txRedeemerMem :: !Word64
   , txRedeemerSteps :: !Word64
@@ -151,6 +166,24 @@ data PoolStats = PoolStats
   , votingPower :: Maybe Coin
   }
 
+instance ToJSON TxOutMultiAsset where
+  toJSON TxOutMultiAsset {..} =
+    object
+      [ "policyId" .= txOutMaPolicyId
+      , "assetName" .= txOutMaAssetName
+      , "amount" .= txOutMaAmount
+      ]
+
+instance FromJSON TxOutMultiAsset where
+  parseJSON = withObject "MultiAsset" $ \o ->
+    TxOutMultiAsset
+      <$> o .: "policyId"
+      <*> (parseAssetName <$> o .: "assetName")
+      <*> o .: "amount"
+    where
+      parseAssetName :: Text -> AssetName
+      parseAssetName t = AssetName $ toShort (encodeUtf8 t)
+
 toTxCert :: Word16 -> Cert -> TxCertificate
 toTxCert idx dcert =
   TxCertificate
@@ -172,6 +205,17 @@ getMaybeDatumHash :: Maybe DataHash -> TxOutDatum
 getMaybeDatumHash Nothing = NoDatum
 getMaybeDatumHash (Just hsh) = DatumHash hsh
 
+fromMultiAssetMap ::
+  Map (PolicyID StandardCrypto) (Map AssetName Integer) ->
+  [TxOutMultiAsset]
+fromMultiAssetMap = concat . toListBy foldAssets
+  where
+    foldAssets :: PolicyID StandardCrypto -> Map AssetName Integer -> [TxOutMultiAsset]
+    foldAssets policy = toListBy (TxOutMultiAsset policy)
+
+    toListBy :: (k -> a -> b) -> Map k a -> [b]
+    toListBy f = Map.foldrWithKey (\k a xs -> f k a : xs) []
+
 sumTxOutCoin :: [TxOut] -> Coin
 sumTxOutCoin = Coin . sum . map (unCoin . txOutAdaValue)
 
diff --git a/cardano-db-sync/src/Cardano/DbSync/Era/Shelley/Genesis.hs b/cardano-db-sync/src/Cardano/DbSync/Era/Shelley/Genesis.hs
@@ -264,6 +264,7 @@ insertTxOuts syncEnv trce blkId (TxIn txInId _, txOut) = do
             , C.txOutStakeAddressId = Nothing -- No stake addresses in Shelley Genesis
             , C.txOutTxId = txId
             , C.txOutValue = Generic.coinToDbLovelace (txOut ^. Core.valueTxOutL)
+            , C.txOutMaTxOut = Nothing
             , C.txOutConsumedByTxId = Nothing
             }
     DB.TxOutVariantAddress -> do
@@ -284,6 +285,7 @@ insertTxOuts syncEnv trce blkId (TxIn txInId _, txOut) = do
         , V.txOutInlineDatumId = Nothing
         , V.txOutReferenceScriptId = Nothing
         , V.txOutTxId = txId
+        , V.txOutMaTxOut = Nothing
         , V.txOutValue = Generic.coinToDbLovelace (txOut ^. Core.valueTxOutL)
         , V.txOutStakeAddressId = Nothing -- No stake addresses in Shelley Genesis
         }
diff --git a/cardano-db-sync/src/Cardano/DbSync/Era/Universal/Insert/Tx.hs b/cardano-db-sync/src/Cardano/DbSync/Era/Universal/Insert/Tx.hs
@@ -24,7 +24,7 @@ import Cardano.DbSync.Cache (queryTxIdWithCache, tryUpdateCacheTx)
 import Cardano.DbSync.Cache.Types (CacheStatus (..))
 import qualified Cardano.DbSync.Era.Shelley.Generic as Generic
 import Cardano.DbSync.Era.Shelley.Generic.Metadata (TxMetadataValue (..), metadataValueToJsonNoSchema)
-import Cardano.DbSync.Era.Shelley.Generic.Tx.Types (TxIn (..))
+import Cardano.DbSync.Era.Shelley.Generic.Tx.Types (TxIn (..), fromMultiAssetMap)
 import Cardano.DbSync.Era.Universal.Insert.Certificate (insertCertificate)
 import Cardano.DbSync.Era.Universal.Insert.GovAction (
   insertGovActionProposal,
@@ -240,6 +240,7 @@ insertTxOut tracer cache iopts (txId, txHash) (Generic.TxOut index addr value ma
               , C.txOutReferenceScriptId = mScriptId
               , C.txOutStakeAddressId = mSaId
               , C.txOutTxId = txId
+              , C.txOutMaTxOut = Just multiAssetsJson
               , C.txOutValue = Generic.coinToDbLovelace value
               }
       DB.TxOutVariantAddress -> do
@@ -261,7 +262,9 @@ insertTxOut tracer cache iopts (txId, txHash) (Generic.TxOut index addr value ma
         case ioTxOutTableType iopts of
           DB.TxOutCore -> ExtendedTxOut txHash txOut
           DB.TxOutVariantAddress -> ExtendedTxOut txHash txOut
-  !maTxOuts <- whenFalseMempty (ioMultiAssets iopts) $ insertMaTxOuts tracer cache maMap
+  !maTxOuts <-
+    whenFalseMempty (ioMultiAssets iopts) $
+      insertMaTxOuts tracer cache maMap
   pure (eutxo, maTxOuts)
   where
     hasScript :: Bool
@@ -270,6 +273,10 @@ insertTxOut tracer cache iopts (txId, txHash) (Generic.TxOut index addr value ma
     addrText :: Text
     addrText = Generic.renderAddress addr
 
+    multiAssetsJson :: Text
+    multiAssetsJson =
+      decodeUtf8 . LBS.toStrict . Aeson.encode . fromMultiAssetMap $ maMap
+
     mkTxOutVariant :: Maybe DB.StakeAddressId -> V.AddressId -> Maybe DB.DatumId -> Maybe DB.ScriptId -> V.TxOut
     mkTxOutVariant mSaId addrId mDatumId mScriptId =
       V.TxOut
@@ -281,6 +288,7 @@ insertTxOut tracer cache iopts (txId, txHash) (Generic.TxOut index addr value ma
         , V.txOutReferenceScriptId = mScriptId
         , V.txOutTxId = txId
         , V.txOutValue = Generic.coinToDbLovelace value
+        , V.txOutMaTxOut = Just multiAssetsJson
         , V.txOutStakeAddressId = mSaId
         }
 
diff --git a/cardano-db/src/Cardano/Db/Schema/Core/TxOut.hs b/cardano-db/src/Cardano/Db/Schema/Core/TxOut.hs
@@ -49,6 +49,7 @@ share
     stakeAddressId      StakeAddressId Maybe noreference
     txId                TxId                noreference
     value               DbLovelace          sqltype=lovelace
+    maTxOut             Text Maybe          sqltype=jsonb
     UniqueTxout         txId index          -- The (tx_id, index) pair must be unique.
 
 ----------------------------------------------
diff --git a/cardano-db/src/Cardano/Db/Schema/Variant/TxOut.hs b/cardano-db/src/Cardano/Db/Schema/Variant/TxOut.hs
@@ -47,6 +47,7 @@ share
     stakeAddressId      StakeAddressId Maybe noreference
     txId                TxId                noreference
     value               DbLovelace          sqltype=lovelace
+    maTxOut             Text Maybe          sqltype=jsonb
     UniqueTxout         txId index          -- The (tx_id, index) pair must be unique.
 
   CollateralTxOut
diff --git a/schema/migration-2-0045-20241203.sql b/schema/migration-2-0045-20241203.sql
@@ -0,0 +1,21 @@
+-- Persistent generated migration.
+
+CREATE FUNCTION migrate() RETURNS void AS $$
+DECLARE
+  next_version int ;
+BEGIN
+  SELECT stage_two + 1 INTO next_version FROM schema_version ;
+  IF next_version = 45 THEN
+    EXECUTE 'ALTER TABLE "reward" ADD COLUMN "id" INT8 NOT NULL' ;
+    EXECUTE 'ALTER TABLE "reward_rest" ADD COLUMN "id" INT8 NOT NULL' ;
+    EXECUTE 'ALTER TABLE "tx_out" ADD COLUMN "ma_tx_out" jsonb NULL' ;
+    -- Hand written SQL statements can be added here.
+    UPDATE schema_version SET stage_two = next_version ;
+    RAISE NOTICE 'DB has been migrated to stage_two version %', next_version ;
+  END IF ;
+END ;
+$$ LANGUAGE plpgsql ;
+
+SELECT migrate() ;
+
+DROP FUNCTION migrate() ;

Original file line number	Diff line number	Diff line change
`@@ -224,6 +224,7 @@ insertTxOutsByron syncEnv disInOut blkId (address, value) = do`
`224`	`224`	`, C.txOutInlineDatumId = Nothing`
`225`	`225`	`, C.txOutReferenceScriptId = Nothing`
`226`	`226`	`, C.txOutConsumedByTxId = Nothing`
	`227`	`+ , C.txOutMaTxOut = Nothing`
`227`	`228`	`}`
`228`	`229`	`DB.TxOutVariantAddress -> do`
`229`	`230`	`let addrRaw = serialize' address`
`@@ -244,6 +245,7 @@ insertTxOutsByron syncEnv disInOut blkId (address, value) = do`
`244`	`245`	`, V.txOutAddressId = addrDetailId`
`245`	`246`	`, V.txOutConsumedByTxId = Nothing`
`246`	`247`	`, V.txOutStakeAddressId = Nothing`
	`248`	`+ , V.txOutMaTxOut = Nothing`
`247`	`249`	`}`
`248`	`250`
`249`	`251`	`mkVAddress :: ByteString -> V.Address`