v6.0.3

Added

• A new transaction submission / evaluation error (code: 3161) returned when a script evaluation goes beyond its allocated budget.

Changed

• Mapped some internal errors to actual predicate failures. Before, Ogmios would simply return an InternalLedgerTypeConversionError with code 3999 in cases where it should have been returning a more meaningful error resulting from either an excessive script evaluation (see new introduced error 3161) or a failed attempt to create a script context for a given transaction.

• Renamed types regarding Metadatum in the TypeScript client to provide more meaningful names.

Removed

• N/A

Tested with

• cardano-node == 8.7.2 (Mainnet, Preprod, Preview, SanchoNet)
• cardano-node == 8.7.3 (Mainnet, Preprod, Preview, SanchoNet)

Details

v6.0.2...v6.0.3

v6.0.2

Added

• N/A

Changed

• Fixed 'preview' showing as 'preprod' (and vice-versa) in error message on start-up when connecting to a wrong test network.

• Fixed parsing of base16-encoded CBOR transaction on ogmios inspect transaction; would wrongly expect an extra singleton object before that.

• Fixes identification of submit/evaluate transaction responses, now using the method field instead of relying on the mirror. Should fix clashes with other requests. (🔨 @mirelon)

Removed

• N/A

Tested with

• cardano-node == 8.7.2 (Mainnet, Preprod, Preview, SanchoNet)
• cardano-node == 8.7.3 (Mainnet, Preprod, Preview, SanchoNet)

Details

v6.0.1...v6.0.2

v6.0.1

Added

• Introduced a new runtime configuration flag --strict-rpc to allow removing the extra 'method' field provided in the server response. While the JSON-RPC specification doesn't explicitly disallow the use of extra fields in the response, some libraries have proven being quite strict in the inputs they accept, resulting in errors when receiving Ogmios' responses. The flag is off by default. 🐛 @szg251 - see #360.

Changed

• Fixed various descriptions and oversights in the JSON specifications (and thus documentation). In particular, the Getting Started section on the website has been slightly reworked to be easier to navigate and to include information about configuring Ogmios. 🔎 @AndrewWestberg

Removed

• N/A

Tested with

• cardano-node == 8.7.2 (Mainnet, Preprod, Preview, SanchoNet)
• cardano-node == 8.7.3 (Mainnet, Preprod, Preview, SanchoNet)

Details

v6.0.0...v6.0.1

v6.0.0

Caution

For those integrating from a previous release candidate (e.g. v6.0.0-rc5), please acknowledge the following (hopefully last) important changes to the API:

• The old format (pre v6.0.0-rc1) for metadata can be recovered on-demand using the --metadata-detailed-schema flag.
• All values are now returned as a map of maps; including in places where there's only lovelace (e.g. fee, total collateral, etc..)

  Old (v6.0.0-rc5)	New (v6.0.0)
  { "lovelace": 123 }	{ "ada": { "lovelace": 123 } }

• The format of redeemer pointers has now changed; redeemers are no longer encoded as plain strings, but as objects. Maps from redeemer pointers to validators have therefore been inlined as associative lists. As follows:

  Old (v6.0.0-rc5)	New (v6.0.0)
  { "publish:2": "a0" }	{ "validator": { "index": 2, "purpose": "publish" }, "redeemer": "a0" }

Added

• Integration with cardano-node==8.7.2 and cardano-ledger-conway==1.11.0.0. It adds (preliminary) support for the Conway era. This support only covers what is currently available in the Cardano node / ledger. However, since the implementation of this era isn't finalized but mostly stable, there's a non-zero chance some of the interface will slightly adjust in the future.

• Ogmios now accept queries via HTTP (POST). Request bodies are the same as those passed to the websocket and so are responses. In fact, most Ogmios queries follow a simple request/response pattern and are therefore well-suited to be run over HTTP. It is a reasonable approach for many queries that aren't stateful (e.g. direct queries via the local-state-query protocol, or simply transactions submission / evaluation).

  Note
  The HTTP server and the WebSocket server are both mounted on the same port. So, it suffices to route HTTP requests through /. The JSON payload is the same.

• Ability to retrieve any genesis configuration (Byron, Shelley, Alonzo or Conway) via the state-query protocol.

• A new flag --metadata-detailed-schema (disabled by default) to control how the server returns JSON metadata. When set, the server will return a JSON description of the encoded data; when omitted, it'll attempt to convert CBOR metadata as plain JSON object, and default to hex-encoded cbor otherwise. See also notes in ADR-017.

• A new command inspect transaction to help with debugging the deserialization of transaction.

• The health now contains an extra network and version. Also, beware that era names are now returned in lowercase (first letter used to be capitalised!).

• sanchonet network to the list of well-known networks.

• arm64 static executables for Linux are now available in the continuous delivery pipeline, and as release artifacts.

• Multi-arch (amd64, arm64) docker images are now also available.

Changed

• The server now return an internalError when an unexpected error occurs in the communication between Ogmios and the node. Before, Ogmios would simply log an exception and no response would be sent back to client applications. Now, clients correctly receive an unsuccessful response with the same id as present in the request. See #346.

• Add an extra promise handler to cope with unexpected websocket disconnections when submitting messages to the server. See #346.

• Escape the word 'constructor' to constr when present as key in metadata, and when not using --metadata-detailed-schema. JavaScript (and thus TypeScript) forbids using that word as an object key.

Changed

Tip

There are still many test vectors available for every element of the Ogmios API. Use them!

• ⚠️ BREAKING-CHANGE ⚠️ Many major changes in the interface. A complete migration guide is available in ADR-017, yet please refer to the API reference for details and exhaustiveness. Many representations have been made easier to parse and field names have been improved (more consistent across the entire API and better self-documented).

• Ogmios will no longer retry connecting to a node that is configured for another network but exit with an non-zero code and a clear error message indicating the network mismatch.

• The default dashboard on localhost has been greatly rework and simplified. It also better handles errors.

• Responses from the server no longer includes raw binary cbor by default. This was the case in particular for transactions. This behavior can be restored by configuring the server with --include-cbor to always include binary version of some specific objects such as transactions. This flag can be declined in more fine-grained flags if necessary:

  • --include-transaction-cbor
  • --include-metadata-cbor
  • --include-script-cbor

  where --include-cbor turns all three flags at once.

Removed

• ⚠️ BREAKING-CHANGE ⚠️ Compact mode is no more. Responses are more compact by default already and it is no longer possible to ask for a compact mode.

• ⚠️ BREAKING-CHANGE ⚠️ Ogmios no longer returns null or empty fields. Where a field's value would be null prior to v6.0.0, Ogmios now simply omit the field altogether. This is also true for most responses that return empty lists as well. All-in-all, please refer to the documentation / JSON-schema in case of doubts (fields that may be omitted are no longer marked as required).

Tested with

• cardano-node == 8.7.2 (Mainnet, Preprod, Preview, SanchoNet)

Details

v5.6.0...v6.0.0

A big thank to all those who provided feedback, reported issues, suggested improvements and contributed to make them happen.

Contributions & acknowledgements

• @AndrewWestberg
• @droark
• @Quantumplation
• @angerman
• @lehins
• @mkazlauskas
• @xray-robot
• @sorki
• @rhyslbw
• @michalrus
• @rdlrt
• @TerminadaPool
• @GrzegorzDrozda

v5.6.0

Added

• Add a new helper function unsafeMetatumAsJSON which converts a detailed metadata schema into plain JavaScript, whenever possible.
  For example:

  { "list": [ { "string": "foo" }, { "int": 42 } ] } → ["foo", 42]

  This should work for any CIP-0025 metadata, and few other formats. Yet it is unsound in the general case since not every on-chain metadata can actually be represented as JavaScript objects.

Changed

• Now targets ES2020.

• Fixed a bug in the JSON parser where coins quantities from all eras prior to Mary would be parsed as Number instead of BigInt. See #301 (:hammer: @mkazlauskas).

Removed

N/A

Details

v5.5.8...v5.6.0

v5.5.8

Added

• Added network's name to the dashboard. See #281 (:bulb: @khwerhahn)

Changed

• Bump internal packages to match cardano-node@1.35.4 dependencies set.

• Bundle the docker image with more recent versions of the cardano-configurations. See #283 (:bug: @nejcr)

• Fix TxMonitorClient's nextTx wrongly throwing an error when called with no argument. The signature of that method has also been reworked slightly to provide better usage at call-site. See #298 (:bug: @Kartiiyer12)

• Add missing required constraints in the JSON schema for Byron witness representation that caused TypeScript types to be generated as optional. See #285 (:bug: @IvayloAndonov)

Removed

N/A

Details

v5.5.7...v5.5.8

v5.5.7

Added

• delegationAndRewards and nonMyopicMemberRewards queries now both accept credentials in the form of bech32 strings as parameters, with the following expected prefixes and semantic (according to CIP-0005):

  • stake (resp. stake_test on test networks) for stake addresses
  • stake_vkh for stake key hash digests
  • script for stake script hash digests

  See also #277 (:bug: @klntsky)

• Allow additionalUtxoSet to be passed as argument in the repl.

Changed

• Fixed additionalUtxoSet being ignored in the TxSubmissionClient of the TypeScript client.

Removed

N/A

Details

v5.5.6...v5.5.7

v5.5.6

Added

• Prometheus metrics exported at /metrics endpoint (:hammer: @sorki)

• Schema definitions are now included in the 📘 API reference. This makes it a little easier to find a specific schema without having to drill into a messages definitions.

Changed

• Fixed network synchronization reporting 0.99999 even when fully synchronized. There was sometimes a possible discrepancy between the ledger internal clock and Ogmios' clock, causing a few seconds of drift time.

• Fixed a couple of data-types with fields parsed as number instead of bigint. See #274 (:bug: @longngn)

  Warning This is technically an internal breaking-change, however it actually comes as a bug fix since this does not change the announced interface in the TypeScript schema (which was correctly indicated 'bigint'). Still, this may cause issues with those using number where there will now be bigint.

• Fixed browser detection for the IsomorphicWebSocket abstraction. See #273 (:hammer: @szist).

Removed

N/A

Details

v5.5.5...v5.5.6

v5.5.5

Added

• Support for the TxMonitor mini-protocol in the REPL.

• Link to a new Java client for Ogmios (:hammer: @edridudi).

Changed

• Fixed parsing of ScriptFailures coming out of the evaluateTx command. Before this patch, the client would simply throw undefined when such an error was encountered. They are now properly transcribed as EvaluateTxError (:bug: @rhyslbw).

• Proof-read and fix documentation typos. See #247 (:blue_book: @HirotoShioi).

Removed

• testnet has been removed from the target networks by the Docker workflow; which means that until further notice, there will be no more Docker images pushed for testnet. However, support for preprod and preview environment has been added (:hammer: @rhyslbw)

Details

v5.5.4...v5.5.5

v5.5.4

Added

• Missing JSON specification (and therefore, documentation) for collectErrors. See #244 (:bug: @AndrewWestberg).

Changed

• Slot lengths are now encoded as floating numbers (double precision) instead of integers (still representing a number of seconds). However, to maintain backward-compatibility, integers value are encoded without decimal, as they used to. #245 (:bug: @klntsky).

• Blocks' properties (header, headerHash, body) are no longer marked as optional in the JSON specification (and consequently, in the TypeScript SDK). #238 (:bug: @MarcelKlammer).

Removed

N/A

Details

v5.5.3...v5.5.4