Cardano DB Sync 6.0.0

The main enhancement in this release is the ability to track the ledger state which enables a number of new features, some in this release and more in future releases. In particular this release adds the tracking of delegation rewards and protocol parameters.

It also includes improvements in handling of the Word64 types, and a few bug fixes. There are numerous changes in the database schema, including breaking changes. Documentation has been updated to reflect ledger state maintenance and other improvements.

As this release has breaking changes, the database has to be dropped and recreated if upgrading.

Deployed to the testnet 29 October 2020.

Compatible with Cardano Node 1.21.1.

Added

• Added maintenance of a copy of the ledger state which contains off chain data #300
• Added Reward table and populated from ledger state #305
• Added EpochParam table and populated for Shelley (but not Byron) #317
• Added EpochStake table and populated with data #319 #324
• Added stake_address_id column to the tx_out table #359
• Added the epoch nonce field to the EpochParam table #386
• Added Bech32 encodings of two more fields; changed type of block.vrf_key #295 #333
• Added --version option in CLI commands cardano-db-sync and cardano-db-sync-extended #350, #355

Changed

• Made handling of the Word64 types in the database more robust #334, #351, #335, #352
• Improved the way protocol version is stored in the database #368, #374
• Reorganised configuration: it now reads the node's configuration file #321, #308, #328, #329
• Documentation has been updated to reflect ledger state maintenance and other improvements #382, #367

Breaking changes ⚠️

• Numerous changes in the database schema
• Renamed config/pgpass to config/pgpass-mainnet
• Renamed ParamUpdate table to ParamProposal

Removed

• Removed registeredTxId uniqueness constraint on StakeAddress #332

Resolved

• Wrong reward_addr_id in the pool_update table #326, #332
• The reward and withdrawal tables have different addr_id for the same stake_address.view #327, #332
• Fixed uniqueness constraint for PoolRetire table #306 #315
• Fixed incorrect hash for SlotLeader #349, #356
• Fixed pool_id column in reward table #361, #364
• Fixed EpochNo column of EpochStake table #379, #381

Known issues

• Unhandled DCertGenesis certificate #290
• Epochs with no transactions list 0 blocks #296 (this does not occur in the mainnet)
• Git revision UNKNOWN when checking db-sync version #392

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops
Release Manager	✔️

Cardano DB Sync 5.0.3

This patch release provides a fix for the problem that DB synchronisation stopped due to violating the lovelace_check DB constraint. In this release, pool registration parameter values in the range 2^63..2^64-1 will be displayed as negative values. This infelicity will be resolved in the upcoming 6.0.x release.

Deployed to the testnet 22 October 2020.
Deployed to the mainnet 22 October 2020.

Compatible with Cardano Node 1.21.1.

Resolved

• Fix the handling of unsigned 64-bit integer fields in pool registration parameters #351 #345

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 5.0.2

This patch release provides a fix for handling of unsigned 64-bit integer fields and resolves a problem with parsing field pledge from table pool_update.

Deployed to the testnet 12 October 2020.
Deployed to the mainnet 13 October 2020.

Compatible with Cardano Node 1.21.1.

Resolved

• #334 Fixed handling of unsigned 64-bit integer fields #335

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 5.0.1

This patch release provides a workaround for a Unicode NUL character issue.

Deployed to mainnet 23 September 2020.

Compatible with Cardano Node 1.19.1 and with Cardano Node 1.20.0.

Resolved

• #297 Reject TxMetadata objects containing NUL characters #298

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 5.0.0

This release provides schema changes, validation additions and bug fixes. The database schema changes include new fees and registeredTxId data, breaking changes in column names of ParamUpdate table, removal of redundant indexes. It also has documentation improvements.

As this release has breaking changes, the database has to be dropped and recreated for the upgrade.

Compatible with Cardano Node 1.19.1.

Added

• Added a fees column to the Epoch table (#275)
• Added a registeredTxId column to PoolOwner table (#281)
• Resurrected the cardano-db-tool validate functionality (#268)

Changed

• Added validation that all pools have owners in db-tool (#262)
• Updated interesting-queries.md : removed old queries, fixed existed relevant ones, and added an example query for transaction inputs and outputs (#273)

Breaking changes ⚠️

• Renamed, corrected and clarified column names in ParamUpdate table: active_slot_coeff is replaced by decentralisation, and n_optimal is replaced with optimal_pool_count (#264)
• Removed redundant indices from schema (#261)

Removed

• Dropped support for non-HFC protocols. Specifically, dropped support for pure Byron and pure Shelley networks (#284)

Resolved

• Corrected uniqueness constraint on PoolOwner table (#251)
• Fixed calculation of deposit field of Tx table and accounting (#249, #266, #265, #267)

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Cardano DB Sync 4.0.0

This release provides improvements and bug fixes. The database schema additions include transaction metadata, certificate index within a transaction, raw hexadecimal transaction address, raw stake address. The update fixes delegation and pool_retire references, stake deregistration, stake ordering, epoch start and end times data.

This release has a breaking change, and requires the database to be dropped and recreated.

Compatible with Cardano Node 1.18.0.

Released as a library (not deployed to any environment).

Added

• Added and populated tx_metadata table (#229)
• Added index within the transaction for all transaction certificates (#230)
• Added raw address to tx_out table; the raw address that is stored along the rendered version of address (#223)

Breaking change ⚠️

• Added raw address in stake_address table; the raw address is stored as well as the rendered version, and stake_address.hash is renamed to stake_address.hash_raw (#224)

Resolved

• Moved stake deregistrations into a correct table instead of the registration table (#234)
• Fixed certificate ordering issues that resulted in an abort if a MIR certificate was found whose output was a stake address that was inserted later in the same transaction (#237)
• Corrected stake_address registration handling on rollbacks (#238)
• Fixed epoch start and end times in epoch table (#242)
• Made delegation and pool_retire tables reference pool_hash table instead of pool_update (#245)

Known issues

• Missing PoolOwner for some pools (#251)

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Cardano DB Sync 3.1.0

This minor release adds incremental additional functionality to support the GraphQL component, wallet implementations based on the DB Sync, and to cover more parts of the Shelley chain data.

This release requires the database to be dropped and recreated.

Compatible with Cardano Node 1.18.0.

Deployed on the mainnet 28 July 2020.

Added

• payment_cred column to the tx_out table for the benefit of wallet implementations (#208)
• slot_in_epoch column to the block table. Slot numbers become more complicated to calculate once there are multiple eras with different slot lengths, so we now store it instead (#214)
• Support for storing the on-chain parameter update proposals (#217)

Improved

• MIR certs now go into their own table(s) rather than the reward table (#218)

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 3.0.0

This update provides support for Shelley era, Cardano mode of Cardano node, and transition from Byron era to Shelley era. It also includes a few improvements in column types and outputs.

This release requires the database to be dropped and recreated.

Compatible with Cardano Node 1.18.0.

Added

• Added support for the cardano-node in Cardano mode (#186, #188, #196)
• Added Shelley schema elements (#173)

Improved

• Made changes in Shelley schema (#173, #174, #199)
• Improved to support Word64 column types (#203)
• Fixed implementation to support very large values of per-epoch aggregate table column outputs (#201)

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 2.1.0

This update provides initial support of Byron-to-Shelley blockchain transition state, and includes improvements and fixes for the update of Epoc table, rollback handling logic, and Docker image maintenance. This release requires the database to be dropped and recreated.

Compatible with Cardano Node 1.14.2.

Deployed on the mainnet 3 July 2020.

Improved

• The database schema has been adjusted to accept the superset of Byron and Shelley era information (#113)
• Last hard coded values for slots per epoch have been removed (#162)
• Docker build has been improved to use the latest release of cardano-node and cardano-db-sync; implemented log rotation (#152)

Resolved

• Fixed the update of Epoch table (#164)
• Fixed and improved the rollback handling logic (#130, #131)

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit
• Docker

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano DB Sync 2.0.0

This small update brings schema changes including removal of SQL views and addition of a block index. This release requires the database to be dropped and recreated. The docker image is available on DockerHub.

Added

• Added a column to the Tx table to record the order of transactions within a block (#94)

Removed

• Removed SQL views required by Cardano GraphQL (#92)

Improved

• Flattened the DB schema migrations

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
Validation
The Plug-in System

Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️