Asset.assetName and Asset.assetId are now typed as Hex, as the relationship from Assets to TokenMints needed to be established using the underlying table, where assetId is not present.
Configuration of the asset metadata fetching is now a single value. POLLING_INTERVAL_METADATA_SYNC_INITIAL and POLLING_INTERVAL_METADATA_SYNC_ONGOING are replaced by ASSET_METADATA_UPDATE_INTERVAL, which is the number of seconds before the service checks the registry for updates.
AssetSupply.total is now an optional field, and can return null.
Transaction.metadata is now JSON type, not JSONObject
- Despite the name, JSONObject was mapped to the underlying JSON resolver as a workaround to avoid breaking changes.
The fields previously modelled on Token have been nested under Token.asset
tokens and tokens_aggregate have been removed in favour of assets and assets_aggregate

Asset properties nested under PaymentAddress.assets are now under PaymentAddress.assets.asset

Block.merkleRoot removed, as no longer part of cardano-db-sync schema. (8b3b718)

Features

Replaces the use of cardano-cli with Ogmios for interacting with the node using JSON-WSP, and implements the convenient cardano-node-ogmios Docker image as a drop-in replacement for the cardano-node image.
Sync assets using chain-sync protocol via Ogmios (784509e)
tokenMints and tokenMints_aggregate queries (f803b94)
add query complexity validations (24a14a9),
add default query complexity calculations with arguments (b16c77d)
implement complexity in resolvers (5664a55)
use cardano-node config for lastConfiguredMajorVersion (5a621c2), closes #454
add Epoch_bool_exp.startedAt (4cc580a)
add TransactionOutput_bool_exp.index (34d5438)
allow ordering of assets by token mint count (cfbb039)
Asset metadata decimals (082f509)

Bug Fixes

improve startup robustness (7054a59)
- The GraphQL server is now delayed until all modules are initialized, and running. If cardano-db-sync reboots, all modules are shutdown, and restarted and therefore links the server availability with a fully initialized stack.
Add order_by to asset query (5848c24)
Asset_bool_exp.tokenMints (7616a49)
assetFingerprint bug when no assetName present (9a61d91), closes #487
await all promises in shutdown function (3d7ef11)
await CardanoNodeClient init before starting server (f33f6aa)
cardanoDbSyncMeta.initialized during startup (d6649cf)
casing on invalid hereafter in GraphQL schema (854ec4a), closes #390
Copy cardano-node config into Docker image (4bf4866)
default metadata server URI (2a98055)
disable CORS in Hasura graphql-engine (4499422), closes #392
Ensure DB is in current era before completing HasuraClient initialization (0d43abc)
guards on missing current epoch row (6204c96)
log all error messages during service startup, not just HostDoesNotExist (c81aad8)
memory leak in Hasura GraphQL client (3c8511d)
move current era check to be lazy operation (7830c91)
move graphql-engine option under serve command (f76e944)
policyId comparison expression type (99318cc), closes #485
remove promise chaining cycle (8b55ca0), closes #459
Reorder logging arguments based on Bunyan interface (46b26a0)
Restore protocol params fetcher init (e86fc1a)
scoping on package (82e2040)
submitTransaction error mapping (3629725)

4.0.0

Diff

rhyslbw

published 4.0.0 • 4 years ago

Changelog

Source

4.0.0 (2021-03-29)

Compatible with:

cardano-node: 1.25.1
cardano-db-sync: 9.0.0 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.3

⚠ BREAKING CHANGES

StakePool.url no longer URL type. The ledger does not validate the url value provided by the owner, therefore trying to impose rules around the structure will fail.
Transaction.metadata is now more accurately JSON type, not JSONObject. Despite the name, JSONObject was currently mapped to the underlying JSON resolver as a workaround to avoid breaking changes.
The fields previously modelled on Token have been nested under Token.asset. tokens and tokens_aggregate have been removed in favour of assets and assets_aggregate. Asset properties are now nested under PaymentAddress.summary.assetBalances.asset

Bug Fixes

ActiveStake.stakePoolHash field name (08fe609)
add Mint.asset relationship (0deaaac)
add remaining Asset fields Hasura query used to fulfil paymentAddress query (879db94)
batch asset synchronising operations (637d607)
Block.merkelRoot -> Block.merkleRoot (b9e1e13)
include rewards in ada circulating supply (69f23c1)
StakePool.url is now type String (a661525)
StakePoolRetirement_bool_exp.inEffectFrom type (96aa708)
Correct Transaction.metadata type (79205a2)
Remove cardano-cli ledger-state query, make AssetSupply.total optional (f86ef42)
use cardano-node config for lastConfiguredMajorVersion (5a621c2), closes #454
replace cardano-cli query with db lookup for protocol params (a6387b3)
throw error in resolver rather than return it (dd9a031)

Features

Introduce asset model and fetch metadata from external service (0329a84)
Ada Pots (9c7f058)

3.2.0

Diff

rhyslbw

published 3.2.0 • 4 years ago

Changelog

Source

3.2.0 (2021-02-01)

cardano-node: 1.25.1
cardano-db-sync: 8.0.0 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.3

Features

Ada supply query (e716d51)
Submit transaction mutation (29f1adb)
Multi-asset support (86e4206)
Structured logging (f948cf5)
Improve delegation and active stake models (ad06274)
Report sync progress in logs during initialisation (83279c3)

Bug Fixes

GraphQL schema order_by (9869a48)
guard against simultaneous data fetches (93e198f)
Opt-out of Hasura CLI telemetry (196086c)
pass logger to onFailedAttempt (1b8b0cf)
Replaces the time-based logic to determine sync progress and initialisation state (b29ef3e), closes #248

3.1.1

Diff

rhyslbw

published 3.1.1 • 4 years ago

Changelog

Source

3.1.1 (2020-12-21)

cardano-node: 1.24.2
cardano-db-sync: 7.1.0 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.3

Bug Fixes

JSON resolver for transaction metadata (9085036), closes #389

3.1.0

Diff

rhyslbw

published 3.1.0 • 4 years ago

Changelog

Source

3.1.0 (2020-12-10)

Compatible with:

cardano-node: 1.24.2
cardano-db-sync: 7.1.0 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.3

Features

Transaction validity interval fields (ad9b4e5)
- Transaction.invalidBefore
- Transaction.invalidHereafter
- associated input fields

Bug Fixes

Reward and StakeDeregistration order_by fields (a6f9a88), closes #382

3.0.1

Diff

rhyslbw

published 3.0.1 • 4 years ago

Changelog

Source

3.0.1 (2020-11-27)

Compatible with:

cardano-node: 1.21.1
cardano-db-sync: 6.0.1 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.3

Bug Fixes

add missing comparison operator fields to bool expressions (89addef)
StakePool_bool_exp.rewards type (1f02a68)

3.0.0

Diff

rhyslbw

published 3.0.0 • 4 years ago

Changelog

Source

3.0.0 (2020-11-05)

This new major version, now based on the current Node.js LTS, brings the second round of Shelley-era features to the API. Most notably, rewards, active stake captured at each epoch boundary, transaction metadata, protocol parameters in effect during the epoch, and custom types for the Bech32 values covered by CIP5.

You may be impacted by breaking changes, which are listed below.

Compatible with:

cardano-node: 1.21.1
cardano-db-sync: 6.0.0 - Note: The database must be recreated using the new version.
hasura/graphql-engine: 1.3.2

⚠ BREAKING CHANGES

Omitting the limit in queries will now return 2500 records, rather than 100
WHITELIST_PATH is now ALLOW_LIST_PATH
HASURA_CLI_PATH is now required configuration, however it's set in the Dockerfile and nix service by default.
All schema instances for stake addresses are now validated for the correct prefix using a custom scalar
Block.vrfKey and the associated input types are now a validated for the correct prefix using a custom scalar
StakePool.id and the associated input types are now a validated for the correct prefix using a custom scalar
Hash32HexString -> Hash32Hex
Hash32HexString_comparison_exp -> Hash32Hex_comparison_exp
SlotLeader.hash, StakePool.hash, StakePoolOwner.hash are now Hash28Hex type
Block.vrfKey is now the bech32 encoded value as per CIP5. It's now typed as VRFVerificationKey.

Features

Rewards (46cc878)
- top-level queries rewards and rewards_aggregate
- StakePool.rewards and StakePool.rewards_aggregate
StakePool.id (3fc763c)
- Bech32 encoded, prefixed with pool
Introduce ActiveStake concept (1b66fee)
- Snapshot of the stake linked to a registered stake key, per epoch.
- This features adds an activeStake query, and extends the Epoch type to include activeStake and activeStake_aggregate fields.
- top-level activeStake_aggregate query (8e13a52)
Epoch.protocolParams and Epoch.nonce (c08d652)
Transaction.metadata (8cec6e8)
Custom GraphQL scalars
- StakeAddress (1bd5c8b)
- StakePoolID (627db37)
- VRFVerificationKey (eae8f72)

Improvements

consolidate api-genesis with api-cardano-db-hasura(0f927c4)
upgrade to Node.js 14 (950852a)
Require explicit path to hasura CLI executable (ca22d42)
Remove depreciated config option WHITELIST_PATH (a2d00ff)
Change Hasura record limit from 100 to 2500 (212bc47), closes #333
server configuration lifted to Dockerfile (167ff42)
expose the API port (Removes the hard-coding) (e422734)

Bug Fixes

accurately allocate hashes to 28 byte type (f9597bc)
add port and custom column names to pool_relay mapping (879a51a), closes #328 #329
Change Block.vrfKey type to String (a34c8aa)
properly type ShelleyProtocolParams (a7a2c3a)
remove invalid Genesis.shelley.protocolMagicId (a73ba1e), closes #327
remove StakePool.withdrawals field (46dd937)
typo in missing config error message (d904a72)

2.2.0

Diff

rhyslbw

published 2.2.0 • 4 years ago

Changelog

Source

2.2.0 (2020-09-24)

Compatible with:

Features

api-cardano-db-hasura: add Transaction.withdrawals (b608cc8)
client-ts: combine graphql schemas in client package (bd52a16), closes #273

2.2.0-beta

Diff

rhyslbw

published 2.2.0-beta • 4 years ago

2.1.0

Diff

rhyslbw

published 2.1.0 • 4 years ago

Changelog

Source

2.1.0 (2020-09-17)

Compatible with:

cardano-node: 1.19.1
cardano-db-sync: 5.0.0 - Note: The database must be recreated using the new version.

Features

api-cardano-db-hasura: add custom $SECRET_DIR support for docker image (ff79b10)
api-cardano-db-hasura: add Epoch.fees (4482338)
api-cardano-db-hasura: add Transaction.deposit (2726d80)
Add build arg to include genesis files (c06912d)
Improve logging during retry attempts (e24df95)
replace DB polling with postgres notification listener for migrations (e42eb3d)

Bug Fixes

add missing GraphQL model for Delegation.transaction (3ac55b1)
address ordering type mismatch in GraphQL schema (45f3c73)
ensure migration is run before introspection (079a248)
include @types/* packages in workspace devDependencies (6c5f075)
include pools without metadata in StakePool view (d978094)
api-cardano-db-hasura: harden schema introspection (3ca88b4), closes #281
scope allow list to graphql path (bee2005), closes #303
api-cardano-db-hasura: improve error handling with Cardano query delegation (4e532a3)
api-cardano-db-hasura: Move each query to separate test (3b29f48)
api-cardano-db-hasura: Properly model and relate StakePoolRetirements (a5fef40)
api-cardano-db-hasura: Support 28 byte hex encoded hashes (9e28ffa)
server: better align server config options (30a7534)
server: rename whitelist to allow-list (eeeafa9)
server: return HTTP 403 errors when rejecting disallowed queries (b8892ca)