@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

[5.3.0] - 2022-05-07

Added

• In the Local-Tx-Monitor protocol, NextTx can now take an (optional) extra argument { "fields": "all" } to instrument the server in returning not only a transaction id in NextTxResponse, but a full transaction object. See #190.

• Transaction JSON objects from all eras now contains an extra field raw, which represents the raw serialized transaction (CBOR) as a base64-encoded text string. This is the case of the chain-sync protocol, but also for the tx-monitor protocol. The field is however absent in the ogmios.v1:compact mode. See #190.

• Transaction JSON objects from the Alonzo era now contains an extra field inputSource which a string set to either inputs or collaterals. This captures the fact that since the introduction of Plutus scripts in Alonzo, some transactions may be recorded as failed transactions in the ledger. Those transactions do not successfully spend their inputs but instead, consume their collaterals as an input source to compensate block validators for their work.

Changed

• The complete [API reference][] for the server is available in a new form at: https://ogmios.dev/api/. This should make the various protocol messages easier to explore and provide a less awkward visualization of the server API than the previous TypeScript documentation. The old TypeScript documentation remains however available at: https://ogmios.dev/typescript/api/.

• Upgrade internal dependencies to cardano-node@1.34.1

• Fixed the supervisor script for the cardano-node-ogmios Docker image, which would wrongly ignore signals sent from the Docker daemon (e.g. docker container stop ...). See #168

• ![TypeScript][] The tx-submission client now only creates a single event listener to interact with the server. This solves the Node.js warning "possible memory leak detected" when firing many submission requests at once (and going beyond the internal default maxNumberOfListeners set by node.js on event emitters). See #197.

• ![TypeScript][] The options passed to the WebSocket constructors are now ignored on the browser, since they aren't supported and were causing the constructor to "crash". See #194.

• ![TypeScript][] ⚠️ Some schema type interface renaming:

  • Tx → TxByron
  • BlockBodyShelley → TxShelley
  • BlockBodyAllegra → TxAllegra
  • BlockBodyMary → TxMary
  • BlockBodyAlonzo → TxAlonzo

Removed

N/A

---

---