Prepare Release 13.2.0.1

IntersectMBO · Feb 14, 2024 · ed3dc8b · ed3dc8b
1 parent 04fee38
commit ed3dc8b
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 18 deletions.
diff --git a/cardano-chain-gen/cardano-chain-gen.cabal b/cardano-chain-gen/cardano-chain-gen.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-chain-gen
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               A fake chain generator for testing cardano DB sync.
 description:            A fake chain generator for testing cardano DB sync.
 homepage:               https://github.com/IntersectMBO/cardano-db-sync

diff --git a/cardano-db-sync/CHANGELOG.md b/cardano-db-sync/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Revision history for cardano-db-sync
 
-## 13.2.0.0
+## 13.2.0.1
 * Added a new table `epoch_stake_progress` which indicates when `epoch_stake` is completed
 * Uses the cache for the computation of `epoch` table when following
 * `epoch_stake` is now computed earlier, before the epoch is reached
@@ -20,6 +20,7 @@
 * Partial Conway integration. You can read more in `doc/schema.md` (tagged as Conway). Also in files
 `schema/cardano-chain-gen/schema/migration-2-0032-20230815.sql` and `schema/cardano-chain-gen/schema/migration-2-0032-20230815.sql`
 for the raw sql migrations.
+* Removed `reward.id` field. `instant_reward` table also doesn't have an id field.
 
 ## 13.1.1.3
 * Adds compatibility with node-8.0.0 [#1403] and node-8.1.1 [#1455]

diff --git a/cardano-db-sync/cardano-db-sync.cabal b/cardano-db-sync/cardano-db-sync.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-db-sync
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               The Cardano DB Sync node
 description:            A Cardano node that follows the Cardano chain and inserts data from the
                         chain into a PostgresQL database.

diff --git a/cardano-db-tool/cardano-db-tool.cabal b/cardano-db-tool/cardano-db-tool.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-db-tool
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               Utilities to manage the cardano-db-sync databases.
 description:            Utilities and executable, used to manage and validate the
                         PostgreSQL db and the ledger database of the cardano-db-sync node

diff --git a/cardano-db/cardano-db.cabal b/cardano-db/cardano-db.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-db
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               A base PostgreSQL component for the cardano-db-sync node.
 description:            Code for the Cardano DB Sync node that is shared between the
                         cardano-db-node and other components.

diff --git a/cardano-db/src/Cardano/Db/Schema.hs b/cardano-db/src/Cardano/Db/Schema.hs
@@ -916,7 +916,7 @@ schemaDocs =
       \ since the other 2 types have moved to a separate table instant_reward.\
       \ The rewards are inserted incrementally and\
       \ this procedure is finalised when the spendable epoch comes. Before the epoch comes, some entries\
-      \ may be missing."
+      \ may be missing. The `reward.id` field has been removed and it only appears on docs due to a bug."
       RewardAddrId # "The StakeAddress table index for the stake address that earned the reward."
       RewardType # "The type of the rewards"
       RewardAmount # "The reward amount (in Lovelace)."
@@ -931,6 +931,7 @@ schemaDocs =
     InstantReward --^ do
       "A table for earned instant rewards. It includes only 2 types of rewards: reserves and treasury.\
       \ This table only exists for historic reasons, since instant rewards are depredated after Conway.\
+      \ The `reward.id` field has been removed and it only appears on docs due to a bug.\
       \ New in 13.2"
       InstantRewardAddrId # "The StakeAddress table index for the stake address that earned the reward."
       InstantRewardType # "The type of the rewards."

diff --git a/cardano-db/test/cardano-db-test.cabal b/cardano-db/test/cardano-db-test.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-db-test
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               Tests for the base functionality of the cardano-db library
 description:            Code for the Cardano DB Sync node that is shared between the
                         cardano-db-node and other components.

diff --git a/cardano-smash-server/cardano-smash-server.cabal b/cardano-smash-server/cardano-smash-server.cabal
@@ -1,7 +1,7 @@
 cabal-version:          3.0
 
 name:                   cardano-smash-server
-version:                13.2.0.0
+version:                13.2.0.1
 synopsis:               The Cardano smash server
 description:            Please see the README on GitHub at
                         <https://github.com/IntersectMBO/cardano-db-sync/cardano-smash-server/#readme>

diff --git a/doc/migrations.md b/doc/migrations.md
@@ -8,7 +8,7 @@ This is `a.b.c.d`. where
 different values.
 - `d`: no semantic change to the db.
 
-## Upgrading to 13.2.0.0
+## Upgrading to 13.2.0.x
 
 In order to upgrade from 13.1.x.x to 13.2.0.x resyncing is not necessary and no special
 flags are required from the user. DBSync will automatically perform the new migrations under `schema`
@@ -21,7 +21,7 @@ Upgrading from 13.0.x to 13.2.0.x should be possible but hasn't been tested.
 
 ### Ledger replay
 
-Release 13.2.0.0 drops the ledger snaphot serialisation compatibility. This means it's not able to
+Release 13.2.0.1 drops the ledger snaphot serialisation compatibility. This means it's not able to
 parse older ledger snapshots. DBSync will delete any existing snapshot and will replay the ledger
 rules from genesis. This doesn't mean a rollback to genesis. No db data are deleted.
 

diff --git a/doc/schema.md b/doc/schema.md
@@ -1,8 +1,6 @@
-Resolving dependencies...
-Up to date
 # Schema Documentation for cardano-db-sync
 
-Schema version: 13.2.0.0 (from branch **kderme/optimizations** which may not accurately reflect the version number)
+Schema version: 13.2.0.1
 **Note:** This file is auto-generated from the documentation in cardano-db/src/Cardano/Db/Schema.hs by the command `cabal run -- gen-schema-docs doc/schema.md`. This document should only be updated during the release process and updated on the release branch.
 
 ### `schema_version`
@@ -383,7 +381,7 @@ A table for metadata attached to a transaction.
 
 ### `reward`
 
-A table for earned staking rewards. After 13.2 release it includes only 3 types of rewards: member, leader and refund,  since the other 2 types have moved to a separate table instant_reward. The rewards are inserted incrementally and this procedure is finalised when the spendable epoch comes. Before the epoch comes, some entries may be missing.
+A table for earned staking rewards. After 13.2 release it includes only 3 types of rewards: member, leader and refund,  since the other 2 types have moved to a separate table instant_reward. The rewards are inserted incrementally and this procedure is finalised when the spendable epoch comes. Before the epoch comes, some entries may be missing. The `reward.id` field has been removed and it only appears on docs due to a bug.
 
 * Primary Id: `id`
 
@@ -399,7 +397,7 @@ A table for earned staking rewards. After 13.2 release it includes only 3 types
 
 ### `instant_reward`
 
-A table for earned instant rewards. It includes only 2 types of rewards: reserves and treasury. This table only exists for historic reasons, since instant rewards are depredated after Conway. New in 13.2
+A table for earned instant rewards. It includes only 2 types of rewards: reserves and treasury. This table only exists for historic reasons, since instant rewards are depredated after Conway. The `reward.id` field has been removed and it only appears on docs due to a bug. New in 13.2
 
 * Primary Id: `id`
 
@@ -442,13 +440,15 @@ A table containing the epoch stake distribution for each epoch. This is inserted
 
 ### `epoch_stake_progress`
 
+A table which shows when the epoch_stake for an epoch is complete
+
 * Primary Id: `id`
 
 | Column name | Type | Description |
 |-|-|-|
 | `id` | integer (64) |  |
-| `epoch_no` | word31type |  |
-| `completed` | boolean |  |
+| `epoch_no` | word31type | The related epoch |
+| `completed` | boolean | True if completed. If not completed the entry won't exist or more rarely be False. |
 
 ### `treasury`
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -53,7 +53,7 @@ services:
         max-file: "10"
 
   cardano-db-sync:
-    image: ghcr.io/intersectmbo/cardano-db-sync:13.2.0.0
+    image: ghcr.io/intersectmbo/cardano-db-sync:13.2.0.1
     environment:
       - DISABLE_LEDGER=${DISABLE_LEDGER}
       - NETWORK=${NETWORK:-mainnet}