Ogmios

Ogmios can be installed and run using several methods. The documentation provides guidance on:

• Building from source: Compiling and installing Ogmios directly.
• Docker: Running Ogmios as a containerized service.
• Configuration: Detailed options and configuration settings required to run the Ogmios service effectively.

Ogmios is a webserver that acts as a proxy for communicating with a cardano-node. It establishes a node-to-client connection with a Cardano node upon request and forwards messages between the client application and the node.

Key characteristics:

• Protocol Translation: It translates the statically typed Cardano node protocols into JSON for client consumption.
• Monitoring: It provides built-in monitoring capabilities.
• Dual Interface: It embeds both an HTTP server and a WebSocket server.

Ogmios acts as a lightweight bridge interface for cardano-node, providing an HTTP / WebSocket API via JSON+RPC-2.0.

Key capabilities include:

• Fast block synchronization from Cardano networks.
• Transaction submission with enhanced error messages.
• Plutus script execution unit evaluation.
• Local mempool monitoring.
• State queries for Network and Ledger information.
• Dual WebSocket/HTTP support.
• Structured JSON logging and Health monitoring with runtime/application statistics.

The @cardano-ogmios/client package provides a natural interface for ECMAScript integrations with Ogmios. It includes:

• Abstraction of Websocket management.
• Custom error mapping.
• Integration with the @cardano-ogmios/schema package, which is imported and exported as Schema.

Ogmios supports a variety of client implementations across different programming languages. While this documentation focuses on the official TypeScript client, community-maintained clients are available for the following languages:

• JavaScript
• TypeScript (Official/Primary)
• Go (ogmigo)
• Kotlin (kogmios)
• Java (ogmios-java-client)
• Python (ogmios-python)
• Elixir (xogmios)
• C++ (libogmios)
• C# (OgmiosDotnet)

The Cardano Ogmios TypeScript ecosystem is distributed as a Yarn Workspace containing three distinct npm packages. Depending on your needs, you can install and use the following:

• @cardano-ogmios/client: The primary client for interacting with Ogmios.
• @cardano-ogmios/schema: Contains the TypeScript schemas and type definitions used by the client and server.
• @cardano-ogmios/repl: A REPL (Read-Eval-Print Loop) for interactive Ogmios command execution.

To use these in your own project, install them via npm or yarn from the npm registry.

npm install @cardano-ogmios/client @cardano-ogmios/schema @cardano-ogmios/repl

Ogmios is a lightweight bridge interface for cardano-node. It provides a WebSockets API that allows local clients to interact with Cardano's Ouroboros mini-protocols using JSON/RPC.

Essentially, Ogmios acts as a translator: it speaks the native communication methods required by a Cardano node (which are primarily implemented in Haskell) and translates them into WebSockets and JSON, which are more accessible to the majority of application developers. This allows you to build applications in languages other than Haskell while still maintaining a low-level, direct interface to the blockchain.

The ouroboros-network-ogmios module is a utility layer designed to reduce boilerplate when interacting with the Ouroboros mini-protocols used by Cardano nodes.

It is important to note that this module does not implement the protocol logic itself. Instead, it provides a structural foundation that allows application logic to focus on specific client implementations, such as:

• chain-sync: For synchronizing with the blockchain state.
• transaction submission: For broadcasting transactions to the network.
• state query: For querying the current state of the node.

Use this module when you want to decouple the repetitive setup required for Ouroboros protocols from your core application logic.

If a task can be performed using a Cardano node, it can be performed using Ogmios. Common use cases include:

• Wallets
• Block Explorers
• Smart-contract application backends
• Chain indexers and event listeners