Add a new constitution table

Author: kderme

cardano-db-sync/CHANGELOG.md

@@ -24,6 +24,7 @@ In the schema docs, you can search for `13.2` or `Conway` for schema changes fro
 - always_abstain and always_no_confidence drep_hash entries now have a null `raw` value and the unique key changed
 - governance_action.description now uses the json format
 - new offchain capabilites for voting anchor
+- add a constitution table
 
 ### sancho-2.3.0
 - is compatible with node 8.7-pre

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

@@ -367,7 +367,7 @@ insertTx syncEnv isMember blkId epochNo slotNo applyResult blockIndex tx grouped
             Generic.txMint tx
 
       when (ioPlutusExtra iopts) $
-        mapM_ (insertScript tracer txId) $
+        mapM_ (lift . insertScript tracer txId) $
           Generic.txScripts tx
 
       when (ioPlutusExtra iopts) $
@@ -402,7 +402,7 @@ prepareTxOut tracer cache iopts (txId, txHash) (Generic.TxOut index addr addrRaw
   mScriptId <-
     whenFalseEmpty (ioPlutusExtra iopts) Nothing $
       whenMaybe mScript $
-        insertScript tracer txId
+        lift . insertScript tracer txId
   let !txOut =
         DB.TxOut
           { DB.txOutTxId = txId
@@ -441,7 +441,7 @@ insertCollateralTxOut tracer cache iopts (txId, _txHash) (Generic.TxOut index ad
   mScriptId <-
     whenFalseEmpty (ioPlutusExtra iopts) Nothing $
       whenMaybe mScript $
-        insertScript tracer txId
+        lift . insertScript tracer txId
   _ <-
     lift
       . DB.insertCollateralTxOut
@@ -1390,16 +1390,15 @@ insertScript ::
   Trace IO Text ->
   DB.TxId ->
   Generic.TxScript ->
-  ExceptT SyncNodeError (ReaderT SqlBackend m) DB.ScriptId
+  ReaderT SqlBackend m DB.ScriptId
 insertScript tracer txId script = do
-  mScriptId <- lift $ DB.queryScript $ Generic.txScriptHash script
+  mScriptId <- DB.queryScript $ Generic.txScriptHash script
   case mScriptId of
     Just scriptId -> pure scriptId
     Nothing -> do
       json <- scriptConvert script
-      lift
-        . DB.insertScript
-        $ DB.Script
+      DB.insertScript $
+        DB.Script
           { DB.scriptTxId = txId
           , DB.scriptHash = Generic.txScriptHash script
           , DB.scriptType = Generic.txScriptType script
@@ -1479,7 +1478,7 @@ insertGovActionProposal cache blkId txId govExpiresAt (index, pp) = do
   prevGovActionDBId <- case mprevGovAction of
     Nothing -> pure Nothing
     Just prevGovActionId -> Just <$> resolveGovActionProposal prevGovActionId
-  govActionProposal <-
+  govActionProposalId <-
     lift $
       DB.insertGovActionProposal $
         DB.GovActionProposal
@@ -1499,15 +1498,17 @@ insertGovActionProposal cache blkId txId govExpiresAt (index, pp) = do
           , DB.govActionProposalExpiredEpoch = Nothing
           }
   case pProcGovAction pp of
-    TreasuryWithdrawals mp -> lift $ mapM_ (insertTreasuryWithdrawal govActionProposal) (Map.toList mp)
-    UpdateCommittee _ removed added q -> lift $ insertNewCommittee govActionProposal removed added q
+    TreasuryWithdrawals mp -> lift $ mapM_ (insertTreasuryWithdrawal govActionProposalId) (Map.toList mp)
+    UpdateCommittee _ removed added q -> lift $ insertNewCommittee govActionProposalId removed added q
+    NewConstitution _ constitution -> lift $ insertConstitution txId govActionProposalId constitution
     _ -> pure ()
   where
     mprevGovAction :: Maybe (GovActionId StandardCrypto) = case pProcGovAction pp of
       ParameterChange prv _ -> unPrevGovActionId <$> strictMaybeToMaybe prv
       HardForkInitiation prv _ -> unPrevGovActionId <$> strictMaybeToMaybe prv
       NoConfidence prv -> unPrevGovActionId <$> strictMaybeToMaybe prv
       UpdateCommittee prv _ _ _ -> unPrevGovActionId <$> strictMaybeToMaybe prv
+      NewConstitution prv _ -> unPrevGovActionId <$> strictMaybeToMaybe prv
       _ -> Nothing
 
     insertTreasuryWithdrawal gaId (rwdAcc, coin) = do
@@ -1541,6 +1542,16 @@ insertAnchor txId anchor =
       , DB.votingAnchorDataHash = Generic.safeHashToByteString $ anchorDataHash anchor
       }
 
+insertConstitution :: (MonadIO m, MonadBaseControl IO m) => DB.TxId -> DB.GovActionProposalId -> Constitution StandardConway -> ReaderT SqlBackend m ()
+insertConstitution txId gapId constitution = do
+  votingAnchorId <- insertAnchor txId $ constitutionAnchor constitution
+  void . DB.insertConstitution $
+    DB.Constitution
+      { DB.constitutionGovActionProposalId = gapId
+      , DB.constitutionVotingAnchorId = votingAnchorId
+      , DB.constitutionScriptHash = Generic.unScriptHash <$> strictMaybeToMaybe (constitutionScript constitution)
+      }
+
 insertVotingProcedures ::
   (MonadIO m, MonadBaseControl IO m) =>
   Trace IO Text ->

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

@@ -148,6 +148,7 @@ deleteTablesAfterTxId mtxId mtxInId mtxOutId mmaTxOutId = do
     whenJust mgaId $ \gaId -> do
       queryFirstAndDeleteAfter TreasuryWithdrawalGovActionProposalId gaId
       queryFirstAndDeleteAfter NewCommitteeGovActionProposalId gaId
+      queryFirstAndDeleteAfter ConstitutionGovActionProposalId gaId
       deleteWhere [GovActionProposalId >=. gaId]
     mvaId <- queryMinRefId VotingAnchorTxId txId
     whenJust mvaId $ \vaId -> do

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

@@ -67,6 +67,7 @@ module Cardano.Db.Insert (
   setNullRatified,
   replaceAdaPots,
   insertAnchor,
+  insertConstitution,
   insertGovActionProposal,
   insertTreasuryWithdrawal,
   insertNewCommittee,
@@ -377,6 +378,9 @@ replaceAdaPots blockId adapots = do
 insertAnchor :: (MonadBaseControl IO m, MonadIO m) => VotingAnchor -> ReaderT SqlBackend m VotingAnchorId
 insertAnchor = insertCheckUnique "VotingAnchor"
 
+insertConstitution :: (MonadBaseControl IO m, MonadIO m) => Constitution -> ReaderT SqlBackend m ConstitutionId
+insertConstitution = insertUnchecked "Constitution"
+
 insertGovActionProposal :: (MonadBaseControl IO m, MonadIO m) => GovActionProposal -> ReaderT SqlBackend m GovActionProposalId
 insertGovActionProposal = insertUnchecked "GovActionProposal"
 

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

@@ -607,6 +607,11 @@ share
     deletedMembers      Text
     addedMembers        Text
 
+  Constitution
+    govActionProposalId  GovActionProposalId  noreference
+    votingAnchorId       VotingAnchorId       noreference
+    scriptHash           ByteString Maybe     sqltype=hash28type
+
   VotingProcedure -- GovVote
     txId                 TxId                 noreference
     index                Word16
@@ -1228,6 +1233,12 @@ schemaDocs =
       NewCommitteeDeletedMembers # "The removed members of the committee. This is now given in a text as a description, but may change. TODO: Conway."
       NewCommitteeAddedMembers # "The new members of the committee. This is now given in a text as a description, but may change. TODO: Conway."
 
+    Constitution --^ do
+      "A table for constitutiona attached to a GovActionProposal. New in 13.2-Conway."
+      ConstitutionGovActionProposalId # "The GovActionProposal table index for this constitution."
+      ConstitutionVotingAnchorId # "The ConstitutionVotingAnchor table index for this constitution."
+      ConstitutionScriptHash # "The Script Hash. It's associated script may not be already inserted in the script table."
+
     VotingProcedure --^ do
       "A table for voting procedures, aka GovVote. A Vote can be Yes No or Abstain. New in 13.2-Conway."
       VotingProcedureTxId # "The Tx table index of the tx that includes this VotingProcedure."

schema/migration-2-0034-20231218.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 = 34 THEN
+    EXECUTE 'CREATe TABLE "constitution"("id" SERIAL8  PRIMARY KEY UNIQUE,"gov_action_proposal_id" INT8 NOT NULL,"voting_anchor_id" INT8 NOT NULL,"script_hash" hash28type 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() ;