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	🟢

Cardano DB Sync Sancho-4.2.1

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

Same as sancho-4-2-0, but it fixes broken docker genesis.
Docker image

Cardano DB Sync Sancho-4.2.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.10.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

• Added new fields stake_registration.deposit and pool_update.deposit for payed deposits (null for reregistrations or disabled ledger state)
• Added new fields epoch_param.min_fee_ref_script_cost_per_byte and epoch_param.min_fee_ref_script_cost_per_byte
• gov_action_proposal.dropped_epoch and gov_action_proposal.expired_epoch are now populated
• Fixed a bug with gov_action_proposal.enacted_epoch not being updated
• Renamed instant_reward table to reward_rest
• Added a new type of rewards proposal_refund, which are inserted in the reward_rest table
• Unclaimed proposal refunds are logged but not inserted anywhere yet

Cardano DB Sync Sancho-4.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

This release adds support for node-8.8.0-pre and probably node-8.9.0. 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

• Moved modularity flags to the db-sync config, documented here
• Made committee proposals more readable, with the addition of a new table new_committee_member for new members 1633. Also new_committee is renamed to new_committee_info
• Added a new table committee_hash which is now referenced by other tables instead of using the hash directly. This in particular solves 1571
• Added support for offchain vote metadata and partial support for CIP-100 and CIP-108
• Fixed script hash false negative check 1646

Vote offchain data

This release partially follows CIP-100 and proposed CIP-108. It fetches the off chain data, pointed by on chain voting anchors and populates the off_chain_vote_data table or off_chain_vote_fetch_error if fetching or parsing fails. The off_chain_vote_data is extended with all optional or necessary fields as they are described at CIP-100 and CIP-108. Also three new tables are added off_chain_vote_author, off_chain_vote_reference, off_chain_vote_external_update.

The hash and witness validation is not fully implemented, so db-sync will store a warning in almost all cases at off_chain_vote_data.warning and off_chain_vote_author.warning. Users that decide that some metadata are in fact invalid can edit the off_chain_vote_data.is_valid

Users can also directly access the original bytes at off_chain_vote_data.bytes or the original json at off_chain_vote_data.json. In particular the latter is stored in a a Postgres jsonb type, which allow a big number of builtin queries. For example

SELECT * FROM off_chain_vote_data where json ? 'authors'
returns all the metadata which have a build author or

SELECT * FROM off_chain_vote_data where json @> '{"authors":"xyz"}';
returns all metadata with a specific authors. Postgres makes all these queries indexable.

Fetching or parsing errors are inserted into off_chain_vote_fetch_error. These can be 404 "Not Found", expected JSON, but got : "text/html, InvalidUrlException, JSON decode error to name a few.

Cardano DB Sync 13.2.0.1

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

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

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

Documentation for restoring from these files available at state-snapshot.md. For the 13.1 snapshots the Upgrade instructions below are also relevant.

Requires ghc-8.10.x to build.

Associated docker image: 13.2.0.1

Upgrade instructions

Upgradable from 13.0.x.x releases. Read more

Changelog

This release improves syncing speed and significantly extends modularity.
You can check the full changelog and the config options

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.

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)

Platforms

• Linux 64-bit
• Docker

Sign off

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

Cardano DB Sync Sancho-3.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.7.2-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

Changelog
Schema
Associated docker image

Vote offchain data

This release fetches the off chain data, pointed by on chain voting anchors and populates the off_chain_vote_data table. It is an initial implementation of CIP-100 . It is in general much more lenient, it accepts any data as long as they are parsable to any json format, while CIP-100 assumes some minimal fields. Also DBSync doesn't follow the json-ld canonicalization algorithm that's described in CIP-100. It simply checks the blake2b-256 hash of the fetched metadata and leaves a warning at off_chain_vote_data.warning if there is a mismatch.

The json is stored in a Postgres jsonb type, which allow a big number of builtin queries. For example

SELECT * FROM off_chain_vote_data where json ? 'authors'

returns all the metadata which have a build author or

SELECT * FROM off_chain_vote_data where json @> '{"authors":"xyz"}';

returns all metadata with a specific authors. Postgres makes all these queries indexable.

Fetching errors are inserted into off_chain_vote_fetch_error. These can be 404 "Not Found", expected JSON, but got : "text/html, InvalidUrlException, JSON decode error to name a few.

Sign off

Role	Approval
Technical Lead	⏳
QA Engineer	⏳
Ops	⏳
Release Engineer	⏳