Add versioning to ledger tables

Author: jasagredo

ouroboros-consensus-cardano/app/snapshot-converter.hs

@@ -287,7 +287,7 @@ main = withStdTerminalHandles $ do
         let crcOut = maybe inCRC (crcOfConcat inCRC) mCRCOut
 
         lift $ putStr "Generating new metadata file..." >> hFlush stdout
-        putMetadata outFilePath (SnapshotMetadata outBackend crcOut)
+        putMetadata outFilePath (SnapshotMetadata outBackend crcOut TablesCodecVersion1)
 
         lift $ putColored Green True "Done"
 

ouroboros-consensus/changelog.d/20250904_155944_javier.sagredo_version_tables.md

@@ -0,0 +1,23 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+For top level release notes, leave all the headers commented out.
+-->
+
+<!--
+### Patch
+
+- A bullet item for the Patch category.
+
+-->
+<!--
+### Non-Breaking
+
+- A bullet item for the Non-Breaking category.
+
+-->
+
+### Breaking
+
+- Version the ledger tables in snapshots. For now only the 'TablesCodecVersion1' exists. Snapshots without a version will be regarded as invalid, thus triggering a replay of the chain.

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/Snapshots.hs

@@ -28,6 +28,7 @@ module Ouroboros.Consensus.Storage.LedgerDB.Snapshots
   , SnapshotFailure (..)
   , SnapshotMetadata (..)
   , SnapshotPolicyArgs (..)
+  , TablesCodecVersion (..)
   , defaultSnapshotPolicyArgs
 
     -- * Codec
@@ -82,6 +83,7 @@ import Control.Monad.Except
 import Control.Tracer
 import Data.Aeson (FromJSON (..), ToJSON (..), (.:), (.=))
 import qualified Data.Aeson as Aeson
+import Data.Aeson.Types (Parser)
 import Data.Functor.Identity
 import qualified Data.List as List
 import Data.Maybe (isJust, mapMaybe)
@@ -162,9 +164,24 @@ data ReadSnapshotErr
     ReadMetadataError FsPath MetadataErr
   deriving (Eq, Show)
 
+data TablesCodecVersion = TablesCodecVersion1
+  deriving (Eq, Show)
+
+instance ToJSON TablesCodecVersion where
+  toJSON TablesCodecVersion1 = Aeson.Number 1
+
+instance FromJSON TablesCodecVersion where
+  parseJSON v = enforceVersion =<< parseJSON v
+
+enforceVersion :: Word8 -> Parser TablesCodecVersion
+enforceVersion v = case v of
+  1 -> pure TablesCodecVersion1
+  _ -> fail "Unknown or outdated tables codec version"
+
 data SnapshotMetadata = SnapshotMetadata
   { snapshotBackend :: SnapshotBackend
   , snapshotChecksum :: CRC
+  , snapshotTablesCodecVersion :: TablesCodecVersion
   }
   deriving (Eq, Show)
 
@@ -173,13 +190,15 @@ instance ToJSON SnapshotMetadata where
     Aeson.object
       [ "backend" .= snapshotBackend sm
       , "checksum" .= getCRC (snapshotChecksum sm)
+      , "tablesCodecVersion" .= toJSON (snapshotTablesCodecVersion sm)
       ]
 
 instance FromJSON SnapshotMetadata where
   parseJSON = Aeson.withObject "SnapshotMetadata" $ \o ->
     SnapshotMetadata
       <$> o .: "backend"
       <*> fmap CRC (o .: "checksum")
+      <*> (parseJSON =<< (o .: "tablesCodecVersion"))
 
 data SnapshotBackend
   = UTxOHDMemSnapshot

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V1/Snapshots.hs

@@ -260,6 +260,7 @@ writeSnapshot fs@(SomeHasFS hasFS) backingStore encLedger snapshot cs = do
     SnapshotMetadata
       { snapshotBackend = bsSnapshotBackend backingStore
       , snapshotChecksum = crc
+      , snapshotTablesCodecVersion = TablesCodecVersion1
       }
   bsCopy
     backingStore

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V2/InMemory.hs

@@ -204,6 +204,7 @@ writeSnapshot fs@(SomeHasFS hasFs) encLedger ds st = do
     SnapshotMetadata
       { snapshotBackend = UTxOHDMemSnapshot
       , snapshotChecksum = maybe crc1 (crcOfConcat crc1) crc2
+      , snapshotTablesCodecVersion = TablesCodecVersion1
       }
 
 implTakeSnapshot ::

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/Storage/LedgerDB/V2/LSM.hs

@@ -418,6 +418,7 @@ writeSnapshot fs@(SomeHasFS hasFs) encLedger ds st = do
     SnapshotMetadata
       { snapshotBackend = UTxOHDLSMSnapshot
       , snapshotChecksum = maybe crc1 (crcOfConcat crc1) crc2
+      , snapshotTablesCodecVersion = TablesCodecVersion1
       }
 
 -- | Delete snapshot from disk and also from the LSM tree database.

ouroboros-consensus/test/storage-test/Test/Ouroboros/Storage/LedgerDB/Snapshots.hs

@@ -35,3 +35,4 @@ instance Arbitrary SnapshotMetadata where
     SnapshotMetadata
       <$> arbitrary
       <*> fmap CRC arbitrary
+      <*> pure TablesCodecVersion1