@cardano-ogmios/client

Cardano Ogmios TypeScript Client Packages - Client

Provides a natural interface for ECMAScript integrations, including abstraction of Websocket management and custom error mapping. The schema package is imported and exported as Schema.

Quick Start

yarn add @cardano-ogmios/client

Build From Source

See instructions in Workspace root

Changelog

[6.13.0] - 2025-06-13

Added

• A new query queryLedgerState/rewardsProvenance which now re-implements and exposes the intermediate rewards calculation. The query name already exists, but the schema is now different. The previous behaviour can be recovered by using the new queryLedgerState/stakePoolsPerformances instead.

Changed

• ⚠️ BREAKING-CHANGE ⚠️: queryLedgerState/dump no longer return a hex-encoded CBOR dump as part of the JSON response, but instead, serialise directly to a specified on-disk location.

• ⚠️ BREAKING-CHANGE ⚠️: queryLedgerState/rewardsProvenance has been renamed to queryLedgerState/stakePoolsPerformances. The schema remains otherwise unchanged.

• ⚠️ BREAKING-CHANGE ⚠️: queryLedgerState/rewardAccountSummaries now returns a list of results instead of a map. While this is technically a breaking change, it is necessary to fix scenarios where a credential exist as both script and verification key and would therefore lead to conflict in the key space. The response is otherwise similar to its previous form.

Removed

N/A