The ogmios from alessandrokonrad

alessandrokonrad / ogmios Goto Github PK

View Code? Open in Web Editor NEW

❇️ A WebSocket JSON/RPC bridge for Cardano

License: Mozilla Public License 2.0

Shell 0.55% JavaScript 0.71% Haskell 70.57% TypeScript 26.84% Nix 0.14% HTML 0.85% Dockerfile 0.35%

ogmios's Introduction

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.