Cardano GraphQL 8.0.1

What's Changed

• Nixos service updates by @johnalotoski in #815
• Feat/upgrade db sync 13.2.0.1 ogmios 6.1 node 8.7.3 by @Kammerlo in #859
• Added Sanchonet compatibility

Infos for Upgrading

Due to an needed upgrade of postgres from 11 to 14 a resync is needed. Since db-sync isn't working anymore with Postgres 11.

Full Changelog: 8.0.0...8.0.1

Cardano GraphQL 8.0.0

This major release separates the single cardano-graphql process into a http-server and background service, to separate the workload and support horizontal scaling of the external interface. It's tested against Cardano service dependency versions compatible with the upcoming protocol upgrade.

Compatible with:

• cardano-node: 1.35.5
• cardano-ogmios: v5.5.8
• cardano-db-sync: 13.0.5
• hasura/graphql-engine: 2.17.1

⚠ BREAKING CHANGES

• Dropped support for average aggregation fields.
• Aligned GraphQL types to conform with database and Hasura string casts
• api-cardano-db-hasura: separate DB and Hasura management tasks to new process

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Features

• api-cardano-db-hasura: separate DB and Hasura management tasks to new process (8acb58f)
• Improve uncaught exception logging (800a587)

Bug Fixes

• api-cardano-db-hasura: remove VARCHAR limits from Asset table (a4092f8)
• api-cardano-db-hasura: retry initialization of data fetcher (d5a794d)
• server: avoid producing NaN in asset sync percentage calc, and clamp to max 100% (b48e804)
• Aligned GraphQL types to conform with database and Hasura string casts (ad4e736)
• Dropped support for average aggregation fields (3cd6445)

Sign off

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

Cardano GraphQL 7.0.2

This minor release updates the bundled config, and bumps the ogmios and db-sync versions.

Compatible with:

• cardano-node: 1.35.3
• cardano-ogmios: v5.5.7
• cardano-db-sync: 13.0.5
• hasura/graphql-engine: 1.3.3

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Improvements

• bump cardano-configurations (a386938)
• remove upper Node.js engines constraint (7eb733f)

Sign off

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

Cardano GraphQL 7.0.1

This minor release addresses the issues detailed below.

Compatible with:

• cardano-node: 1.35.3
• cardano-ogmios: v5.5.5
• cardano-db-sync: 13.0.4
• hasura/graphql-engine: 1.3.3

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Bug Fixes

• api-cardano-db-hasura: correct close and error handling of Ogmios connection (df82008)
• api-cardano-db-hasura: mitigate unexpected Ogmios socket disconnect (3d81bf5)
• Gracefully handle Ogmios socket disconnection (18bf3e1)
• Mount local config into cardano-node-ogmios (f055378)

Other Improvements

• optimize Cardano & StakePoolOwner views (064e8cb)
• install hasura-cli plugin at build time (b47cf89)

Sign off

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

Cardano GraphQL 7.0.0

This major release supports the upcoming Vasil protocol upgrade.

Compatible with:

• cardano-node: 1.35.3
• cardano-ogmios: v5.5.5
• cardano-db-sync: 13.0.4 - Note: The database must be recreated using the new version.
• hasura/graphql-engine: 1.3.3

⚠ BREAKING CHANGES

• Collateral outputs
• Add ProtocolParams type to better represent current protocol params
• Remove remnants of previously deprecated config
• Reward.receivedIn nullability
• Reward.stakePool is now nullable to handle rewards of type treasury or reserves.

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Features

• Add TransactionOutput|CollateralOutput.paymentCredential (e6e2d45)
• Add Transaction.referenceInputs (2c5e0b5)
• Collateral outputs (a222cb4)
• Support Babbage block (fe484e1)
• Support Plutus data (58f6c48)
• Remove remnants of previously deprecated config (c3fc2aa)
• Update to Ogmios v5.5.0 cardano-db-sync 13.0.0 (b821f21)

Bug Fixes

• Redeemer.fee is nullable in the Babbage era (813a7ae)
• Add ProtocolParams type to better represent current protocol params (73cf785)
• api-cardano-db-hasura: define response as optional in metadata server errors (ca5d556)
• cli: correct services option (f600d31)
• Gracefully shutdown cardano-db-sync (2f02e56), closes /github.com/CardanoSolutions/ogmios/blob/c32341e56ccbeb1cf1e803d4607699668a1e2cc2/Dockerfile#L73
• Reward.receivedIn nullability (9a3dcf5)
• Trim whitespace from credentials in server config (b40a596)

Sign off

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

Cardano GraphQL 6.2.0

Compatible with:

• cardano-node: 1.33.0
• cardano-ogmios: v5.1.0
• cardano-db-sync: 12.0.0
• hasura/graphql-engine: 1.3.3

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Features

• Support change to asset ticker length (b858445)

Bug Fixes

Known Issues

• Submitting random string to the submitTransaction mutation hangs #545

Sign off

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

Cardano GraphQL 6.1.0

This minor release adds compatibility with cardano-db-sync@12 and [email protected] , plus fixes a bug relating to Transaction.collateral.

Compatible with:

• cardano-node: 1.31.0
• cardano-ogmios: v4.2.1
• cardano-db-sync: 12.0.0 - Note: The database must be recreated using the new version.
• hasura/graphql-engine: 1.3.3

System Requirements

• DB Sync system requirements
  • The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:
    • Any of the big well known Linux distributions (eg, Debian, Ubuntu, RHEL, CentOS, Arch etc).
    • 24 Gigabytes of RAM.
    • 4 CPU cores.
    • 80 Gigabytes or more of disk storage (preferably SSD which are 2-5 times faster than electro-mechanical disks).
  • The recommended configuration is to have the db-sync and the PostgreSQL server on the same machine. During syncing (getting historical data from the blockchain) there is a HUGE amount of data traffic between db-sync and the database. Traffic to a local database is significantly faster than traffic to a database on the LAN or remotely to another location.

The host machine will need at least 32 Gigabytes of RAM to run the full cardano-graphql stack.

Bug Fixes

• Add missing Transaction.collateral Hasura table config (8a5f93e)

Known Issues

• Submitting random string to the submitTransaction mutation hangs #545

Sign off

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

Cardano GraphQL 6.0.0

This major release changes the Reward type to support rewards received from the treasury or reserves via move instantaneous reward (MIR) operations, improves the visibility of Asset table sync status on startup, and facilitates restoring a cardano-db-sync snapshot which is documented in the README.

Compatible with:

• cardano-node: 1.30.1
• cardano-ogmios: v4.1.0
• cardano-db-sync: 11.0.4 - Note: The database must be recreated using the new version if you are upgrading from v10 or lower.
• hasura/graphql-engine: 1.3.3

⚠ BREAKING CHANGES

• Reward.stakePool is now nullable to handle rewards of type treasury or reserves.

Features

• Include all reward types in Reward model, adds type field (6f1ddd9)
• Reward.receivedIn (e9e5715)
• TransactionInput_order_by.transaction (f775c45)
• Use Asset table sync status to determine Server readiness (dfff8d5)

Bug Fixes

• Add permission to Reward.type, and index the column (6f157a5)
• Make METADATA_SERVER_URI required config (552c5e8)

Known Issues

• Submitting random string to the submitTransaction mutation hangs #545

Sign off

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

Cardano GraphQL 5.1.0

This feature release extends the API to include Alonzo concepts, including new top level queries for scripts, collateralInputs, and redeemers, plus extensions to the Transaction model, protocol parameters, and genesis. It's now possible to pull and run the Docker Compose stack without building images locally, by pulling all images from Docker Hub first. The README has been improved to cover this new option, and provides up/down commands for each supported network for convenience.

Compatible with:

• cardano-node: 1.29.0
• cardano-ogmios: v4.0.0-beta.9
• cardano-db-sync: 11.0.0 - Note: The database must be recreated using the new version.
• hasura/graphql-engine: 1.3.3

Features

• Support Docker pull and run to skip builds (ee03a57)
• Alonzo data mapping (eff1d9c)
• Add AlonzoGenesis(d600dc0)
• Add Alonzo blocks to conditional chain following (8d6aaf4)

Bug Fixes

• Add network suffix to Docker Compose file (53059b9)
• Guard sync drift between cardano-db-sync and cardano-graphql (3c9707b)
• Properly handle error as known exception (755c500)
• Invalid cache target in compose file (4b4dfc3)
• Guard logic (110deaa)
• OperationRequiresNodeInCurrentEra -> OperationRequiresSyncedNode (6165965)
• Startup race-condition with chain-followers (0b15315)

Known Issues

• Submitting random string to the submitTransaction mutation hangs #545

Sign off

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

Cardano Graphql 5.1.0-beta.1

beta.1

It's now possible to pull and run the Docker Compose stack without building images locally, by pulling all images from Docker Hub first. The README has been improved to cover this new option, and provides up/down commands for each supported network for convenience.

Compatible with:

• cardano-node-ogmios: v4.0.0-beta.6
• cardano-db-sync: alonzo-purple-1.0.1 - Note: The database must be recreated using the new version. If you are upgrading from a previous beta skip this step, otherwise see the Wiki for instructions.
• hasura/graphql-engine: 1.3.3

Features

• support Docker pull and run to skip builds (ee03a57)

Bug Fixes

• invalid cache target in compose file (4b4dfc3)

Known Issues

• Submitting random string to the submitTransaction mutation hangs #545

beta.0

This pre-production feature release extends the API to include Alonzo concepts, including new top level queries for scripts, collateralInputs, and redeemers, plus extensions to the Transaction model, protocol parameters, and genesis.

The API is not guaranteed to be stable, however is suitable for testing integrations on non-mainnet networks. See the schema diff for full details.

Sign off

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