View Source API Reference xogmios v0.8.0

Modules

This is the top level module for Xogmios. It implements functions to be used by client modules that wish to connect with Ogmios.

This module interfaces with the Chain Synchronization protocol.

This module implements a connection with the Ogmios Websocket server for the Chain Synchronization protocol.

This module contains messages for the Chain Synchronization protocol

Convenience module that provides access to all stateless HTTP APIs.

Performs a health check against the Ogmios server's HTTP endpoint. Used primarily to determine if the underlying Cardano node is fully synced.

This module implements a connection with the Ogmios Websocket server for the Mempool protocol.

This module contains messages for the Mempool protocol

This module interfaces with the Mempool protocol for reading transactions as they become available (nextTransaction).

This module interfaces with the State Query protocol.

Stateless HTTP client for State Query protocol.

This module contains messages for the State Query protocol

This module interfaces with the Tx Submission protocol.

Stateless HTTP client for Tx Submission protocol.

This module contains messages for the Tx Submission protocol

Mix Tasks

Generates a new Xogmios client module.