README.md

Ogmios is a lightweight bridge interface for cardano-node. It offers a WebSocket API that enables local clients to speak Ouroboros' mini-protocols via JSON/RPC.

Features

• Fast synchronization of blocks from the Cardano network(s)
• Transaction submission with enhanced error messages
• Evaluation of Plutus script execution units
• Local mempool monitoring
• Full ledger state query support:
  • blockHeight
  • chainTip
  • currentEpoch
  • currentProtocolParameters
  • delegationsAndRewards
  • eraStart
  • eraSummaries
  • genesisConfig
  • ledgerTip
  • nonMyopicMemberRewards
  • poolIds
  • poolParameters
  • poolsRanking
  • proposedProtocolParameters
  • rewardsProvenance
  • stakeDistribution
  • systemStart
  • utxo
• TypeScript client & REPL
• Structured JSON logging
• Health monitoring, with runtime and application statistics
• Fully documented API with JSON-schema

Preview

Sponsors 💖

---

📖 User Manual | 📐 Contributing | 💾 Changelog