Add new tables for CIP-108 and CIP-119

Author: kderme

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

@@ -143,6 +143,10 @@ insertOffChainVoteResults trce resultQueue = do
       OffChainVoteResultMetadata md accessors -> do
         mocvdId <- DB.insertOffChainVoteData md
         whenJust mocvdId $ \ocvdId -> do
+          whenJust (offChainVoteGovAction accessors ocvdId) $ \ocvga ->
+            void $ DB.insertOffChainVoteGovActionData ocvga
+          whenJust (offChainVoteDrep accessors ocvdId) $ \ocvdr ->
+            void $ DB.insertOffChainVoteDrepData ocvdr
           DB.insertOffChainVoteAuthors $ offChainVoteAuthors accessors ocvdId
           DB.insertOffChainVoteReference $ offChainVoteReferences accessors ocvdId
           DB.insertOffChainVoteExternalUpdate $ offChainVoteExternalUpdates accessors ocvdId
@@ -275,22 +279,20 @@ fetchOffChainVoteData _tracer manager time oVoteWorkQ =
               DB.OffChainVoteData
                 { DB.offChainVoteDataLanguage = Vote.getLanguage offChainData
                 , DB.offChainVoteDataComment = Vote.textValue <$> Vote.comment minimalBody
-                , DB.offChainVoteDataTitle = Vote.getTitle offChainData
-                , DB.offChainVoteDataAbstract = Vote.getAbstract offChainData
-                , DB.offChainVoteDataMotivation = Vote.getMotivation offChainData
-                , DB.offChainVoteDataRationale = Vote.getRationale offChainData
                 , DB.offChainVoteDataBytes = sovaBytes sVoteData
                 , DB.offChainVoteDataHash = sovaHash sVoteData
                 , DB.offChainVoteDataJson = sovaJson sVoteData
                 , DB.offChainVoteDataVotingAnchorId = oVoteWqReferenceId oVoteWorkQ
                 , DB.offChainVoteDataWarning = sovaWarning sVoteData
                 , DB.offChainVoteDataIsValid = Nothing
                 }
+            gaF ocvdId = mkGovAction ocvdId offChainData
+            drepF ocvdId = mkDrep ocvdId offChainData
             authorsF ocvdId = map (mkAuthor ocvdId) $ Vote.getAuthors offChainData
             referencesF ocvdId = map (mkReference ocvdId) $ mListToList $ Vote.references minimalBody
             externalUpdatesF ocvdId = map (mkexternalUpdates ocvdId) $ mListToList $ Vote.externalUpdates minimalBody
            in
-            OffChainVoteResultMetadata vdt (OffChainVoteAccessors authorsF referencesF externalUpdatesF)
+            OffChainVoteResultMetadata vdt (OffChainVoteAccessors gaF drepF authorsF referencesF externalUpdatesF)
         Left err ->
           OffChainVoteResultError $
             DB.OffChainVoteFetchError
@@ -299,6 +301,31 @@ fetchOffChainVoteData _tracer manager time oVoteWorkQ =
               , DB.offChainVoteFetchErrorFetchTime = Time.posixSecondsToUTCTime time
               , DB.offChainVoteFetchErrorRetryCount = retryCount (oVoteWqRetry oVoteWorkQ)
               }
+    mkGovAction ocvdId = \case
+      Vote.OffChainVoteDataGa dt ->
+        Just $
+          DB.OffChainVoteGovActionData
+            { DB.offChainVoteGovActionDataOffChainVoteDataId = ocvdId
+            , DB.offChainVoteGovActionDataTitle = Vote.textValue $ Vote.title $ Vote.body dt
+            , DB.offChainVoteGovActionDataAbstract = Vote.textValue $ Vote.abstract $ Vote.body dt
+            , DB.offChainVoteGovActionDataMotivation = Vote.textValue $ Vote.motivation $ Vote.body dt
+            , DB.offChainVoteGovActionDataRationale = Vote.textValue $ Vote.rationale $ Vote.body dt
+            }
+      _ -> Nothing
+
+    mkDrep ocvdId = \case
+      Vote.OffChainVoteDataDr dt ->
+        Just $
+          DB.OffChainVoteDrepData
+            { DB.offChainVoteDrepDataOffChainVoteDataId = ocvdId
+            , DB.offChainVoteDrepDataPaymentAddress = Vote.textValue <$> Vote.paymentAddress (Vote.body dt)
+            , DB.offChainVoteDrepDataGivenName = Vote.textValue $ Vote.givenName $ Vote.body dt
+            , DB.offChainVoteDrepDataObjectives = Vote.textValue <$> Vote.objectives (Vote.body dt)
+            , DB.offChainVoteDrepDataMotivations = Vote.textValue <$> Vote.motivations (Vote.body dt)
+            , DB.offChainVoteDrepDataQualifications = Vote.textValue <$> Vote.qualifications (Vote.body dt)
+            }
+      _ -> Nothing
+
     mkAuthor ocvdId au =
       DB.OffChainVoteAuthor
         { DB.offChainVoteAuthorOffChainVoteDataId = ocvdId

cardano-db-sync/src/Cardano/DbSync/OffChain/Vote/Types.hs

@@ -157,7 +157,10 @@ data DrepBody = DrepBody
   }
   deriving (Show, Generic)
 
-data Image = Image TextValue
+data Image = Image
+  { contentUrl :: Text
+  , sha256 :: Text
+  }
   deriving (Show, Generic, FromJSON)
 
 data Reference tp = Reference

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

@@ -153,7 +153,9 @@ data OffChainVoteResult
   | OffChainVoteResultError !OffChainVoteFetchError
 
 data OffChainVoteAccessors = OffChainVoteAccessors
-  { offChainVoteAuthors :: DB.OffChainVoteDataId -> [OffChainVoteAuthor]
+  { offChainVoteGovAction :: DB.OffChainVoteDataId -> Maybe DB.OffChainVoteGovActionData
+  , offChainVoteDrep :: DB.OffChainVoteDataId -> Maybe DB.OffChainVoteDrepData
+  , offChainVoteAuthors :: DB.OffChainVoteDataId -> [OffChainVoteAuthor]
   , offChainVoteReferences :: DB.OffChainVoteDataId -> [OffChainVoteReference]
   , offChainVoteExternalUpdates :: DB.OffChainVoteDataId -> [OffChainVoteExternalUpdate]
   }

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

@@ -56,6 +56,8 @@ module Cardano.Db.Insert (
   insertCheckOffChainPoolData,
   insertCheckOffChainPoolFetchError,
   insertOffChainVoteData,
+  insertOffChainVoteGovActionData,
+  insertOffChainVoteDrepData,
   insertOffChainVoteAuthors,
   insertOffChainVoteReference,
   insertOffChainVoteExternalUpdate,
@@ -343,6 +345,12 @@ insertOffChainVoteData ocvd = do
     then Just <$> insertCheckUnique "OffChainVoteData" ocvd
     else pure Nothing
 
+insertOffChainVoteGovActionData :: (MonadBaseControl IO m, MonadIO m) => OffChainVoteGovActionData -> ReaderT SqlBackend m OffChainVoteGovActionDataId
+insertOffChainVoteGovActionData = insertUnchecked "OffChainVoteGovActionData"
+
+insertOffChainVoteDrepData :: (MonadBaseControl IO m, MonadIO m) => OffChainVoteDrepData -> ReaderT SqlBackend m OffChainVoteDrepDataId
+insertOffChainVoteDrepData = insertUnchecked "OffChainVoteDrepData"
+
 insertOffChainVoteAuthors :: (MonadBaseControl IO m, MonadIO m) => [OffChainVoteAuthor] -> ReaderT SqlBackend m ()
 insertOffChainVoteAuthors = void . insertMany' "OffChainVoteAuthor"
 

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

@@ -690,17 +690,28 @@ share
     hash                ByteString
     language            Text
     comment             Text Maybe
-    title               Text Maybe
-    abstract            Text Maybe
-    motivation          Text Maybe
-    rationale           Text Maybe
     json                Text                sqltype=jsonb
     bytes               ByteString          sqltype=bytea
     warning             Text Maybe
     isValid             Bool Maybe
     UniqueOffChainVoteData votingAnchorId hash
     deriving Show
 
+  OffChainVoteGovActionData
+    offChainVoteDataId  OffChainVoteDataId  noreference
+    title               Text
+    abstract            Text
+    motivation          Text
+    rationale           Text
+
+  OffChainVoteDrepData
+    offChainVoteDataId  OffChainVoteDataId  noreference
+    paymentAddress      Text Maybe
+    givenName           Text
+    objectives          Text Maybe
+    motivations         Text Maybe
+    qualifications      Text Maybe
+
   OffChainVoteAuthor
     offChainVoteDataId  OffChainVoteDataId  noreference
     name                Text Maybe
@@ -1340,10 +1351,6 @@ schemaDocs =
       OffChainVoteDataVotingAnchorId # "The VotingAnchor table index this offchain data refers."
       OffChainVoteDataHash # "The hash of the offchain data."
       OffChainVoteDataLanguage # "The langauge described in the context of the metadata. Described in CIP-100. New in 13.3-Conway."
-      OffChainVoteDataComment # "The title of the metadata. Described in CIP-108. New in 13.3-Conway."
-      OffChainVoteDataAbstract # "The abstract of the metadata. Described in CIP-108. New in 13.3-Conway."
-      OffChainVoteDataMotivation # "The motivation of the metadata. Described in CIP-108. New in 13.3-Conway."
-      OffChainVoteDataRationale # "The rationale of the metadata. Described in CIP-108. New in 13.3-Conway."
       OffChainVoteDataJson # "The payload as JSON."
       OffChainVoteDataBytes # "The raw bytes of the payload."
       OffChainVoteDataWarning # "A warning that occured while validating the metadata."
@@ -1352,6 +1359,23 @@ schemaDocs =
           \since it normally populates off_chain_vote_fetch_error for invalid data. \
           \It can be used manually to mark some metadata invalid by clients."
 
+    OffChainVoteGovActionData --^ do
+      "The table with offchain metadata for Governance Actions. Implementes CIP-108. New in 13.3-Conway."
+      OffChainVoteGovActionDataOffChainVoteDataId # "The vote metadata table index this offchain data belongs to."
+      OffChainVoteGovActionDataTitle # "The title"
+      OffChainVoteGovActionDataAbstract # "The abstract"
+      OffChainVoteGovActionDataMotivation # "The motivation"
+      OffChainVoteGovActionDataRationale # "The rationale"
+
+    OffChainVoteDrepData --^ do
+      "The table with offchain metadata for Drep Registrations. Implementes CIP-108. New in 13.3-Conway."
+      OffChainVoteDrepDataOffChainVoteDataId # "The vote metadata table index this offchain data belongs to."
+      OffChainVoteDrepDataPaymentAddress # "The payment address"
+      OffChainVoteDrepDataGivenName # "The name. This is the only mandatory field"
+      OffChainVoteDrepDataObjectives # "The objectives"
+      OffChainVoteDrepDataMotivations # "The motivations"
+      OffChainVoteDrepDataQualifications # "The qualifications"
+
     OffChainVoteAuthor --^ do
       "The table with offchain metadata authors, as decribed in CIP-100. New in 13.3-Conway."
       OffChainVoteAuthorOffChainVoteDataId # "The OffChainVoteData table index this offchain data refers."