@cardano-graphql/cli

Cardano GraphQL - CLI

Global install from npm

npm i -g @cardano-graphql/cli
cgql --help

Build from source using yarn

yarn & yarn add-global
cgql --help

Depending on your local environment, you may need to add the yarn global bin to your PATH. The following command is useful for a single terminal session:

export PATH="$(yarn global bin):$PATH"
cgql --help

Changelog

2.0.0

This new major version brings the first round of Shelley-era features to the API, introduces a new genesis file API package, and hardens the migrations and metadata handling. This version is required for transitioning through the upcoming Shelley hard fork.

Compatible with:

• cardano-node: 1.18.0
• cardano-db-sync: 3.1.0 - Note: The database must be recreated using the new version.

Features

New Queries

• stakePools, stakePools_aggregate
• delegations, delegations_aggregate
• stakeRegistrations, stakeRegistrations_aggregate
• stakeDeregistrations, stakeDeregistrations_aggregate
• withdrawals, withdrawals_aggregate
• genesis
• Metadata and SQL migrations are now performed within the application layer, and make the service immune to schema being removed should cardano-db-sync restart. using the Hasura CLI, which is included in the Dockerfile and NixOS service, however outside of this you must install and place hasura on PATH.
• A new API package @cardano-graphql/api-genesis allows access to the network genesis files. It's integrated into the server, with the config exposed as environment variables. As usual, the docker-compose.yaml serves as a good reference.

Breaking Changes :warning:

• The docker-compose file now mounts configuration managed in the repository, restoring the usual separation of concerns with service configuration. The Docker images still have the configuration included at build time, however in practice, being ready to managing your own configuration if required is a good strategy. Simply copying the top level config and committing to source control gives you full control over the services using their native interface.

Removed fields

• Cardano.networkName removed. Use network magic from the genesis API identify networks.
• Cardano.protocolConst, Cardano.slotDuration, Cardano.startTime, Cardano.slotsPerEpoch removed. Access this info from the Genesis API.
• cardanoDbSync.slotDiffFromNetworkTip removed in reponse to a change in strategy for determining sync status with cardano-db-sync determining sync status relies on a chain that has produce

Changed fields

Dates we're previously formatted to ISO 3339, however ISO 8601 is being adopted with this release for alignment with the Shelley genesis file format and simplification when the precision is not required.

• 2017-10-03T21:43:51.000Z -> 2017-10-03T21:43:51Z
• Block.createdBy -> Block.slotLeader links to an object, with a nullable stakePool field. For previous behaviour, Block.slotLeader.description can be used, however the description prefixes have changed upstream from SlotLeader to ByronGenesis
• Block.createdAt -> Block.forgedAt
• Block.slotWithinEpoch -> Block.slotInEpoch

Chores

• Migrations have been squashed into a single step.