feature(cardano-db): Add new tx field treasury_donation

Author: sgillespie

cardano-db-sync/src/Cardano/DbSync/Era/Byron/Genesis.hs

@@ -201,6 +201,7 @@ insertTxOuts hasConsumed disInOut blkId (address, value) = do
               , DB.txInvalidBefore = Nothing
               , DB.txValidContract = True
               , DB.txScriptSize = 0
+              , DB.txTreasuryDonation = DB.DbLovelace 0
               }
       lift $
         DB.insertTxOutPlex hasConsumed disInOut $

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

@@ -253,6 +253,7 @@ insertByronTx syncEnv blkId tx blockIndex = do
             , DB.txInvalidBefore = Nothing
             , DB.txValidContract = True
             , DB.txScriptSize = 0
+            , DB.txTreasuryDonation = DbLovelace 0
             }
 
       when (ioTxCBOR iopts) $ do
@@ -295,6 +296,7 @@ insertByronTx' syncEnv blkId tx blockIndex = do
         , DB.txInvalidBefore = Nothing
         , DB.txValidContract = True
         , DB.txScriptSize = 0
+        , DB.txTreasuryDonation = DbLovelace 0
         }
 
   when (ioTxCBOR iopts) $ do

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

@@ -241,6 +241,7 @@ insertTxOuts trce hasConsumed disInOut blkId (TxIn txInId _, txOut) = do
         , DB.txInvalidBefore = Nothing
         , DB.txValidContract = True
         , DB.txScriptSize = 0
+        , DB.txTreasuryDonation = DB.DbLovelace 0
         }
   _ <- insertStakeAddressRefIfMissing trce useNoCache (txOut ^. Core.addrTxOutL)
   DB.insertTxOutPlex hasConsumed disInOut $
@@ -286,6 +287,7 @@ insertStaking tracer cache blkId genesis = do
           , DB.txInvalidBefore = Nothing
           , DB.txValidContract = True
           , DB.txScriptSize = 0
+          , DB.txTreasuryDonation = DB.DbLovelace 0
           }
   let params = zip [0 ..] $ ListMap.elems $ sgsPools $ sgStaking genesis
   let network = sgNetworkId genesis

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

@@ -117,6 +117,7 @@ insertTx syncEnv isMember blkId epochNo slotNo applyResult blockIndex tx grouped
         , DB.txInvalidHereafter = DbWord64 . unSlotNo <$> Generic.txInvalidHereafter tx
         , DB.txValidContract = Generic.txValidContract tx
         , DB.txScriptSize = sum $ Generic.txScriptSizes tx
+        , DB.txTreasuryDonation = DB.DbLovelace 0
         }
 
   when (ioTxCBOR iopts) $ do

cardano-db/src/Cardano/Db/Schema.hs

@@ -131,6 +131,9 @@ share
     scriptSize          Word64              sqltype=word31type
     UniqueTx            hash
 
+    -- New for Conway
+    treasuryDonation    DbLovelace          sqltype=lovelace default=0
+
   TxCbor
     txId                TxId                noreference
     bytes               ByteString          sqltype=bytea

cardano-db/test/Test/IO/Cardano/Db/Insert.hs

@@ -170,6 +170,7 @@ txZero bid =
     , txInvalidHereafter = Nothing
     , txValidContract = True
     , txScriptSize = 0
+    , txTreasuryDonation = DbLovelace 0
     }
 
 poolHash0 :: PoolHash

cardano-db/test/Test/IO/Cardano/Db/Rollback.hs

@@ -112,7 +112,22 @@ createAndInsertBlocks blockCount =
         if indx /= 0
           then pure mTxOutId
           else do
-            txId <- insertTx $ Tx (mkTxHash blkId 0) blkId 0 (DbLovelace 0) (DbLovelace 0) (Just 0) 12 Nothing Nothing True 0
+            txId <-
+              insertTx $
+                Tx
+                  (mkTxHash blkId 0)
+                  blkId
+                  0
+                  (DbLovelace 0)
+                  (DbLovelace 0)
+                  (Just 0)
+                  12
+                  Nothing
+                  Nothing
+                  True
+                  0
+                  (DbLovelace 0)
+
             void $ insertTxOut (mkTxOut blkId txId)
             pure $ Just txId
       case (indx, mTxOutId) of

cardano-db/test/Test/IO/Cardano/Db/TotalSupply.hs

@@ -49,6 +49,7 @@ initialSupplyTest =
           , txInvalidBefore = Nothing
           , txValidContract = True
           , txScriptSize = 0
+          , txTreasuryDonation = DbLovelace 0
           }
     _ <- insertTxIn (TxIn tx1Id (head tx0Ids) 0 Nothing)
     let addr = mkAddressHash bid1 tx1Id

cardano-db/test/Test/IO/Cardano/Db/Util.hs

@@ -91,6 +91,7 @@ mkTxs blkId count =
         , txInvalidBefore = Nothing
         , txValidContract = True
         , txScriptSize = 0
+        , txTreasuryDonation = DbLovelace 0
         }
 
 testSlotLeader :: SlotLeader

schema/migration-2-0040-20240626.sql

@@ -0,0 +1,19 @@
+-- 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 = 40 THEN
+    EXECUTE 'ALTER TABLE "tx" ADD COLUMN "treasury_donation" lovelace NOT NULL DEFAULT 0' ;
+    -- 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() ;