Add migrations and document

Author: kderme

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

@@ -284,6 +284,7 @@ fetchOffChainVoteData _tracer manager time oVoteWorkQ =
                 , DB.offChainVoteDataJson = sovaJson sVoteData
                 , DB.offChainVoteDataVotingAnchorId = oVoteWqReferenceId oVoteWorkQ
                 , DB.offChainVoteDataWarning = sovaWarning sVoteData
+                , DB.offChainVoteDataIsValid = Nothing
                 }
             authorsF ocvdId = map (mkAuthor ocvdId) $ Vote.getAuthors offChainData
             referencesF ocvdId = map (mkReference ocvdId) $ mListToList $ Vote.references minimalBody
@@ -305,6 +306,7 @@ fetchOffChainVoteData _tracer manager time oVoteWorkQ =
         , DB.offChainVoteAuthorWitnessAlgorithm = Vote.witnessAlgorithm $ Vote.witness au
         , DB.offChainVoteAuthorPublicKey = Vote.publicKey $ Vote.witness au
         , DB.offChainVoteAuthorSignature = Vote.signature $ Vote.witness au
+        , DB.offChainVoteAuthorWarning = Just "Failed to validate this signature" -- TODO: Conway
         }
 
     mkReference ocvdId ref =

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

@@ -686,6 +686,7 @@ share
     json                Text                sqltype=jsonb
     bytes               ByteString          sqltype=bytea
     warning             Text Maybe
+    isValid             Bool Maybe
     UniqueOffChainVoteData votingAnchorId hash
     deriving Show
 
@@ -695,6 +696,7 @@ share
     witnessAlgorithm    Text
     publicKey           Text
     signature           Text
+    warning             Text Maybe
 
   OffChainVoteReference
     offChainVoteDataId  OffChainVoteDataId  noreference
@@ -1322,9 +1324,45 @@ schemaDocs =
       \ decribed in CIP-100. New in 13.2-Conway."
       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."
+      OffChainVoteDataIsValid
+        # "False if the data is found invalid. db-sync leaves this field null \
+          \since it normally populates off_chain_vote_fetch_error for invalid data. \
+          \It can be used manually to mark some metadata invalid by clients."
+
+    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."
+      OffChainVoteAuthorName # "The name of the author."
+      OffChainVoteAuthorWitnessAlgorithm # "The witness algorithm used by the author."
+      OffChainVoteAuthorPublicKey # "The public key used by the author."
+      OffChainVoteAuthorSignature # "The signature of the author."
+      OffChainVoteAuthorWarning # "A warning related to verifying this metadata."
+
+    OffChainVoteReference --^ do
+      "The table with offchain metadata references, as decribed in CIP-100. New in 13.3-Conway."
+      OffChainVoteReferenceOffChainVoteDataId # "The OffChainVoteData table index this entry refers."
+      OffChainVoteReferenceLabel # "The label of this vote reference."
+      OffChainVoteReferenceUri # "The uri of this vote reference."
+      OffChainVoteReferenceHashDigest
+        # "The hash digest of this vote reference, as described in CIP-108. \
+          \This only appears for governance action metadata."
+      OffChainVoteReferenceHashAlgorithm
+        # "The hash algorithm of this vote reference, as described in CIP-108. \
+          \This only appears for governance action metadata."
+
+    OffChainVoteExternalUpdate --^ do
+      "The table with offchain metadata external updates, as decribed in CIP-100. New in 13.3-Conway."
+      OffChainVoteExternalUpdateOffChainVoteDataId # "The OffChainVoteData table index this entry refers."
+      OffChainVoteExternalUpdateTitle # "The title of this external update."
+      OffChainVoteExternalUpdateUri # "The uri of this external update."
 
     OffChainVoteFetchError --^ do
       "Errors while fetching or validating offchain Voting Anchor metadata. New in 13.2-Conway."

schema/migration-1-0013-20240318.sql

@@ -0,0 +1,23 @@
+-- Hand written migration to create the custom types with 'DOMAIN' statements.
+
+CREATE FUNCTION migrate() RETURNS void AS $$
+
+DECLARE
+  next_version int;
+
+BEGIN
+  SELECT stage_one + 1 INTO next_version FROM "schema_version";
+  IF next_version = 13 THEN
+
+    CREATE TYPE anchorType AS ENUM ('gov_action', 'other');
+
+    UPDATE "schema_version" SET stage_one = next_version;
+    RAISE NOTICE 'DB has been migrated to stage_one version %', next_version;
+  END IF;
+END;
+
+$$ LANGUAGE plpgsql;
+
+SELECT migrate();
+
+DROP FUNCTION migrate();

schema/migration-2-0036-20240318.sql

@@ -0,0 +1,31 @@
+-- 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 = 36 THEN
+    EXECUTE 'ALTER TABLE "voting_anchor" ADD COLUMN "type" anchorType NOT NULL' ;
+    EXECUTE 'ALTER TABLE "voting_anchor" DROP CONSTRAINT "unique_voting_anchor"' ;
+    EXECUTE 'ALTER TABLE "voting_anchor" ADD CONSTRAINT "unique_voting_anchor" UNIQUE("data_hash","url","type")' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "language" VARCHAR NOT NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "comment" VARCHAR NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "title" VARCHAR NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "abstract" VARCHAR NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "motivation" VARCHAR NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "rationale" VARCHAR NULL' ;
+    EXECUTE 'ALTER TABLE "off_chain_vote_data" ADD COLUMN "is_valid" BOOLEAN NULL' ;
+    EXECUTE 'CREATe TABLE "off_chain_vote_author"("id" SERIAL8  PRIMARY KEY UNIQUE,"off_chain_vote_data_id" INT8 NOT NULL,"name" VARCHAR NULL,"witness_algorithm" VARCHAR NOT NULL,"public_key" VARCHAR NOT NULL,"signature" VARCHAR NOT NULL,"warning" VARCHAR NULL)' ;
+    EXECUTE 'CREATe TABLE "off_chain_vote_reference"("id" SERIAL8  PRIMARY KEY UNIQUE,"off_chain_vote_data_id" INT8 NOT NULL,"label" VARCHAR NOT NULL,"uri" VARCHAR NOT NULL,"hash_digest" VARCHAR NULL,"hash_algorithm" VARCHAR NULL)' ;
+    EXECUTE 'CREATe TABLE "off_chain_vote_external_update"("id" SERIAL8  PRIMARY KEY UNIQUE,"off_chain_vote_data_id" INT8 NOT NULL,"title" VARCHAR NOT NULL,"uri" VARCHAR NOT 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() ;