mlabs-haskell / ogmios

❇️ A WebSocket JSON/RPC bridge for Cardano
https://ogmios.dev
Mozilla Public License 2.0
2 stars 3 forks source link


ogmios

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 Query | Result --- | --- `blockHeight` | The chain's highest block number. `chainTip` | The chain's current tip. `currentEpoch` | The current epoch of the ledger. `currentProtocolParameters` | The current protocol parameters. `delegationsAndRewards` | Current delegation settings and rewards of given reward accounts. `eraStart` | The information regarding the beginning of the current era. `eraSummaries` | Era bounds and slotting parameters details, required for proper slot arithmetic. `genesisConfig` | Get a compact version of the era's genesis configuration. `ledgerTip` | The most recent block tip known of the ledger. `nonMyopicMemberRewards` | Non-myopic member rewards for each pool. Used in ranking. `poolIds` | The list of all pool identifiers currently registered and active. `poolParameters` | Stake pool parameters submitted with registration certificates. `poolsRanking` | Retrieve stake pools ranking (a.k.a desirabilities). `proposedProtocolParameters` | The last update proposal w.r.t. protocol parameters, if any. `rewardsProvenance'` | Get details about rewards calculation for the ongoing epoch. `stakeDistribution` | Distribution of the stake across all known stake pools. `systemStart` | The chain's start time (UTC). `utxo` | Current UTXO, possibly filtered by output reference.
↗️
Structured JSON logging↗️
Health monitoring, with runtime and application statistics↗️

Roadmap

See projects 🎯.

Preview

Ogmios TypeScript Client Preview

Clients / SDKs

Logo:TypeScript
TypeScript
Logo:Go
Go
Logo:Kotlin
Kotlin
Logo:Java
Java

Sponsors 💖


:book: User Manual | :triangular_ruler: Contributing | :floppy_disk: Changelog | DiscordDiscord (#ogmios) | Twitter Twitter (@_KtorZ_)

Need more information? Have a look at the Frequently Asked Questions.

license=MPL-2.0