CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.35.11 (2025-04-08)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.10 (2025-03-03)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.9 (2025-02-25)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.8 (2025-02-24)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.7 (2025-02-19)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.6 (2025-02-10)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.5 (2025-02-06)

Features

• introduce persistent cache for providers (e39bf3d)

0.35.4 (2025-01-31)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.3 (2025-01-27)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.2 (2025-01-25)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.1 (2025-01-22)

Note: Version bump only for package @cardano-sdk/cardano-services

0.35.0 (2025-01-20)

⚠ BREAKING CHANGES

• correct return type of RewardAccount.toHash
• add order option to ChainHistoryProvider.transactionsByAddresses

Features

• add order option to ChainHistoryProvider.transactionsByAddresses (9d816b3)

Bug Fixes

• correct return type of RewardAccount.toHash (67765f1)

0.34.0 (2025-01-17)

⚠ BREAKING CHANGES

• The package now exports an async ready function that must be called before any of crypto related functions can be called

• Bip32PrivateKe async functions are all now sync
• Bip32PublicKey class async functions are all now sync
• Ed25519PrivateKey class async functions are all now sync
• Ed25519PublicKey class async functions are all now sync
• Bip32Ed25519 interface async functions are all now sync
• SodiumBip32Ed25519 cosntructor is now private
• SodiumBip32Ed25519 now has a new async factory method create

Features

• remove async from crypto API (91b7fa2)

0.33.6 (2025-01-09)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.5 (2025-01-02)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.4 (2024-12-20)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.3 (2024-12-16)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.2 (2024-12-05)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.1 (2024-12-02)

Note: Version bump only for package @cardano-sdk/cardano-services

0.33.0 (2024-12-02)

⚠ BREAKING CHANGES

• hoist remaining Blockfrost providers into cardano-services-client

Features

• hoist remaining Blockfrost providers into cardano-services-client (5b68405)

0.32.3 (2024-11-23)

Note: Version bump only for package @cardano-sdk/cardano-services

0.32.2 (2024-11-20)

Note: Version bump only for package @cardano-sdk/cardano-services

0.32.1 (2024-11-18)

Note: Version bump only for package @cardano-sdk/cardano-services

0.32.0 (2024-11-13)

⚠ BREAKING CHANGES

• hoist BlockfrostAssetProvider to cardano-services-client

Features

• browser compatible BlockfrostAssetProvider (de59fcb)

0.31.8 (2024-11-12)

Bug Fixes

• cardano-services: incorrect OpenAPI title (60290ff)

0.31.7 (2024-11-04)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.6 (2024-10-31)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.5 (2024-10-25)

Features

• add blockfrost based provider server (8d9f847)
• cardano-services: improve transaction from blockfrost using cbor to reduce the nr of calls (103f408)

0.31.4 (2024-10-11)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.3 (2024-10-11)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.2 (2024-10-09)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.1 (2024-10-06)

Note: Version bump only for package @cardano-sdk/cardano-services

0.31.0 (2024-10-03)

⚠ BREAKING CHANGES

• hoist ws types to cardano-services-client package

Features

• add web socket based transactions by addresses provider (63798e8)

Code Refactoring

• hoist ws types to cardano-services-client package (72e42ce)

0.30.1 (2024-09-27)

Note: Version bump only for package @cardano-sdk/cardano-services

0.30.0 (2024-09-25)

⚠ BREAKING CHANGES

• OgmiosObservableCardanoNode and bufferChainSyncEvent were moved from core package to projection package

Features

• dockerize blockfrost-ryo (d548040)

Bug Fixes

• add asset id index on nft_metadata table (05fc92c)
• cardano-services: plutus v3 scripts in db-sync utxo provider (b5be7a4)
• cardano-services: refine redeemer purpose accordingly new db-sync version (71f6de7)
• cardano-services: refine update commitee proposal procedures accordingly new db-sync version (348c810)
• cardano-services: resign commitee certificate (80b8da5)

Code Refactoring

• hoist bufferChainSyncEvent to projection package (dd8b52f)

0.29.11 (2024-09-12)

Features

• add script to get in chain tx cbor from tx id (61d4291)
• cardano-services: implement provider selection based on env variables and config (6c8c97d)

Bug Fixes

• cardano-serices: add (partial) stake pool parameters to stake pool registration certificates (3166d53)
• cardano-services: don't fetch assets for collateralReturn as if it was an output (764ec3d)
• cardano-services: fix attempt for projector health check (632f5e8)
• cardano-services: use computed stake credential type while building certificates (39ada85)
• cardano-services: use correct inputs and collaterals order while providing transactions (23df091)

0.29.10 (2024-09-10)

Note: Version bump only for package @cardano-sdk/cardano-services

0.29.9 (2024-09-06)

Features

• cardano-services: implement missing Blockfrost providers features and tests (8df1252)
• cardano-services: improve health check response times by aggregating and caching (2bc68ea)

0.29.8 (2024-09-04)

Note: Version bump only for package @cardano-sdk/cardano-services

0.29.7 (2024-08-23)

Note: Version bump only for package @cardano-sdk/cardano-services

0.29.6 (2024-08-22)

Bug Fixes

• cardano-services: correctly load Mapper.withGovernanceActions (855a057)

0.29.5 (2024-08-21)

Features

• add parameters update projection (d007d7f)

0.29.4 (2024-08-20)

Note: Version bump only for package @cardano-sdk/cardano-services

0.29.3 (2024-08-07)

Bug Fixes

• add timeout to TypeormService withDataSource/withQueryRunner (d5faa15)
• do not run schema migrations when starting pgboss worker (172fe30)
• remove redundant, uninitialized logger from TypeormService (02a9502)

0.29.2 (2024-08-01)

Note: Version bump only for package @cardano-sdk/cardano-services

0.29.1 (2024-07-31)

Features

• cardano-services: add distinction between committe with or without scaript (01c3990)

Bug Fixes

• cardano-services: drep_hash can be null when delegating to abstain or no confidence (7c6c53b)
• cardano-services: typeorm asset provider release query runner once (a1f4dbe)

0.29.0 (2024-07-31)

⚠ BREAKING CHANGES

• cardano-services: conway protocol parameters could be undefined in PV8 or lower
• core: decentralizationParameter was removed in babbage
• cardano-services: removed pool_voting_thresholds and drep_voting_thresholds from ProtocolParamsModel
• add deposit to stake pool registration certificates
• cardano-services: With the introduction of Conway era new certificates we must take care that many new certificates (reg_cert and all combined certificates) should take the same effects as previously done by the stake_registration certificate. The same for stake_deregistration and unreg_cert certificates.
• remove OgmiosTxSubmitProvider
• update core CardanoNode error types
  • Removed OnChainTx witness.scripts and auxiliaryData.scripts

Features

• add deposit to stake pool registration certificates (54189a4)
• cardano-services: add conway certificates to db-sync chain history provider (bb061a7)
• cardano-services: add distinction between constitutional committee with or without script (f6b512a)
• cardano-services: add proposal procedures details (5f8f7c7)
• cardano-services: add proposal procedures to chain history provider (e4779b8)
• cardano-services: add voting procedures to db-sync chain history (4d275ee)
• cardano-services: extract rewards which are not correlated to a pool (b621955)
• cardano-services: map conway protocol params update action (88493d4)
• cardano-services: map pvt/dvt dbSync fields to pool/drep voting thresholds (36c3291)
• cardano-services: network info provider new protocol params (82b9ad3)
• cardano-services: sanchonet support (13109d6)

Bug Fixes

• cardano-services: committee_term_limit renamed to committee_max_term_length (90e84fa)
• cardano-services: committee_term_limit renamed to governance_action_validity_period (79eb6a9)
• cardano-services: conway era deposits in db sync network info provider (ebe7ea7)
• cardano-services: conway protocol parameters could be undefined in PV8 or lower (e68c59b)
• cardano-services: db-sync redeemer purpose mapping (c75fef5)
• cardano-services: drep representation in certificates in chain history builder (13de17a)
• cardano-services: drep_inactivity renamed to drep_activity (9501b18)
• cardano-services: min_committee_size renamed to committee_min_size (342bb3c)
• cardano-services: new constitution proposal representation in db sync chain sync provider (c2bb9cb)
• cardano-services: use a single QueryRunner/connection for getAssets (53f678b)
• cardano-services: use correct stake key deregistration certificates deposit value (a0a2ead)
• core: decentralizationParameter was removed in babbage (808d8c9)
• e2e: local-network cardano-node download url (c024840)
• handle bigint in innerError data (447b75d)
• produced coins error data is present only for ValueNotConserved (e01a30c)

Code Refactoring

• adapt to ogmios 6 changes (e9c5692), closes /github.com/input-output-hk/cardano-js-sdk/pull/927#discussion_r1352081210
• remove OgmiosTxSubmitProvider (8c56c5e)

0.28.14 (2024-07-25)

Features

• add web socket based network info provider (7c47ce0)

Bug Fixes

• increase number of db connections in pool for asset provider (adcb643)

0.28.13 (2024-07-22)

Note: Version bump only for package @cardano-sdk/cardano-services

0.28.12 (2024-07-11)

Bug Fixes

• cardano-services: add workaround for db-sync not projecting epoch 0 to db sync epoch monitor (b792354)

0.28.11 (2024-07-10)

Bug Fixes

• cardano-services: improve type orm provider health check (c3c662b)

0.28.10 (2024-06-26)

Bug Fixes

• cardano-services: negative stake key de-registration certificate deposit (d52b084)

0.28.9 (2024-06-20)

Note: Version bump only for package @cardano-sdk/cardano-services

0.28.8 (2024-06-18)

Note: Version bump only for package @cardano-sdk/cardano-services

0.28.7 (2024-06-17)

Note: Version bump only for package @cardano-sdk/cardano-services

0.28.6 (2024-06-14)

Note: Version bump only for package @cardano-sdk/cardano-services

0.28.5 (2024-06-05)

Features

• cardano-services: chain history provider now also returns reference scripts on outputs (8b0731d)

0.28.4 (2024-05-20)

Features

• cardano-services: implement new fuzzy search options (006ecf8)
• cardano-services: remove check on asset name when fetching nft metadata (ef562b2)

Bug Fixes

• cardano-services: release query runner after query execution (37c1887)
• cardano-services: stake pool fuzzy search empty result (aff2cdd)
• cardano-services: use correct asset limit pagination for typeorm asset provider (8c13737)
• increase the size of pledge column of stake pool rewards table (988f9ae)

0.28.3 (2024-05-02)

Bug Fixes

• cardano-services: correct mapping of chain history redeemer purpose (b27bcac)

0.28.2 (2024-04-26)

Features

• cardano-services: implement location and distance new options in stake pools fuzzy search (8deeed7)

Bug Fixes

• add needed params in the docker composer file to activate batch pool delisting from smash server (22eb99d)
• cardano-services: ensure only leader and member rewards are used to compute stake pool rewards (b5805fc)

0.28.1 (2024-04-23)

Features

• use publicly available SMASH docker image (e29cc9c)

0.28.0 (2024-04-15)

⚠ BREAKING CHANGES

• upgrade cardano-services, cardano-services-client, e2e and util-dev packages to use version 0.28.0 of Axios

Features

• optimize projector to not write irrelevant blocks (132a9f6)

Bug Fixes

• cardano-services: address projection now applies store operators in correct order (2178cda)
• cardano-services: emergency fix for lw-10209 (abbf5fe)
• the projection now always stores blocks when it reaches tip - k (ba01291)

Miscellaneous Chores

• upgrade Axios version to 0.28.0 (59fcd06)

0.27.1 (2024-04-03)

Note: Version bump only for package @cardano-sdk/cardano-services

0.27.0 (2024-03-26)

⚠ BREAKING CHANGES

• cardnao-services: txSubmitApiProvider can now optionally take an axios adapter in its constructor

Features

• add fuzzy search on stake pool metadata (34446ac)
• add sort by ticker to stake pool search (2168d9e)
• cardnao-services: txSubmitApiProvider can now optionally take an axios adapter in its constructor (afcc82c)

0.26.6 (2024-03-12)

Bug Fixes

• cardano-services: phase-2 failure tx mapper (320cd41)

0.26.5 (2024-02-29)

Note: Version bump only for package @cardano-sdk/cardano-services

0.26.4 (2024-02-28)

Note: Version bump only for package @cardano-sdk/cardano-services

0.26.3 (2024-02-23)

Bug Fixes

• cardano-services: cardano-submit-api parameters typo (580ae98)

0.26.2 (2024-02-12)

Features

• cardano-services: add an explicit option for tx-submit provider handle validation (01938a2)

Bug Fixes

• core: update isValidHandle RegExp to match ADA Handle rules (78f7f35)

0.26.1 (2024-02-08)

Note: Version bump only for package @cardano-sdk/cardano-services

0.26.0 (2024-02-07)

⚠ BREAKING CHANGES

• add and implement new stake pool sorting options

Features

• add and implement new stake pool sorting options (bcc5e80)
• cardano-services: resolve collateralReturn property (98291b5)

Bug Fixes

• cardano-services: change log pattern match (d1286b7)

0.25.4 (2024-02-02)

Note: Version bump only for package @cardano-sdk/cardano-services

0.25.3 (2024-02-02)

Note: Version bump only for package @cardano-sdk/cardano-services

0.25.2 (2024-01-31)

Note: Version bump only for package @cardano-sdk/cardano-services

0.25.1 (2024-01-25)

Note: Version bump only for package @cardano-sdk/cardano-services

0.25.0 (2024-01-17)

⚠ BREAKING CHANGES

• add retry configuration to store stake pool metadata job

Features

• add retry configuration to store stake pool metadata job (90c4663)

Bug Fixes

• cardano-services: use pgboss.archive table to check computed epoch rewards (b25d151)

0.24.5 (2024-01-05)

Note: Version bump only for package @cardano-sdk/cardano-services

0.24.4 (2023-12-21)

Note: Version bump only for package @cardano-sdk/cardano-services

0.24.3 (2023-12-20)

Note: Version bump only for package @cardano-sdk/cardano-services

0.24.2 (2023-12-14)

Features

• cardano-sevices: allow api compatible version requests (14184e2)
• include minted assets in cip67 mapper to ensure minted assets can be collected in withHandles mapper (8e1b834)
• update Handle entity and HandleStore to save parent handles (3fa3920)

0.24.1 (2023-12-12)

Note: Version bump only for package @cardano-sdk/cardano-services

0.24.0 (2023-12-07)

⚠ BREAKING CHANGES

• bump stake pool provider api version to 1.1.0

Bug Fixes

• make type orm stake pool provider back compatible (b007175)

0.23.1 (2023-12-04)

Note: Version bump only for package @cardano-sdk/cardano-services

0.23.0 (2023-11-29)

⚠ BREAKING CHANGES

• stake registration and deregistration certificates now take a Credential instead of key hash

Features

• add support for only updating outdated pool metrics at a given interval (64f67d6)
• cardano-services: implement schedules and added stakepool delist worker schedule (b30eb6b)
• cardano-services: implement tx submit api (f76ebdd)
• cardano-services: integrate the stake pool rewards store in the projector (501174c)
• cardano-services: update NFT metadata and Asset test with Asset db (27b4323)
• create PoolDelistedEntity and database migration (650bef2)
• implement ros in typeorm stake pool provider (be83024)
• projection-typeorm: add stake pool rewards store (bab242b)
• stake registration and deregistration certificates now take a Credential instead of key hash (49612f0)
• update cli.test to work with Asset db (7b5265e)

Bug Fixes

• cardano-services: asset provider can be started with POSTGRES_HOST (1603cfd)
• cardano-services: return active stake from previous epoch insted (12fa427)

0.22.0 (2023-10-19)

⚠ BREAKING CHANGES

• simplify StabilityWindowBuffer interface to just 'getBlock'

• Bootstrap.fromCardanoNode now requires Tip observable parameter

Features

• do not write to stability window buffer til volatile (b2244ea)

0.21.1 (2023-10-12)

Features

• cardano-services: add Asset projection to prepareTypeOrmProjection (129dd35)

0.21.0 (2023-10-09)

⚠ BREAKING CHANGES

• core package no longer exports the CML types

Features

• core package no longer exports the CML types (51545ed)

0.20.0 (2023-09-29)

⚠ BREAKING CHANGES

• cardano-services: StakePoolHttpService interface changed

Features

• cardano-services: added optional metadata fetch feature from SMASH server (54a4f5e)

0.19.0 (2023-09-20)

⚠ BREAKING CHANGES

• make withHandles 'logger' argument required
• withHandles now requires WithCIP67 props in
• remove the CML serialization code from core package
• remove AssetInfo.history and AssetInfo.mintOrBurnCount
• convert tokens.quantity column to numeric
• renamed field handle to handleResolutions
• hoist metadatumToCip25 to NftMetadata.fromMetadatum
• incompatible with previous revisions of cardano-services

• rename utxo and transactions PouchDB stores
• update type of Tx.witness.redeemers
• update type of Tx.witness.datums
• update type of TxOut.datum
• remove Cardano.Datum type

fix(cardano-services): correct chain history openApi endpoints path url to match version

Features

• add address projection (416e5f5)
• add NFT metadata projection (91fe7df)
• cardano-services: add HandleMetadata to handle projection (233ed70)
• cardano-services: create typeorm nft-metadata service (72f6c1b)
• cardano-services: create TypeormAssetProvider (aaf133b)
• cardano-services: resolve default handle, image, pfp and bg (9c446ac)
• cardano-services: update handle projector to project 'default' columns (903faf2)
• remove the CML serialization code from core package (62f4252)
• update core types with deserialized PlutusData (d8cc93b)

Bug Fixes

• cardano-services: do not return datum hash for TxOut with inline datum (8928869)
• cardano-services: return 0 for stake pool status (6674b77)
• convert tokens.quantity column to numeric (31b0f0a)
• correct cip68 handle name (without label) (1711969)

Code Refactoring

• hoist metadatumToCip25 to NftMetadata.fromMetadatum (c36d7ef)
• make withHandles 'logger' argument required (2267689)
• remove AssetInfo.history and AssetInfo.mintOrBurnCount (4c0a7ee)
• renamed field handle to handleResolutions (8b3296e)

0.18.0 (2023-09-12)

⚠ BREAKING CHANGES

• include API version in HTTP service URL scheme

Features

• cardano-services: introduce /live endpoint on HTTP server (d2d6c6a)
• cardano-services: recognizes a pgboss locked state as a recoverable error (af53c8e)
• cardano-services: versionPathFromSpec util for embedding OpenApi version in URLs (2468c57)
• include API version in HTTP service URL scheme (3c10d33)
• only validate API responses in test and dev env (797dfd3)

Bug Fixes

• cardano-services: improve /ready endpoint (04b33a9)
• cardano-services: missing OpenAPI models and express configuration (db9db30)
• cardano-services: stake pool metadaservice correctly return undefined (471d272)
• cardano-services: stop DbSyncProvider proxying db-sync health (88a172d)

0.17.0 (2023-08-29)

⚠ BREAKING CHANGES

• added protocol parameters and updated cost model core type to match CDDL specification

Features

• added protocol parameters and updated cost model core type to match CDDL specification (6576eb9)

0.16.1 (2023-08-21)

Note: Version bump only for package @cardano-sdk/cardano-services

0.16.0 (2023-08-15)

⚠ BREAKING CHANGES

• add HandleProvider.getPolicyIds and utilize it in PersonalWallet also, handles$ resolvedAt is now only set via hydration (provider)
• updated MIR certificate interface to match the CDDL specification

Features

• add a buffer after reading blocks from ogmios (0095c80)
• add HandleProvider.getPolicyIds and utilize it in PersonalWallet also, handles$ resolvedAt is now only set via hydration (provider) (af6a8d0)
• cardano-service: add http service method to attach all the provider routes at once (c8c02d0)
• cardano-services: use prepared statement for the get ledger tip query (6d4d04b)
• updated MIR certificate interface to match the CDDL specification (03d5079)

Bug Fixes

• cardano-services: add get policy ids path/method to handle http service (04c1347)

0.15.0 (2023-08-11)

⚠ BREAKING CHANGES

• EpochRewards renamed to Reward

• The pool the stake address was delegated to when the reward is earned is now included in the EpochRewards (Will be null for payments from the treasury or the reserves)
• Reward no longer coalesce rewards from the same epoch

Features

• cardano-services: add exit at block no argument to projector (ac5b2bc)
• epoch rewards now includes the pool id of the pool that generated the reward (96fd72b)

0.14.8 (2023-07-31)

Bug Fixes

• cardano-services: added pledgeMet filter to TypeormStakePoolProvider (85a4839)
• cardano-services: added wildcard search by 'name' and 'ticker' in TypeormStakePoolProvider (cef44ba)
• cardano-services: excluded 'cost' from nullsInSort in TypeormStakePoolProvider (839aa5d)
• cardano-services: switched to case-insensitive sort by 'name' in TypeormStakePoolProvider (738a82d)
• cardano-services: updated table names for 'cost' and 'name' in queries of TypeormStakePoolProvider (dd3acbe)

0.14.7 (2023-07-26)

Bug Fixes

• cardano-services: add metadata entity to typeorm stake pool provider data source (4232194)
• cardano-services: fix docker compose to forward policy id env var to provider server (0b8784c)

0.14.6 (2023-07-17)

Bug Fixes

• cardano-services: add pool metrics entity as dependency for stake-pool projection (8c86f1b)
• update type of pool registration cost and pledge to numeric (bf86ec1)

0.14.5 (2023-07-13)

Features

• cardano-services: add cli parameter to chose the handle provider (0d7d423)

0.14.4 (2023-07-04)

Note: Version bump only for package @cardano-sdk/cardano-services

0.14.3 (2023-07-03)

Note: Version bump only for package @cardano-sdk/cardano-services

0.14.2 (2023-06-29)

Note: Version bump only for package @cardano-sdk/cardano-services

0.14.1 (2023-06-29)

Bug Fixes

• cardano-services: don't unsubscribe from projection on health timeout (5d7e98b)
• cardano-services: fix dns resolution twice in a row (ef42389)
• util: add ServerNotReady to list of connection errors (c7faf01)

0.14.0 (2023-06-28)

⚠ BREAKING CHANGES

• revert inclusion of version in the HttpProvider interface

Features

• adds cardanoAddress type in HandleResolution interface (2ee31c9)
• cardano-services: make cli able to read handle policy ids from file (ac2aa7f)
• implement verification and presubmission checks on handles in OgmiosTxProvider (0f18042)

Bug Fixes

• revert inclusion of version in the HttpProvider interface (3f50013)

0.13.3 (2023-06-23)

Features

• add API and software version HTTP headers (2e9664f)

0.13.2 (2023-06-20)

Features

• cardano-services: add typeorm handle provider and http handle service (78d69ec)
• cardano-services: cache asset info and nft metadata (43fd02f)
• cardano-services: improves get entities util to handle entities dependencies (efc11e8)
• cardano-services: improves the error middleware to log unknown errors (63e58ca)
• cardano-services: increase details in asset not found error (3967cb3)

Bug Fixes

• cardano-service: fix query text in query time log line (8a6a5e6)
• cardano-services: add postgres connection timeout (ad8388e)

0.13.1 (2023-06-13)

Note: Version bump only for package @cardano-sdk/cardano-services

0.13.0 (2023-06-12)

⚠ BREAKING CHANGES

• cardano-services: rm projector postgres cli/env suffix

Features

• add handle projector service (448b2a0)

Bug Fixes

• cardano-services: postgres ssl option resolution (de6168c)

Code Refactoring

• cardano-services: rm projector postgres cli/env suffix (fe52d91)

0.12.1 (2023-06-06)

Note: Version bump only for package @cardano-sdk/cardano-services

0.12.0 (2023-06-05)

⚠ BREAKING CHANGES

• hoist Cardano.Percent to util package
• make stake pool metrics an optional property to handle activating pools
• • rename rewardsHistoryLimit stake pool search arg to apyEpochsBackLimit
• • remove epochRewards and type StakePoolEpochRewards

• remove transactions and type StakePoolTransactions

Features

• add handle projection (1d3f4ca)
• add missing pool stats status (6a59a78)
• add stake pool metadata entity relation (99a40b7)
• cardano-services: log CardanoTokenRegistry config on construction (63c8377)
• implement TypeormStakePoolProvider (8afbffd)

Code Refactoring

• hoist Cardano.Percent to util package (e4da0e3)
• make stake pool metrics an optional property to handle activating pools (d33bd07)
• remove unusable fields from StakePool core type (a7aa17f)
• rename rewardsHistoryLimit (05ccdc6)

0.11.4 (2023-06-01)

Features

• cardano-services: add stake pools metrics computation job (3462595)

0.11.3 (2023-05-24)

Features

• cardano-services: executes get seestes queries in parallel (a966dd4)

0.11.2 (2023-05-22)

Features

• add the the pg-boss worker (561fd50)
• added two new utility functions to extract policy id and asset name from asset id (b4af015)
• cardano-services: improve cli.ts arguments parsing through environment varaibles (3177edb)
• cardano-services: reduce code complexity - add a catch-all logic for stake pool metadata fetch (0fda043)

0.11.1 (2023-05-03)

Bug Fixes

• cardano-services: token metadata core mapping (20d7950)

0.11.0 (2023-05-02)

⚠ BREAKING CHANGES

• • auxiliaryDataHash is now included in the TxBody core type.

• networkId is now included in the TxBody core type.
• auxiliaryData no longer contains the optional hash field.
• auxiliaryData no longer contains the optional body field.

• cardano-services: do not omit additional data from unhealthy health responses
• rename AssetInfo 'quantity' to 'supply'
• cardano-services: remove obsolete NetworkInfo openApi path /network-info/current-wallet-protocol-parameters.
• • TokenMetadata has new mandatory property assetId

• DbSyncAssetProvider constructor requires new DbSyncAssetProviderProp object as first positional argument
• createAssetsService accepts an array of assetIds instead of a single assetId

• cardano-services: give health checks a dedicated db pool

Features

• add CORS headers config in provider server (25010cf)
• added new Transaction class that can convert between CBOR and the Core Tx type (cc9a80c)
• adds the sql queries profiling system (7f972fd)
• cardano-services: add path metrics on server (4b8f157)
• cardano-services: add projector service (5a5b281)
• cardano-services: cache the DB and node healthCheck results (1583ede)
• cardano-services: changes stake pool search provider to not repeat on going queries (8162246)
• cardano-services: configurable pgpool size (3eb3250)
• cardano-services: do not omit additional data from unhealthy health responses (5d83da2)
• cardano-services: give health checks a dedicated db pool (4729889)
• cardano-services: ledgerTip query result is now cached (3749f59)
• cardano-services: log all queries with execution time (3876b7f)
• cardano-services: metadata fetching logic (3647598)
• cardano-services: optimizes get assets queries (7aebf26)
• cardano-services: optimizes the query to get the ledger tip (a81b013)
• cardano-services: parametrize pagination queries (61a0d9d)
• cardano-services: use prepared statements for txs by addresses queries (5502fa9)
• expose configurable request timeout (cea5379)
• metrics for sync status (1f081f8)
• ogmios: ogmios TxSubmit client now uses a long-running ws connection (36ee96c)
• support assets fetching by ids (8ed208a)
• transaction body core type now includes the auxiliaryDataHash and networkId fields (8b92b01)

Bug Fixes

• cardano-service: fixes a log called method (4d57718)
• cardano-services: explicitly process.exit(1) on unhandledRejections (aeb0520)
• cardano-services: remove duplicate protocolParams operation id (de22def)
• cardano-services: stake-pool APY sorted search no longer returns error if APY is disabled (f81d6c0)
• circular deps check in CI (070f5e9)
• tx metadata memory leak (a5dc8ec)

Code Refactoring

• rename AssetInfo 'quantity' to 'supply' (6e28df4)

0.10.0 (2023-03-13)

⚠ BREAKING CHANGES

• cardano-services: rename http-server to provider-server
• core type for address string reprensetation 'Address' renamed to PaymentAddress

Features

• add inputSource in transactions (7ed99d5)
• adds caching stake pools metric from blockfrost (d2de0a4)
• cardano-services: HTTP server /ready endpoint (e613306)
• cardano-services: support disabling stake pool APY metric, for performance benefits (18e1dfb)
• rewards history limit default (8c32be8)
• util-dev: add DockerUtil (hoisted from cardano-services tests) (ccb86ab)

Bug Fixes

• cardano-services: fixes how collaterals are handled in stake pools related queries (d4a4158)
• cardano-services: fixes the total ada computation formula (c63df83)
• cardano-services: fixes the type of blocks created and delegats in stake pools search api (b76ed1e)

Code Refactoring

• cardano-services: rename http-server to provider-server (7b58748)
• core type for address string reprensetation 'Address' renamed to PaymentAddress (4287463)

0.9.0 (2023-03-01)

⚠ BREAKING CHANGES

• cardano-services: simplify program args interface
• cardano-services: move API URL, build info, enable metrics into common

Features

• cardano-services: add schema for StakePoolMetrics to OpenAPI spec (959a2f0)
• cardano-services: remove CLI terminal clear (97c5a0c)

Code Refactoring

• cardano-services: move API URL, build info, enable metrics into common (c67e550)
• cardano-services: simplify program args interface (eb6ceb3)

0.8.0 (2023-02-17)

⚠ BREAKING CHANGES

• cardano-services: makes genesis data a dependency for providers which need it
• reworks stake pool epoch rewards fields to be ledger compliant
• • Bip32PublicKey removed from core and replaced by the Bip32PublicKeyHex type from the crypto package.

• Bip32PrivateKey removed from core and replaced by the Bip32PrivateKeyHex type from the crypto package.
• Ed25519PublicKey removed from core and replaced by the Ed25519PublicKeyHex type from the crypto package.
• Ed25519PrivateKey removed from core and replaced by the Ed25519PrivateKeyHex type from the crypto package.
• Ed25519KeyHash removed from core and replaced by the Ed25519KeyHashHex type from the the crypto package.
• Ed25519Signature removed from core and replaced by the Ed25519SignatureHex type from the crypto package.
• Hash32ByteBase16 removed from core and replaced by the Hash32ByteBase16 type from the crypto package.
• Hash28ByteBase16 removed from core and replaced by the Hash28ByteBase16 type from the crypto package.
• The KeyAgent interface now has a new field bip32Ed25519.
• The KeyAgentBase class and all its derived classes (InMemoryKeyAgent, LedgerKeyAgent and TrezorKeyAgent) must now be provided with a Bip32Ed25519 implementation on their constructors.
• Bip32Path type was removed from the key-management package and replaced by the Bip32Path from the crypto package.

• hoist Opaque types, hexBlob, Base64Blob and related utils
• CompactGenesis.slotLength type changed from number to Seconds
• cardano-services: Nested narHash, path and sourceInfo under top level extra property of BUILD_INFO
• • all provider constructors are updated to use standardized form of deps

Features

• cardano-services: adds dev version of mainnet preprod and preview docker compose (107ea57)
• cardano-services: changes the way tx metadatum are read from db, from json to raw bytes (ca9a110)
• cardano-services: include healthCheck response as detail in Provider.Unhealthy errors (16d008d)
• cardano-services: upgrade /meta endpoint (e9c3a5b)
• update CompactGenesis slotLength type to be Seconds (82e63d6)

Bug Fixes

• cardano-service: fixes a division by zero in stake pools query (caa4aac)
• cardano-services: cache TTL validator (012b6c5)
• cardano-services: fixes a bug excluding some pools from queries filtering by pledge meet (9f71a99)
• cardano-services: fixes a bug on stake pool saturation compute also causing a wrong sort (4e66060)
• cardano-services: fixes epoch rewards of stake pool query to have the right number of elements (c7bf65e)
• cardano-services: fixes tx_id format in logged messages (a4116d7)
• cardano-services: makes rewards epoch length the one from genesis for all epochs but current (90880cf)
• cardano-services: stake pool query by metrics results no longer exceedes total count (adceaa2)
• cardano-services: stake pool search cached results now correctly handle rewards history limit (62eefd9)
• fixes a minor bug in stake pool query sort by name (5eb3aa5)
• fixes the computation of apy (6ea2474)
• unmemoize slot epoch calc in core package (2dc6af4)

Performance Improvements

• cardano-services: remove type validations (551ddad)

Code Refactoring

• cardano-services: makes genesis data a dependency for providers which need it (d4c7e24)
• hoist Opaque types, hexBlob, Base64Blob and related utils (391a8f2)
• refactor the SDK to use the new crypto package (3b41320)
• reworks stake pool epoch rewards fields to be ledger compliant (a9ff583)
• standardize provider dependencies (05b37e6)

0.7.0 (2022-12-22)

⚠ BREAKING CHANGES

• Alonzo transaction outputs will now contain a datumHash field, carrying the datum hash digest. However, they will also contain a datum field with the exact same value for backward compatibility reason. In Babbage however, transaction outputs will carry either datum or datumHash depending on the case; and datum will only contain inline datums.
• • replace KeyAgent.networkId with KeyAgent.chainId

• remove CardanoNetworkId type
• rename CardanoNetworkMagic->NetworkMagics
• add 'logger' to KeyAgentDependencies
• setupWallet now requires a Logger

• use titlecase for mainnet/testnet in NetworkId
• • rename redeemer.scriptHash to redeemer.data in core

• change the type from Hash28ByteBase16 to HexBlob

• • BlockSize is now an OpaqueNumber rather than a type alias for number

• BlockNo is now an OpaqueNumber rather than a type alias for number
• EpochNo is now an OpaqueNumber rather than a type alias for number
• Slot is now an OpaqueNumber rather than a type alias for number
• Percentage is now an OpaqueNumber rather than a type alias for number

• rename era-specific types in core
• Even if the value of DB_CACHE_TTL was already interpreted in seconds rather than in minutes (despite the error in the description), it's default value is changed
• rename block types

• CompactBlock -> BlockInfo
• Block -> ExtendedBlockInfo

• hoist ogmiosToCore to ogmios package
• classify TxSubmission errors as variant of CardanoNode error

Features

• add opaque numeric types to core package (9ead8bd)
• added new babbage era types in Transactions and Outputs (0b1f2ff)
• adds projected tip to the db sync based providers's health check response (eb76414)
• cardano-services: synchronizes epoch rollover detected by ledger tip (0de53ae)
• dbSyncUtxoProvider now returns the new Babbage fields in the UTXO when present (82b271b)
• implement ogmiosToCore certificates mapping (aef2e8d)
• rename era-specific types in core (c4955b1)
• replace KeyAgent.networkId with KeyAgent.chainId (e44dee0)

Bug Fixes

• add sideEffects=false to package.json (a1cb8f8)
• cardano-services: asset with no name (34f895f)
• cardano-services: fix possible APY calculation overflow on networks with fast epochs (a226852)
• cardano-services: tx submit provider init (d75b61d)
• ttl validation now uses seconds and no longer minutes as the cache itself (f0eb80f)

Code Refactoring

• change redeemer script hash to data (a24bbb8)
• classify TxSubmission errors as variant of CardanoNode error (234305e)
• use titlecase for mainnet/testnet in NetworkId (252c589)

0.6.0 (2022-11-04)

⚠ BREAKING CHANGES

• cardano-services: support pools ext metadata
• support the complete set of protocol parameters
• make stake pools pagination a required arg
• add pagination in 'transactionsByAddresses'
• cardano-services: nftMetadataService returns null instead of
• input-selection: renamed cip2 package to input-selection
• hoist Cardano.util.{deserializeTx,metadatum}
• rework TxSubmitProvider to submit transactions as hex string instead of Buffer
• rework all provider signatures args from positional to a single object
• convert boolean args to support ENV counterparts, parse as booleans
• hoist hexString utils to util package

Features

• add pagination in 'transactionsByAddresses' (fc88afa)
• cardano-services: Add '/meta' endpoint for deployment information (872bf9c)
• cardano-services: add support for using a stub token metadata service (6975156)
• cardano-services: adds log of incoming requests (f302f9c)
• cardano-services: enhance metrics endpoint (0fdbb85)
• cardano-services: make search stake pool case insensitive (7fb42a7)
• cardano-services: nftMetadataService returns null instead of (7b87d1d)
• cardano-services: rewardAccounts limitation (8ca6917)
• cardano-services: support pools ext metadata (0ac5451)
• create common mock server util (53bd4f7)
• improve db health check query (1595350)
• make stake pools pagination a required arg (6cf8206)
• support the complete set of protocol parameters (46d7aa9)

Bug Fixes

• cardano-services: cache total pools count (fbd9ac5)
• cardano-services: correct interval type and only clear if defined (a23f384)
• cardano-services: correct spelling mistakes (a7b098f)
• cardano-services: filter available rewards balance by spendable_epoch>=tip (4da325a)
• cardano-services: fix netinf prov possibly causing unhandled rejection on early called shutdown (1107d4b)
• cardano-services: fix some typos (303497d)
• cardano-services: fixed an issue that was causing live stake and saturation values to be calculated incorrectly (5e714e2)
• cardano-services: fixed an issue that was causing pool saturation to be always 0 (82cab4d)
• cardano-services: fixed some not correctly exported symbols (8c8950a)
• cardano-services: handle CardanoTokenRegistry errors (32a9b1f)
• cardano-services: hash/update id model types (142098c)
• cardano-services: total rewards is now being calculated correctly for current epoch (6d4cf6c)
• cardano-services: wrong source tx input id (f6efe3b)
• convert boolean args to support ENV counterparts, parse as booleans (d14bd9d)
• core: custom errors no longer hide inner error details (9d0f51f)
• remove nullability of Protocol Parameters (f75859d)
• rollback ProtocolParametersRequiredByWallet type (0cd8877)

Performance Improvements

• cardano-services: order by block.id in ledger tip queries (b985d3f)

Code Refactoring

• hoist Cardano.util.{deserializeTx,metadatum} (a1d0754)
• hoist hexString utils to util package (0c99d9d)
• input-selection: renamed cip2 package to input-selection (f4d6632)
• rework all provider signatures args from positional to a single object (dee30b5)
• rework TxSubmitProvider to submit transactions as hex string instead of Buffer (032a1b7)

0.5.0 (2022-08-30)

⚠ BREAKING CHANGES

• consolidate cli & run entrypoints
• rm TxAlonzo.implicitCoin
• removed Ogmios schema package dependency
• replace NetworkInfoProvider.timeSettings with eraSummaries
• logger is now required
• contextLogger support
• cardano-services: make interface properties name more specific

Features

• cardano-services: add db-sync asset http service (fb254e5)
• cardano-services: add db-sync asset provider (9763c59)
• cardano-services: add support for secure db connection (380a633)
• cardano-services: cache stake pool queries (3b65972)
• cardano-services: root health check endpoint (aff7c6a)
• cardano-services: uniform ttl parameter of in memory cache methods to be expressed in seconds (670d0c1)
• implement tx submit worker error handling (55bc023)
• ogmios cardano node DNS resolution (d132c9f)
• replace NetworkInfoProvider.timeSettings with eraSummaries (58f6fc7)

Bug Fixes

• cardano-services: empty array and default condition for identifier filters - search stakePool (43b8481)
• cardano-services: fixed a division by 0 on APY calculation if epoch lenght is less than 1 day (bb041cf)
• cardano-services: initialize CardanoNode (3c3a5ee)
• cardano-services: make HTTP services depend on provider interfaces, rather than classes (1fef381)
• malformed string and add missing service to Docker defaults (b40edf6)

Performance Improvements

• improve lovelace supply queries (7964a2f)

Code Refactoring

• cardano-services: make interface properties name more specific (854408d)
• consolidate cli & run entrypoints (1452bfb)
• contextLogger support (6d5da8e)
• logger is now required (cc82bc2)
• removed Ogmios schema package dependency (4ed2408)
• rm TxAlonzo.implicitCoin (167d205)

0.4.0 (2022-07-25)

⚠ BREAKING CHANGES

• cardano-services: make interface properties name more specific
• cardano-services: remove static create
• cardano-services: service improvements

Features

• add new apy sort field to stake pools (161ccd8)
• cardano-services: add db-sync asset http service (fb254e5)
• cardano-services: add db-sync asset provider (9763c59)
• cardano-services: add DbSyncNftMetadataService (f667c0a)
• cardano-services: add token metadata provider (040e0eb)
• cardano-services: implements rabbitmq new interface (a880367)
• cardano-services: service discovery via DNS (4d4dd36)
• cardano-services: support loading secrets in run.ts for compatibility with existing pattern (b9ece18)
• sort stake pools by fixed cost (6e1d6e4)
• support any network by fetching time settings from the node (08d9ed2)

Bug Fixes

• allow pool relay nullable fields in open api validation (e7fe121)
• cardano-services: add missing ENV to run.ts (13f8698)
• cardano-services: make HTTP services depend on provider interfaces, rather than classes (1fef381)
• cardano-services: stake pool healthcheck (90e84ee)

Performance Improvements

• improve lovelace supply queries (7964a2f)

Code Refactoring

• cardano-services: make interface properties name more specific (854408d)
• cardano-services: remove static create (7eddc2b)
• cardano-services: service improvements (6eda4aa)

0.3.0 (2022-06-24)

⚠ BREAKING CHANGES

• move stakePoolStats from wallet provider to stake pool provider
• rename StakePoolSearchProvider to StakePoolProvider
• cardano-services: compress the multiple entrypoints into a single top-level set
• cardano-services: make TxSubmitHttpServer compatible with createHttpProvider
• cardano-graphql-services: remove graphql concerns from services package, rename

Features

• add ChainHistory http provider (64aa7ae)
• add sort stake pools by saturation (#270) (2a9abff)
• add totalResultCount to StakePoolSearch response (4265f6a)
• add utxo http provider (a55fcdb)
• cardano-services: add HttpServer.sendJSON (c60bcf9)
• cardano-services: add pool rewards to stake pool search (f2ed680)
• cardano-services: add query for stake pool epoch rewards (7417896)
• cardano-services: add sort by order & field (dd80375)
• cardano-services: add stake pools metrics and open api validation (2c010ee)
• cardano-services: added call chain of close method from HttpServer to HttpService to Provider (aa44bdf)
• cardano-services: adds tx submission via rabbitmq load test (5f6a160)
• cardano-services: create NetworkInfo service (b003d49)
• cardano-services: integrated in CLIs TxSubmitWorker from @cardano-sdk/rabbitmq (56adf12)
• cardano-services: log services HTTP server is using (7da7802)
• cardano-services: run multiple services from a single HTTP server (35770e0)
• cardano-services: stake pool search http server (c3dd013)
• create InMemoryCache (a2bfcc6)
• rewards data (5ce2ff0)

Bug Fixes

• cardano-services: added @cardano-sdk/rabbitmq dependency (f561a1e)
• cardano-services: align exit codes on error (ce8464f)
• cardano-services: change stake pool search response body data to match provider method (d83d4af)
• cardano-services: fix findPoolEpoch rewards, add rounding (e386211)
• cardano-services: fix findPoolsOwners query (619b2b8)
• cardano-services: fix pools_delegated on pledgeMet query (a68771a)
• cardano-services: fixed bin entry in package.json (de9b89e)
• cardano-services: health check api can now be called in get as well (b68e90c)
• cardano-services: resolve package.json path when cli is run with ts-node (9c77218)
• cardano-services: updates NetworkInfo OpenAPI spec to align with refactor (626e8be)
• division by zero error at pool rewards query (#280) (116ed12)
• use ordering within UTxO query for reproducible results (889b437)

Performance Improvements

• cardano-services: enhance cache get method (99b2b9d)

Miscellaneous Chores

• cardano-graphql-services: remove graphql concerns from services package, rename (71a939b)

Code Refactoring

• cardano-services: compress the multiple entrypoints into a single top-level set (4c3c975)
• cardano-services: make TxSubmitHttpServer compatible with createHttpProvider (131f234)
• move stakePoolStats from wallet provider to stake pool provider (52d71a7)
• rename StakePoolSearchProvider to StakePoolProvider (b432103)