Cardano DB Sync 13.5.0.2

This release fixes an issue with restarts, similar to node version 9.1.1. It is compatible with node version 9.1.1.

It is recommended that all users upgrade to db-sync version 13.5.0.2 when restarting their db-sync instance. It is also recommended to delete all ledger snapshots before upgrading.

The release also fixes an issue with flag --disable-cache not working properly and makes replaying from genesis faster, since it reduces redundant snapshots.

Upgrading

Upgrading from any 13.4.x.x or 13.5.x.x db-sync instance requires a ledger state replay from genesis. This doesn't affect the database. This is the final release that will support upgrading from pre-HF 13.x versions.

The release is compatible with 13.5, 13.4, 13.2 and 13.1 snapshots. They can be found at:

Network	Link to snapshot
Mainnet-13.5	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/
Mainnet-13.4	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/
Mainnet-13.1	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Postgres setup

It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Notes

When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md

Platforms

• Linux 64-bit
• Docker
  Requires ghc-8.10.x to build.

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product	🟢
Test Engineer	🟢
Site Reliability Engineer	🟢

Cardano DB Sync 13.5.0.1

This release fixes an issue with restarts, similar to node version 9.1.1 fixes. It is compatible with 9.1.1.
It also fixes an issue with flag --disable-cache not working properly.

It is recommended that all users upgrade to db-sync version 13.5.0.1 when restarting their db-sync instance.

Upgrading

Upgrading from any 13.4.x.x 13.5.x.x release happens instantly.
Upgrading from other 13.x.x.x releases is also possible. A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.

The release is compatible with 13.5, 13.4, 13.2 and 13.1 snapshots. They can be found at:

Network	Link to snapshot
Mainnet-13.5	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/
Mainnet-13.4	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/
Mainnet-13.1	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Postgres setup

It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Notes

When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md

Platforms

• Linux 64-bit
• Docker
  Requires ghc-8.10.x to build.

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product
Test Engineer	🟢
Site Reliability Engineer

Cardano DB Sync 13.5.0.0

This release fixes issue #1831, which could cause DB-Sync to crash under some unusual conditions
(while executing a rollback following an update to constitutional committee members).
It applies the following SQL code to the schema:

ALTER TABLE "committee_member" DROP CONSTRAINT "committee_member_committee_id_fkey";
ALTER TABLE "committee_member" ADD CONSTRAINT "committee_member_committee_id_fkey" FOREIGN KEY("committee_id") REFERENCES "committee"("id") ON DELETE CASCADE  ON UPDATE RESTRICT;

Users can alternatively apply this fix manually to any 13.4.x.x release to avoid or to fix the issue. It is recommended that all
DB-Sync users either upgrade to version 13.5.0.0 or apply the fix manually.

Upgrading

Upgrading from any 13.4.x.x release happens instantly.
Upgrading from other 13.x.x.x releases is also possible. A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.
If you restart db-sync with different genesis files, you need to initially delete the ledger state snapshots files.

The release is compatible with 13.4, 13.3, 13.2 and 13.1 snapshots. They can be found at:

Network	Link to snapshot
Mainnet-13.5	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.5/
Mainnet-13.4	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/
Mainnet-13.1	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Postgres setup

It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Notes

When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md

Platforms

• Linux 64-bit
• Docker
  Requires ghc-8.10.x to build.

Non-default Changelog (this only affect users that use non default options)

• Fix consumed_by option for Byron inputs. A migration fixes old wrong values in place. 1821
• Fix only-utxo preset populating the metadata instead of the multiassets

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product	🟢
Test Engineer	🟢
Site Reliability Engineer	🟢

13.4.1.0

This release fixes issues related to config options. For the default db-sync it's the same as 13.4.0.0.

Changelog

• Fix consumed_by option for Byron inputs. A migration fixes old wrong values in place. [#1821]
• Fix only-utxo preset populating the metadata instead of the multiassets

Cardano DB Sync 13.4.0.0

This release is compatible with Cardano node version 9.1.0. Newer node versions may also work, but this has not been tested.

The release is compatible with 13.4, 13.3 ,13.2 and 13.1 snapshots. They can be found at

Network	Link to snapshot
Mainnet-13.4	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.4/
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/
Mainnet-13.1	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/

Older snapshots require migration, so it's recommended to use the latest version
Documentation for restoring from these files is available at state-snapshot.md.

Upgrade instructions

It is possible to upgrade to this release from previous versions.
A ledger state replay may be necessary from genesis. The existing db is not affected by this, only the ledger snapshot.
If you restart db-sync with different config or genesis files, you need to initially delete the ledger state snapshots files.

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Postgres setup

It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Notes

When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md

Platforms

• Linux 64-bit
• Docker
  Requires ghc-8.10.x to build.

Changelog

The release mostly fixes issues to 13.3.0.0. Any schema changes are only minor.
Read more here

Known issues

• Using "only-utxo" preset has a bug: it enables the metadata instead of the multiassets. When using this flag, 13.4.0.1 tag should be used https://github.com/IntersectMBO/cardano-db-sync/releases/tag/13.4.0.1
• "pool_stats" preset will be renamed to "pool_stat" in next releases.

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product	🟢
Test Engineer	🟢
Site Reliability Engineer	🟢

Cardano DB Sync 13.3.0.0

This release is compatible with Cardano node version 9.0.0. Newer node versions may also work, but this has not been tested.

The release is compatible with 13.3 ,13.2 and 13.1 snapshots. They can be found at

Network	Link to snapshot
Mainnet-13.3	TODO
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/
Mainnet-13.1	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.1/

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

Upgrade instructions

It is possible to upgrade to this release from previous versions. Migration from 13.2 takes around 5 mins. schema-diff-13.2.txt shows exactly the migrations that will run.

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Postgres setup

It is advised to use a postgres version >= 14. The default docker postgres has been upgraded to 14.10-alpine.
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (the default is 64MB).
Also use the default (2) or higher for `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Notes

When running db-sync make sure you enable only the data that you need. This can be configured in the db-sync config file as documented here configuration.md

Platforms

• Linux 64-bit
• Docker
  Requires ghc-8.10.x to build.

Changelog

This release adds support for Conway and introduces new tables.
A list of changes can be found at https://github.com/IntersectMBO/cardano-db-sync/blob/release/13.3.0.0-changelog/cardano-db-sync/CHANGELOG.md#13300

The migrations diff with the previous release schema (13.2) may be useful
migration files diff: schema-diff-simple.txt
full migrations diff: schema-diff-13.2.txt
schema.md diff: schema-md-diff-13.2.txt

Known issues

On restart, a large log message may appear that starts with

Found some wrong values already. The oldest ones are ...

and a procedure which tries to fix data (which are already correct)

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product	🟢
Test Engineer	🟢
Site Reliability Engineer	🟢

Cardano DB Sync Sancho-5.1.0

NOTE: THIS RELEASE IS ONLY RECOMMENDED FOR USE ON THE SANCHONET AND PUBLIC TEST ENVIRONMENTS (E.G. PREVIEW) AT THIS TIME. IT IS NOT RECOMMENDED FOR USE ON MAINNET UNTIL FURTHER TESTING

YOU SHOULD HAVE THIS IN ANY DBSYNC CONFIG IF YOU WANT TO HF TO CONWAY WITHOUT ISSUES

  "EnableFutureGenesis" : true,

This release adds support for node-8.12.2 and 9.0.0.

Schema
Docker

Changelog

• new entries in reward_rest table for rewards coming from treasury withdrawl proposals and proposal refunds
• proposed committe is now properly depicted
• enacted treasury withdrawl now have the correct fields
• added epoch_state table
• added optional table tx_cbor
• Offchain voting data are hashed directly without any canocalization

Known issues

• Genesis committee is wrong #1758

Cardano DB Sync Sancho-5.0.0

NOTE: THIS RELEASE IS ONLY RECOMMENDED FOR USE ON THE SANCHONET AND PUBLIC TEST ENVIRONMENTS (E.G. PREVIEW) AT THIS TIME. IT IS NOT RECOMMENDED FOR USE ON MAINNET UNTIL FURTHER TESTING

This release adds support for node-8.11.0-pre. It may be compatible with later node versions, but it hasn't been tested
It is advised to resync from genesis when upgrading to this release

Schema
Docker image

Changelog

Changelog

• CIP-119 support: Adds a new table off_chain_vote_drep_data. Also it moves CIP-108 rtelated data from table off_chain_vote_drep_data to the new off_chain_vote_gov_action_data.
• Adds new epoch_state table with the committee and constritution per epoch
• new_committee_info is renamed to committee
• new_committee_member is renamed to committee_member
• The references of committee and constitution to gov_action_proposal since they can also come from the Conway genesis. Previously these genesis data were missing.
• All gov_action_proposals.enacted_epoch field are now marked when they should
• Added entries in the reward_rest table for each payed treasury withdrawals

Cardano DB Sync Sancho-4.3.0

NOTE: THIS RELEASE IS ONLY RECOMMENDED FOR USE ON THE SANCHONET AND PUBLIC TEST ENVIRONMENTS (E.G. PREVIEW) AT THIS TIME. IT IS NOT RECOMMENDED FOR USE ON MAINNET UNTIL FURTHER TESTING

This release adds support for node-8.11.0-pre. It may be compatible with later node versions, but it hasn't been tested
It is advised to resync from genesis when upgrading to this release

Schema
Docker image

Changelog

• gov_action_proposal.expiration fixed (was 1 less than it should)
• drep_distr rollback fixed #1699
• removed unique key from reward_rest table, which didn't allow multiple refunds to be distributed #1702

Cardano DB Sync 13.2.0.2

This release is a minor fix on top of 13.2.0.1. It's meant to provide support for Cardano node version 8.9.1 and better long term support for future node versions that change the conway genesis. This tag will ignore the conway genesis file unless db-sync config has this entry flag "EnableFutureGenesis" : true,

Compatible snapshots:

Network	Link to snapshot
Mainnet-13.2	https://update-cardano-mainnet.iohk.io/cardano-db-sync/index.html#13.2/

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

Requires ghc-8.10.x to build.

Associated docker image: 13.2.0.2-docker

Upgrade instructions

Upgradable from 13.0.x.x releases. Read more

Changelog

DBSync ignores the conway genesis unless EnableFutureGenesis is set
Fixed an issue with snapshot restoration 1659

Known issues

• The new extra migrations are only experimentally supported because they're not very well tested and there are a few known issues with them #1420
• The epoch table may have some wrong values after upgrading from a previous release.
• Running the consumed-tx-out migration can be very slow. See more at #1621
• Logging issues #1623
• There is an issue where the ma_tx_mint table is disabled by the --disable-metadata flag instead of the --disable-multi-asset.
• Epochs that are not dense enough may cause missing epoch_stake entries. Affects preprod epochs 13-28.

Documentation

Cardano DB Sync Overview
Building and Running the Cardano DB Sync Node
Schema Management
State snapshot
Smash

Notes

Default docker postgres has been upgraded to 14.10-alpine
There is a postgres requirement for users that don't use docker-compose and have to manually configure postgres:

It is advised to increase the `maintenance_work_mem` from the Postgres configuration to 0.5GB - 1GB (default is 64MB).
Also use the default (2) or higher `max_parallel_maintenance_workers` (this parameter was introduced in `postgres` version 11)

Sign off

Role	Approval
Technical Lead	🟢
Cardano Head of Engineering	🟢
Cardano Head of Product	🟢
Test Engineer	🟢
Site Reliability Engineer	🟢