Prepare Release 13.2.0.0

Author: kderme

config/mainnet-config.yaml

@@ -12,7 +12,7 @@ EnableLogging: True
 # config, it will likely lead to db-sync throwing up weird error messages from
 # the consensus layer.
 # The path to the node config file is relative to this config file.
-NodeConfigFile: /nix/store/33r8vqnrlhbpk6vifd1hphphg8v6fc89-config-0-0.json
+NodeConfigFile: /nix/store/8lnh50vcc13zq5av67sakyj23ybgssnh-config-0-0.json
 
 # ------------------------------------------------------------------------------
 # Logging configuration follows.

doc/migrations.md

@@ -8,6 +8,23 @@ This is `a.b.c.d`. where
 different values.
 - `d`: no semantic change to the db.
 
+## Upgrading to 13.2.0.0
+
+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`
+directory. Details about these migrations can be found in the release `Changelog.md`, in the `schema.md`
+annotated as `13.2` or in the schema files directly. New stage 1 files starts from 1-10 and stage 2 starts from 2-26.
+These migrations takes a couple minutes, mosty because the instant rewards are moved from the `reward` table to a
+new `instant_reward` table. After that there is a ledger replay (read below), which takes a few hours.
+
+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
+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.
+
 ## Upgrading to 13.1.1.x
 
 In order to upgrade from 13.0.x or 13.1.0.x to 13.1.1.x resyncing is not necessary and no special

doc/schema.md

@@ -1,6 +1,8 @@
+Resolving dependencies...
+Up to date
 # Schema Documentation for cardano-db-sync
 
-Schema version: 13.2.0.0 (from branch **kderme/sancho-3-0-0** which may not accurately reflect the version number)
+Schema version: 13.2.0.0 (from branch **kderme/optimizations** which may not accurately reflect the version number)
 **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`
@@ -124,7 +126,6 @@ A table for transaction outputs.
 | `tx_id` | integer (64) | The Tx table index of the transaction that contains this transaction output. |
 | `index` | txindex | The index of this transaction output with the transaction. |
 | `address` | string | The human readable encoding of the output address. Will be Base58 for Byron era addresses and Bech32 for Shelley era. |
-| `address_raw` | blob | The raw binary address. |
 | `address_has_script` | boolean | Flag which shows if this address is locked by a script. |
 | `payment_cred` | hash28type | The payment credential part of the Shelley address. (NULL for Byron addresses). For a script-locked address, this is the script hash. |
 | `stake_address_id` | integer (64) | The StakeAddress table index for the stake address part of the Shelley address. (NULL for Byron addresses). |
@@ -145,7 +146,6 @@ A table for transaction collateral outputs. New in v13.
 | `tx_id` | integer (64) | The Tx table index of the transaction that contains this transaction output. |
 | `index` | txindex | The index of this transaction output with the transaction. |
 | `address` | string | The human readable encoding of the output address. Will be Base58 for Byron era addresses and Bech32 for Shelley era. |
-| `address_raw` | blob | The raw binary address. |
 | `address_has_script` | boolean | Flag which shows if this address is locked by a script. |
 | `payment_cred` | hash28type | The payment credential part of the Shelley address. (NULL for Byron addresses). For a script-locked address, this is the script hash. |
 | `stake_address_id` | integer (64) | The StakeAddress table index for the stake address part of the Shelley address. (NULL for Byron addresses). |
@@ -383,19 +383,34 @@ A table for metadata attached to a transaction.
 
 ### `reward`
 
-A table for earned rewards. It includes 5 types of rewards. 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.
 
 * Primary Id: `id`
 
 | Column name | Type | Description |
 |-|-|-|
 | `id` | integer (64) |  |
 | `addr_id` | integer (64) | The StakeAddress table index for the stake address that earned the reward. |
-| `type` | rewardtype | The source of the rewards; pool `member`, pool `leader`, `treasury` or `reserves` payment and pool deposits `refunds` |
+| `type` | rewardtype | The type of the rewards |
 | `amount` | lovelace | The reward amount (in Lovelace). |
-| `earned_epoch` | integer (64) | The epoch in which the reward was earned. For `pool` and `leader` rewards spendable in epoch `N`, this will be `N - 2`, for `treasury` and `reserves` `N - 1` and for `refund` N. |
+| `earned_epoch` | integer (64) | The epoch in which the reward was earned. For `pool` and `leader` rewards spendable in epoch `N`, this will be `N - 2`, `refund` N. |
+| `spendable_epoch` | integer (64) | The epoch in which the reward is actually distributed and can be spent. |
+| `pool_id` | integer (64) | The PoolHash table index for the pool the stake address was delegated to when the reward is earned or for the pool that there is a deposit refund. |
+
+### `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
+
+* Primary Id: `id`
+
+| Column name | Type | Description |
+|-|-|-|
+| `id` | integer (64) |  |
+| `addr_id` | integer (64) | The StakeAddress table index for the stake address that earned the reward. |
+| `type` | rewardtype | The type of the rewards. |
+| `amount` | lovelace | The reward amount (in Lovelace). |
+| `earned_epoch` | integer (64) | The epoch in which the reward was earned. For rewards spendable in epoch `N`, this will be `N - 1`. |
 | `spendable_epoch` | integer (64) | The epoch in which the reward is actually distributed and can be spent. |
-| `pool_id` | integer (64) | The PoolHash table index for the pool the stake address was delegated to when the reward is earned or for the pool that there is a deposit refund. Will be NULL for payments from the treasury or the reserves. |
 
 ### `withdrawal`
 
@@ -790,8 +805,8 @@ A table for every committee hot key registration. New in 13.2-Conway.
 | `id` | integer (64) |  |
 | `tx_id` | integer (64) | The Tx table index of the tx that includes this certificate. |
 | `cert_index` | integer (32) | The index of this registration within the certificates of this transaction. |
-| `cold_key` | bytea | The registered cold hey hash. TODO: should this reference DrepHashId or some separate hash table? |
-| `hot_key` | bytea | The registered hot hey hash |
+| `cold_key` | hash28type | The registered cold hey hash. TODO: should this reference DrepHashId or some separate hash table? |
+| `hot_key` | hash28type | The registered hot hey hash |
 
 ### `committee_de_registration`
 
@@ -804,7 +819,7 @@ A table for every committee key de-registration. New in 13.2-Conway.
 | `id` | integer (64) |  |
 | `tx_id` | integer (64) | The Tx table index of the tx that includes this certificate. |
 | `cert_index` | integer (32) | The index of this deregistration within the certificates of this transaction. |
-| `cold_key` | bytea | The deregistered cold key hash |
+| `cold_key` | hash28type | The deregistered cold key hash |
 | `voting_anchor_id` | integer (64) | The Voting anchor reference id |
 
 ### `drep_registration`
@@ -882,7 +897,7 @@ A table for new committee proposed on a GovActionProposal. New in 13.2-Conway.
 |-|-|-|
 | `id` | integer (64) |  |
 | `gov_action_proposal_id` | integer (64) | The GovActionProposal table index for this new committee. |
-| `quorum_nominator` | integer (64) | The proposed quorum nominator. |
+| `quorum_numerator` | integer (64) | The proposed quorum nominator. |
 | `quorum_denominator` | integer (64) | The proposed quorum denominator. |
 | `deleted_members` | string | The removed members of the committee. This is now given in a text as a description, but may change. TODO: Conway. |
 | `added_members` | string | The new members of the committee. This is now given in a text as a description, but may change. TODO: Conway. |