Cardano DB Sync 12.0.0

This release is compatible with Cardano Node 1.31.0.

⚠️ Note that this release requires the database to be dropped and recreated.

The state snapshot files for this release can be found here:

Network	Link to snapshot
Testnet	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/index.html#12/
Mainnet	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#12/

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

Requires ghc-8.10.x to build.

Added

• Include json and (raw) bytes fields to script table.
• Add cost_model, datum and redeemer tables.
• Add a multi_asset table with policy, name and asset fingerprint columns (#868).
• Ported SMASH version (its documentation), which is a standalone SMASH ported to DB sync 12, under trial-run and production monitoring to verify performance. Therefore, SMASH users are advised to stay on their current standalone version and NOT update to this ported SMASH version. Updates on the ported version will follow in the following DB sync releases.

Improved

• Update rewardtype enum (used in reward table) to include a pool deposit refund type.
• Update cost_model* fields of param_proposal and epoch_param tables to reference cost_model
  table.
• Unify SQL types of epoch_stake.epoch_no and epoch.no (#811).
• Handle the empty list case in insertManyUncheckedUnique (#869).
• Update system requirements (#951).

Removed

• Drop the policy and name columns of ma_tx_mint and ma_tx_out tables, replacing those
  columns with a reference to the multi_asset table.
• Stop supporting test configs which don't initiate Shelley properly.

Resolved

• Fix handling of transactions which have contracts which fail second stage validation (#883).
• Fix missing and inconsistent rewards issues (#791, #796, #805. #882, #826, #918, #921, #923, #939,
  #947).
• Fix the git SHA hash in the version subcommand (#844).

Documentation

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

Platforms

• Linux 64-bit
• Docker

Sign off

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

Cardano DB Sync 11.0.4

This release is compatible with Cardano Node 1.30.1.

⚠️ This release has known problems with rewards (see the known issues section). Work is continuing to deliver a fix for this issue as soon as possible.

The state snapshot files for this release can be found here:

Network	Link to snapshot
Testnet	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/index.html#11/
Mainnet	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#11/

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

Requires ghc-8.10.x to build.

Resolved

• Fix race condition on insertion of pool offline data or error response (#806, #823, #858).

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 11.0.3

This release is compatible with Cardano Node 1.30.1.

⚠️ This release has known problems with rewards (see the known issues section). Work is continuing to deliver a fix for this issue as soon as possible.

The state snapshot files for this release can be found here:

Network	Link to snapshot
Testnet	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/index.html#11/
Mainnet	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#11/

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

Requires ghc-8.10.x to build.

Updated

• Use same dependencies as 1.30.1 of cardano-node.

Resolved

• Fix docker issue (#810).
• Fix schema documentation typo (#799).
• Fix db-sync makes a rollback after using RESTORE_SNAPSHOT (#784)

Known issues

• Race condition on insertion of pool offline data or error response #806, #823, #831.
• 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 11.0.0

This release introduces support for Alonzo.
It is compatible with Cardano Node 1.29.0.
Note that this release requires the database to be dropped and recreated.

⚠️ This release has known problems with rewards (see the known issues section). Work is continuing to deliver a fix for this issue as soon as possible.

The state snapshot files for this release can be found here:

Network	Link to snapshot
Testnet	https://updates-cardano-testnet.s3.amazonaws.com/cardano-db-sync/index.html#11/
Mainnet	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#11/

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

Requires ghc-8.10.x to build.

Added

• Introduces Alonzo support.
• Database changes as per cardano-db changelog.
• Add run time validation that the on-disk schema matches what the app expects (#472).
• Add partial validation of Reward table.
• Add Alonzo (smart contracts) related Redeemer and Script tables.
• Add an epochNo columm to StakeRegistration/Deregistration tables.
• Add instantaneous rewards to the Reward table. This adds two new reward sources (treasury and reserves to the existing leader and member types) and makes the poolId NULLable (treasury and reserves rewards are not associated with a pool).
• For the EpochSyncTime table change the seconds column from double to Word64 and make it non-NULLable.
• For the Reward table, drop the epochNo column and relace it with earnedEpoch and spendableEpoch
• Add opCertCounter column to Block table.
• Add dataHash field to the TxOut table.
• Add a validation to ensure the sum of the AdaPots values per epoch is a constant (#718). - cardano-db-tool
• Add reporting functionalities (balance, teansactions, reward history, latest rewards). - cardano-db-tool

Improved

• Extend ProtocolParams and EpochParams tables for Alonzo.

Removed

• Drop OrphanedRewrd table (because it was incomplete can cannot be fixed).

Resolved

• Fix utxo_view defined in schema (#744).

Known issues

• Unhandled DCertGenesis certificate #290
• Missing staking rewards #683
• db-sync makes a rollback after using RESTORE_SNAPSHOT #784
  • Please use the below workaround for this issue:
    Modify docker-compose‧yml to add the following elements:

services:
  cardano-db-sync:
    working_dir: /var/lib/cdbsync
    volumes:
      - db-sync-tmp:/tmp

volumes:
  db-sync-tmp:

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