Cardano DB Sync 10.0.1

This release is the same as DB Sync 10.0.0 with the addition of a fix for this docker issue #686

⚠️ This release is only suitable for testing Alonzo era compatibility due to known problems with rewards.

Documentation

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

Known issues

• Unhandled DCertGenesis certificate #290
• Missing staking rewards #683
• Missing reward for address #696

Platforms

• Linux 64-bit
• Docker

Sign off

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

Cardano DB Sync 10.0.0

This release introduces the functionality to restore the db-sync state from a snapshot file, which is a more efficient method for syncing (~20x faster). The state snapshot files can be found here:

File	Testnet	Mainnet
snapshot	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/db-sync-snapshot-schema-10-block-2731927-x86_64.tgz	https://update-cardano-mainnet.iohk.io/cardano-db-sync/db-sync-snapshot-schema-10-block-5915608-x86_64.tgz
shasum	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/db-sync-snapshot-schema-10-block-2731927-x86_64.tgz.sha256sum	https://update-cardano-mainnet.iohk.io/cardano-db-sync/db-sync-snapshot-schema-10-block-5915608-x86_64.tgz.sha256sum
signature	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/db-sync-snapshot-schema-10-block-2731927-x86_64.tgz.asc	https://update-cardano-mainnet.iohk.io/cardano-db-sync/db-sync-snapshot-schema-10-block-5915608-x86_64.tgz.asc

Documentation for restoring from these files available at state-snapshot.md.

Note that this release requires the database to be dropped and recreated.
Requires ghc-8.10.x to build.

Compatible with Cardano Node 1.27.0.

Added

• Interleave bulk insertion (epoch_stake, reward and orphaned_reward) with regular insertions.
• Fetch and insert pool offline metadata.
• Add EpochSyncTime table (#621).
• Add helper functionality for state snapshot generation (#617).

Improved

• Documentation updates.
• Update utxo_view query (#543).
• Minor update of database schema.
• Refactor/improve rollbacks (#570).
• Update a couple of uniqueness constraints.
• Update system requirements in Readme.hd.
• Update doc/interesting-queries.md file with a new statistics query.

Removed

• Remove merkle_root field from block table.

Resolved

• Fix network id for reward_addr in pool_update table (#546).
• Fix PoolUpdate activeEpochNo field (#610).
• Fix incorrect "Starting epoch N" message (#627).

Known issues

• Unhandled DCertGenesis certificate #290
• Missing staking rewards #683

Documentation

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

Platforms

• Linux 64-bit
• Docker

Sign off

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

Cardano DB Sync 9.0.0

This release requires the database to be dropped and recreated.
Requires ghc-8.10.x to build.

Compatible with Cardano Node 1.25.1.

Added

• Add slot_no column to delegation table to simplify a query used when populating the database.
• Add static (musl64) linux builds.
• Add and populate ada_pots table.

Improved

• Documentation updates.

Resolved

• Fix network id for reward_addr in pool_update table #546

Known issues

• Unhandled DCertGenesis certificate #290

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 8.0.0

This release is expected to be the final version before the Mary hard fork. It requires Cardano Node 1.25.1 or later. In addition to support for the Mary hard fork, there are notable improvements to robustness.

This release requires the database to be dropped and recreated.

Added

• Split the ledger state rewards into valid and invalid sets (#415, #467).
• Handle case where latest ledger state file cannot be parsed (#483).
• Make the port that the Prometheus metrics server listens on configurable (#488).
• Documentation updates.
• Update dependencies.

Improved

• Vastly improve database rollback performance (#256, #397).
• Improve logging.
• Improve handling/naming of ledger state files.

Resolved

• Fix tx_count for genesis blocks (#471).
• Fix typo in database column name (Merkel -> Merkle) (#446).
• Fix Prometheus metrics server (#154).

Known issues

• Unhandled DCertGenesis certificate #290
• Epochs with no transactions list 0 blocks #296 (this does not occur in the mainnet)

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 7.1.0

Introduced support for the token locking and native tokens eras

Upgrading from 7.0.x will not require the database to be dropped and recreated but upgrading from 6.0.x and earlier will require it.

Compatible with Cardano Node 1.24.2.

Added

• Support for the token locking era (ie support for time locking of transactions).
• Support for the native tokens era (ie multi-asset support).
• Log an error if excessive rollback is required on startup. It is up to the operator to drop the database and restart.

Resolved

• Fix issues with transactions invalidBefore/invalidHereafter fields.

Known issues

• Error might occur if db-sync and node are started at the same time, please try again #434
• Unhandled DCertGenesis certificate #290
• Epochs with no transactions list 0 blocks #296 (this does not occur in the mainnet)

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 6.0.1

There are no database changes relative to 6.0.0 so the database will be compatible with 6.0.0.

Added

• Log an error if excessive rollback is required on startup. It is up to the operator to drop the database and restart.

Resolved

• Add hash checking when maintaining ledger state and fix race condition (#398)

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

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

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