Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor documentation tweaks on Ogmios. #327

Merged
merged 1 commit into from
Sep 26, 2021
Merged

minor documentation tweaks on Ogmios. #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/get-started/ogmios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Get Started with Ogmios
image: ./img/og-developer-portal.png
---

Ogmios is a protocol translation service written in Haskell running on top of cardano-node. Instead of speaking to a Cardano node directly, applications can speak to Ogmios using a language they know, and Ogmios translates it to the node and back to the applications.
**Ogmios** is a lightweight bridge interface for [cardano-node](https://github.com/input-output-hk/cardano-node/). It offers a WebSockets API that enables local clients to speak [Ouroboros' mini-protocols](https://hydra.iohk.io/build/1070091/download/1/network.pdf#chapter.3) via JSON/RPC.

Ogmios doesn’t do much more than what the node itself does. It’s pretty much as low-level as things can get with the Cardano network. For many applications, this is too low in the abstraction layer and they would be better off using higher-level services like [cardano-graphql](https://github.com/input-output-hk/cardano-graphql), [Rosetta](https://www.rosetta-api.org), or [Blockfrost](https://blockfrost.io).

Expand Down Expand Up @@ -98,4 +98,4 @@ JSON response:

## Ogmios documentation

To dive further into Ogmios and how to interact with the Ouroboros mini-protocols, visit [ogmios.dev](https://ogmios.dev/mini-protocols/local-chain-sync/).
To dive further into Ogmios and how to interact with the Ouroboros mini-protocols, visit [ogmios.dev](https://ogmios.dev/mini-protocols).
2 changes: 1 addition & 1 deletion src/data/builder-tools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ const Showcases = [
},
{
title: "Ogmios",
description: "Ogmios offers a JSON-WSP interface through WebSockets.",
description: "Ogmios is a lightweight bridge interface (WebSocket + JSON/RPC) for cardano-node.",
preview: require("./builder-tools/ogmios.png"),
website: "https://ogmios.dev",
getstarted: "/docs/get-started/ogmios",
Expand Down