Add offchain_vote_data config flag, default disabled for pools and votes

Author: kderme

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Alonzo/Config.hs

@@ -31,6 +31,7 @@ insertConfig = do
           , sioPlutus = PlutusDisable
           , sioGovernance = GovernanceConfig False
           , sioOffchainPoolData = OffchainPoolDataConfig False
+          , sioOffchainVoteData = OffchainVoteDataConfig False
           , sioPoolStats = PoolStatsConfig False
           , sioJsonType = JsonTypeDisable
           , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway/Config/Parse.hs

@@ -87,6 +87,7 @@ insertConfig = do
           , sioPlutus = PlutusDisable
           , sioGovernance = GovernanceConfig False
           , sioOffchainPoolData = OffchainPoolDataConfig False
+          , sioOffchainVoteData = OffchainVoteDataConfig False
           , sioPoolStats = PoolStatsConfig False
           , sioJsonType = JsonTypeDisable
           , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False

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

@@ -317,6 +317,7 @@ extractSyncOptions snp aop snc =
         , ioKeepMetadataNames = maybeKeepMNames
         , ioPlutusExtra = isPlutusEnabled (sioPlutus (dncInsertOptions snc))
         , ioOffChainPoolData = useOffchainPoolData
+        , ioOffChainVoteData = useOffchainVoteData
         , ioPoolStats = isPoolStatsEnabled (sioPoolStats (dncInsertOptions snc))
         , ioGov = useGovernance
         , ioRemoveJsonbFromSchema = isRemoveJsonbFromSchemaEnabled (sioRemoveJsonbFromSchema (dncInsertOptions snc))
@@ -326,6 +327,8 @@ extractSyncOptions snp aop snc =
     useLedger = sioLedger (dncInsertOptions snc) == LedgerEnable
     useOffchainPoolData =
       isOffchainPoolDataEnabled (sioOffchainPoolData (dncInsertOptions snc))
+    useOffchainVoteData =
+      isOffchainVoteDataEnabled (sioOffchainVoteData (dncInsertOptions snc))
     useGovernance =
       isGovernanceEnabled (sioGovernance (dncInsertOptions snc))
 

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

@@ -85,6 +85,7 @@ data InsertOptions = InsertOptions
   , ioKeepMetadataNames :: Strict.Maybe [Word64]
   , ioPlutusExtra :: !Bool
   , ioOffChainPoolData :: !Bool
+  , ioOffChainVoteData :: !Bool
   , ioPoolStats :: !Bool
   , ioGov :: !Bool
   , ioRemoveJsonbFromSchema :: !Bool

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

@@ -38,6 +38,7 @@ module Cardano.DbSync.Config.Types (
   PlutusConfig (..),
   GovernanceConfig (..),
   OffchainPoolDataConfig (..),
+  OffchainVoteDataConfig (..),
   JsonTypeConfig (..),
   SnapshotIntervalConfig (..),
   LedgerStateDir (..),
@@ -189,6 +190,7 @@ data SyncInsertOptions = SyncInsertOptions
   , sioPlutus :: PlutusConfig
   , sioGovernance :: GovernanceConfig
   , sioOffchainPoolData :: OffchainPoolDataConfig
+  , sioOffchainVoteData :: OffchainVoteDataConfig
   , sioPoolStats :: PoolStatsConfig
   , sioJsonType :: JsonTypeConfig
   , sioRemoveJsonbFromSchema :: RemoveJsonbFromSchemaConfig
@@ -266,6 +268,11 @@ newtype OffchainPoolDataConfig = OffchainPoolDataConfig
   }
   deriving (Eq, Show)
 
+newtype OffchainVoteDataConfig = OffchainVoteDataConfig
+  { isOffchainVoteDataEnabled :: Bool
+  }
+  deriving (Eq, Show)
+
 newtype RemoveJsonbFromSchemaConfig = RemoveJsonbFromSchemaConfig
   { isRemoveJsonbFromSchemaEnabled :: Bool
   }
@@ -462,6 +469,7 @@ parseOverrides obj baseOptions = do
     <*> obj .:? "plutus" .!= sioPlutus baseOptions
     <*> obj .:? "governance" .!= sioGovernance baseOptions
     <*> obj .:? "offchain_pool_data" .!= sioOffchainPoolData baseOptions
+    <*> obj .:? "offchain_vote_data" .!= sioOffchainVoteData baseOptions
     <*> obj .:? "pool_stat" .!= sioPoolStats baseOptions
     <*> obj .:? "json_type" .!= sioJsonType baseOptions
     <*> obj .:? "remove_jsonb_from_schema" .!= sioRemoveJsonbFromSchema baseOptions
@@ -484,6 +492,7 @@ optionsToList SyncInsertOptions {..} =
     , toJsonIfSet "plutus" sioPlutus
     , toJsonIfSet "governance" sioGovernance
     , toJsonIfSet "offchain_pool_data" sioOffchainPoolData
+    , toJsonIfSet "offchain_vote_data" sioOffchainVoteData
     , toJsonIfSet "pool_stat" sioPoolStats
     , toJsonIfSet "json_type" sioJsonType
     , toJsonIfSet "remove_jsonb_from_schema" sioRemoveJsonbFromSchema
@@ -506,6 +515,7 @@ instance FromJSON SyncInsertOptions where
       <*> obj .:? "plutus" .!= sioPlutus def
       <*> obj .:? "governance" .!= sioGovernance def
       <*> obj .:? "offchain_pool_data" .!= sioOffchainPoolData def
+      <*> obj .:? "offchain_vote_data" .!= sioOffchainVoteData def
       <*> obj .:? "pool_stat" .!= sioPoolStats def
       <*> obj .:? "json_type" .!= sioJsonType def
       <*> obj .:? "remove_jsonb_from_schema" .!= sioRemoveJsonbFromSchema def
@@ -523,6 +533,7 @@ instance ToJSON SyncInsertOptions where
       , "plutus" .= sioPlutus
       , "governance" .= sioGovernance
       , "offchain_pool_data" .= sioOffchainPoolData
+      , "offchain_vote_data" .= sioOffchainVoteData
       , "pool_stat" .= sioPoolStats
       , "json_type" .= sioJsonType
       , "remove_jsonb_from_schema" .= sioRemoveJsonbFromSchema
@@ -725,6 +736,15 @@ instance FromJSON OffchainPoolDataConfig where
       Just g -> pure (OffchainPoolDataConfig g)
       Nothing -> fail $ "unexpected offchain_pool_data: " <> show v
 
+instance ToJSON OffchainVoteDataConfig where
+  toJSON = boolToEnableDisable . isOffchainVoteDataEnabled
+
+instance FromJSON OffchainVoteDataConfig where
+  parseJSON = Aeson.withText "offchain_vote_data" $ \v ->
+    case enableDisableToBool v of
+      Just g -> pure (OffchainVoteDataConfig g)
+      Nothing -> fail $ "unexpected offchain_vote_data: " <> show v
+
 instance ToJSON JsonTypeConfig where
   toJSON JsonTypeText = "text"
   toJSON JsonTypeJsonb = "jsonb"
@@ -769,7 +789,8 @@ instance Default SyncInsertOptions where
       , sioMetadata = MetadataEnable
       , sioPlutus = PlutusEnable
       , sioGovernance = GovernanceConfig True
-      , sioOffchainPoolData = OffchainPoolDataConfig True
+      , sioOffchainPoolData = OffchainPoolDataConfig False
+      , sioOffchainVoteData = OffchainVoteDataConfig False
       , sioPoolStats = PoolStatsConfig False
       , sioJsonType = JsonTypeText
       , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
@@ -788,7 +809,8 @@ fullInsertOptions =
     , sioMetadata = MetadataEnable
     , sioPlutus = PlutusEnable
     , sioGovernance = GovernanceConfig True
-    , sioOffchainPoolData = OffchainPoolDataConfig True
+    , sioOffchainPoolData = OffchainPoolDataConfig False
+    , sioOffchainVoteData = OffchainVoteDataConfig False
     , sioPoolStats = PoolStatsConfig True
     , sioJsonType = JsonTypeText
     , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
@@ -806,8 +828,9 @@ onlyUTxOInsertOptions =
     , sioMultiAsset = MultiAssetEnable
     , sioMetadata = MetadataDisable
     , sioPlutus = PlutusDisable
-    , sioGovernance = GovernanceConfig False
+    , sioGovernance = GovernanceConfig True
     , sioOffchainPoolData = OffchainPoolDataConfig False
+    , sioOffchainVoteData = OffchainVoteDataConfig False
     , sioPoolStats = PoolStatsConfig False
     , sioJsonType = JsonTypeText
     , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
@@ -834,6 +857,7 @@ disableAllInsertOptions =
     , sioMetadata = MetadataDisable
     , sioPlutus = PlutusDisable
     , sioOffchainPoolData = OffchainPoolDataConfig False
+    , sioOffchainVoteData = OffchainVoteDataConfig False
     , sioPoolStats = PoolStatsConfig False
     , sioGovernance = GovernanceConfig False
     , sioJsonType = JsonTypeText

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

@@ -268,7 +268,7 @@ runFetchOffChainPoolThread syncEnv = do
 runFetchOffChainVoteThread :: SyncEnv -> IO ()
 runFetchOffChainVoteThread syncEnv = do
   -- if disable gov is active then don't run voting anchor thread
-  when (ioGov iopts) $ do
+  when (ioOffChainVoteData iopts && ioGov iopts) $ do
     logInfo trce "Running Offchain Vote Anchor fetch thread"
     pgconfig <- DB.runOrThrowIO (DB.readPGPass DB.PGPassDefaultEnv)
     connSetting <- case DB.toConnectionSetting pgconfig of

cardano-db-sync/test/Cardano/DbSync/Config/TypesTest.hs

@@ -139,7 +139,7 @@ genDefaultJson =
             "script_hashes": null
           },
           "governance": "enable",
-          "offchain_pool_data": "enable",
+          "offchain_pool_data": "disable",
           "json_type": "text"
         }
       |]
@@ -166,7 +166,7 @@ genDefaultJson =
             "enable": true
           },
           "governance": "enable",
-          "offchain_pool_data": "enable",
+          "offchain_pool_data": "disable",
           "json_type": "text"
         }
       |]

cardano-db-sync/test/Cardano/DbSync/Gen.hs

@@ -132,6 +132,7 @@ syncInsertOptions =
     <*> plutusConfig
     <*> (GovernanceConfig <$> Gen.bool)
     <*> (OffchainPoolDataConfig <$> Gen.bool)
+    <*> (OffchainVoteDataConfig <$> Gen.bool)
     <*> (PoolStatsConfig <$> Gen.bool)
     <*> Gen.element [JsonTypeText, JsonTypeJsonb, JsonTypeDisable]
     <*> (RemoveJsonbFromSchemaConfig <$> Gen.bool)

doc/configuration.md

@@ -16,7 +16,7 @@ file (`db-sync-config.json` or `db-sync-config.yaml`).
 
 ## Simple Example
 
-Below is a sample `insert_options` section that shows all the defaults:
+Below is a sample `insert_options` section that shows the recommended defaults:
 
 ```
 {
@@ -41,12 +41,15 @@ Below is a sample `insert_options` section that shows all the defaults:
       "enable": true
     },
     "governance": "enable",
-    "offchain_pool_data": "enable",
+    "offchain_pool_data": "disable",
+    "offchain_vote_data": "disable",
     "json_type": "text"
   }
 }
 ```
 
+**Note**: Starting from version 13.7.0.1, `offchain_pool_data` and `offchain_vote_data` default to `"disable"`. Enable them if you need offchain metadata fetching.
+
 # Properties
 
 `insert_options` may contain the following elements:
@@ -63,6 +66,7 @@ Below is a sample `insert_options` section that shows all the defaults:
 | [plutus](#plutus)                            | `object`   | Optional |
 | [governance](#governance)                    | `enum`     | Optional |
 | [offchain\_pool\_data](#offchain-pool-data)  | `enum`     | Optional |
+| [offchain\_vote\_data](#offchain-vote-data)  | `enum`     | Optional |
 | [pool\_stat](#pool-stat)                     | `enum`     | Optional |
 | [remove\_jsonb_from_schema](#remove-jsonb-from-schema) | `enum`     | Optional |
 | [stop\_at\_block](#stop-at-block)            | `integer`  | Optional |
@@ -113,7 +117,8 @@ This is equivalent to setting:
   "enable": false
 },
 "governance": "disable",
-"offchain_pool_data": "disable"
+"offchain_pool_data": "disable",
+"offchain_vote_data": "disable",
 "pool_stat": "disable"
 ```
 
@@ -142,7 +147,8 @@ This is equivalent to setting:
   "enable": false
 },
 "governance": "enable",
-"offchain_pool_data": "disable"
+"offchain_pool_data": "disable",
+"offchain_vote_data": "disable",
 "pool_stat": "enable"
 
 ```
@@ -170,7 +176,8 @@ This is equivalent to setting:
   "enable": false
 },
 "governance": "disable",
-"offchain_pool_data": "disable"
+"offchain_pool_data": "disable",
+"offchain_vote_data": "disable",
 "pool_stat": "disable"
 ```
 
@@ -532,9 +539,55 @@ This will effect all governance related data/functionality.
 
 | Value      | Explanation                               |
 | :--------- | :---------------------------------------- |
-| `"enable"` | Enables fetching offchain metadata.       |
+| `"enable"` | Enables fetching offchain pool metadata.  |
 | `"disable"`| Disables fetching pool offchain metadata. |
 
+Controls whether db-sync fetches offchain metadata for stake pools. This metadata includes pool descriptions, ticker symbols, homepages, and other information referenced in pool registrations.
+
+**Important**: Starting from version 13.7.0.1, this defaults to `"disable"`. Explicitly enable it if you need pool metadata.
+
+When enabled, db-sync fetches metadata from URLs stored on-chain with the following restrictions:
+- HTTPS URLs required (HTTP allowed only for localhost testing)
+- Private/internal IP addresses blocked (RFC1918, loopback, link-local, IPv6 ULA)
+- DNS resolution performed immediately before requests
+
+## Offchain Vote Data
+
+`offchain_vote_data`
+
+ * Type: `string`
+
+**enum**: The value of this property must be equal to one of the following values:
+
+| Value      | Explanation                                      |
+| :--------- | :----------------------------------------------- |
+| `"enable"` | Enables fetching offchain governance vote metadata. |
+| `"disable"`| Disables fetching governance vote metadata.      |
+
+Controls whether db-sync fetches offchain metadata for governance voting anchors, including:
+- DRep registrations (CIP-119)
+- Governance action proposals (CIP-108)
+- Vote anchors and references (CIP-100)
+
+This setting is independent of the `governance` flag, allowing granular control over general governance data versus offchain metadata fetching.
+
+**Important**: Starting from version 13.7.0.1, this defaults to `"disable"`. Explicitly enable it if you need governance vote metadata.
+
+When enabled, the same URL restrictions apply as `offchain_pool_data` (HTTPS required, private IPs blocked, immediate DNS resolution).
+
+### Example
+
+```json
+{
+  "insert_options": {
+    "governance": "enable",
+    "offchain_vote_data": "enable"
+  }
+}
+```
+
+**Migration Note**: Prior to version 13.7.0.1, governance vote metadata fetching was controlled by the `governance` flag.
+
 ## Pool Stat
 
 `pool_stat`