Ogmios is a lightweight bridge interface for cardano-node. It provides an HTTP / WebSocket API that enables applications to interact with a local cardano-node via JSON+RPC-2.0.
| Ogmios | Cardano-node (mainnet, preview, preprod) |
|---|---|
v6.11.* |
10.1.2, 10.1.3, 10.1.4 |
v6.10.* |
10.1.2, 10.1.3, 10.1.4 |
v6.9.* |
10.1.2, 10.1.3 |
v6.8.*<
8000
/td>
| 9.2.0, 9.1.1 |
v6.7.* |
9.2.0, 9.1.1 |
Using Homebrew:
brew tap CardanoSolutions/formulas
brew install ogmios
See our Ogmios client starter kit or jump right into the user manual.
| Fast synchronization of blocks from the Cardano network(s) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Transaction submission with enhanced error messages | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Evaluation of Plutus script execution units | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Local mempool monitoring | |||||||||||||||||||||||||||||||||||||||||||||||||||
State queriesNetwork
Ledger
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| Dual WebSocket/HTTP support | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Structured JSON logging | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Health monitoring, with runtime and application statistics |
Tip
Test vectors that cover every part of the protocol are available here. Use them without moderation for a smooth integration!
The project keeps a changelog 💾 in which all past changes and recent-but-not-yet-released changes can be seen. Changes in the changelog have been implemented and are available in latest builds from the master branch.
The github issues & milestones 🎯 list planned tasks that haven't been implemented but have reached enough maturity to be well-defined and scoped. Milestones have end-dates to give a broad estimate of when it is expected.
Finally, discussions 💡 contains ongoing discussions regarding the future of Ogmios, with design decisions still under consideration.
Ogmios provides a language-agnostic API which can be implemented using any WebSocket or HTTP client. If you prefer using a SDK in your favorite language, see below the available clients (maintained by the community):
TypeScript |
Go |
Kotlin |
Java |
Python |
Elixir |
C++ |
C# |
A big thank to all our sponsors 💖.
📖 User Manual
|
📐 Contributing
|
💾 Changelog
|
Discord (#ogmios)
|
Twitter (@_KtorZ_)
Need more information? Have a look at the Frequently Asked Questions.