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	✔️

Cardano DB Sync 1.5.0

The Cardano DB Sync synchronises blockchain data into a relational database.

This release brings some changes in the database, a few improvements and fixes in cardano-db-sync service, and updates its three components to the latest state of their dependencies. cardano-db-sync docker image is available.

Compatible with Cardano node 1.11.0.

Deployed on the mainnet 1 May 2020.

New features

• Added cardano-db library API for query to determine if the DB is fully in sync (#36)
• Added a block count column to the epoch cache table (#42, #46, #51)
• Added an Epoch convenience VIEW to the DB schema (#31)
• Added support for multiple chains in a single database (#76, #77)

Improvements

• Added export of the generated DB schema as documentation (#43)
• Added index to the TransactionInput VIEW (#67)
• Updated dependencies to latest versions (#39, #55, #78)
• Improved README (#32, #38, #57, #58)
• Improved example docker config (#59)

Resolved issues

• Fixed a bug related to block rollback (#61)
• Fixed handling of OBFT epochs without transactions (#40)
• Some build instructions have been updated with new configuration file names (#32)

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	✔️

Cardano DB Sync 1.4.0

The Cardano DB Sync component (cardano-db-sync) synchronises chain data into a relational database.

Previously this component was released as part of the Cardano Explorer backend. In this release it has been renamed and moved into its own source repository, separate from the Explorer API.

It consists of the following components:

• cardano-db library (renamed from cardano-explorer-db)
• cardano-db-sync service (renamed from cardano-explorer-node)
• cardano-db-sync-extended service (a variation of cardano-db-sync used by cardano-graphql)

This release with updated library dependencies follows the release of Cardano Explorer 1.3.0.

Compatible with Cardano node 1.8.0.

Deployed on 23th March 2020.

New features

• Implemented a new plugin system to allow application-specific variations
• Added new component cardano-db-sync-extended to support SQL DB backend for cardano-graphql

Improvements

• Added extra "epoch" table with incrementally maintained view used by cardano-db-sync-extended
• Improved chain sync behaviour when database is ahead of node
• Used threaded RTS to avoid potential IPC problems on OSX
• Improved exception handling and reporting
• Improved default logging verbosity configuration
• Improved documentation

Resolved issues

• cardano-db-sync cannot connect to cardano-node (#9)
• Enable logging for production (#7)

Known Issues

• Some build instructions have not updated with new configuration file names (#32)

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	✔️