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.

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

Several small content things #53

Merged
merged 5 commits into from
May 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/getting-started/cardano-serialization-lib.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: cardano-serialization-lib
title: Getting Started with Cardano Serialization Lib
sidebar_label: Cardano Serialization Lib
sidebar_label: Serialization Lib
description: Getting Started with Cardano Serialization Lib
image: ./img/og-developer-portal.png
---
Expand Down
101 changes: 101 additions & 0 deletions docs/getting-started/ogmios.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
id: ogmios
title: Getting Started with Ogmios
sidebar_label: Ogmios
description: Getting 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 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).

## Installation

The easiest way to get started with Ogmios is to use [docker](https://www.docker.com). Since Ogmios requires the presence of a Cardano node, it makes sense to use docker-compose to orchestrate both services. A compose file is available on the Ogmios repository, get it via:

```sh
git clone --depth 1 https://github.com/KtorZ/cardano-ogmios.git
cd cardano-ogmios
```


Then, start the components stack using:
```sh
docker-compose up
```

If you prefer to build everything from source or without docker, please head to [the Ogmios website](https://ogmios.dev/getting-started).


## Dashboard

You should now be able to access the dashboard on [http://localhost:1337](http://localhost:1337) with a real-time visualization of some of the server runtime metrics.

![img](../../static/img/getting-started/ogmios/1-dashboard.gif)

## Query metrics

The dashboard is powered by JSON responses served by [http://localhost:1337/health](http://localhost:1337/health).

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="curl"
values={[
{label: 'curl', value: 'curl'},
{label: 'wget', value: 'wget'},
]}>
<TabItem value="curl">

```sh
curl -H 'Accept: application/json' http://localhost:1337/health
```

</TabItem>
<TabItem value="wget">

```sh
wget --header='Accept: application/json' -qO- http://localhost:1337/health
```

</TabItem>
</Tabs>

JSON response:

```json
{
"metrics": {
"totalUnrouted": 1,
"totalMessages": 30029,
"runtimeStats": {
"gcCpuTime": 1233009354,
"cpuTime": 81064672549,
"maxHeapSize": 41630,
"currentHeapSize": 1014
},
"totalConnections": 10,
"sessionDurations": {
"max": 57385,
"mean": 7057,
"min": 0
},
"activeConnections": 0
},
"startTime": "2021-03-15T16:16:41.470782977Z",
"lastTipUpdate": "2021-03-15T16:28:36.853115034Z",
"lastKnownTip": {
"hash": "c29428f386c701c1d1ba1fd259d4be78921ee9ee6c174eac898245ceb55e8061",
"blockNo": 5034297,
"slot": 15520688
},
"networkSynchronization": 0.99,
"currentEra": "Mary"
}
```

## 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/).
6 changes: 3 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ module.exports = {

// Announcement Bar
announcementBar: {
id: "support_us", // Any value that will identify this message.
id: "support_se", // Any value that will identify this message.
content:
//`If you like the new portal, give it a star on <a target="_blank" rel="noopener noreferrer" href="${repository}">GitHub</a>! ⭐️`,
`<strong>Support the Cardano Stack Exchange proposal <a target="_blank" rel="noopener noreferrer" href="https://area51.stackexchange.com/proposals/125174/cardano?referrer=YWI2YzZhYjZmZTVjODFjOTllMDk5YTU2MDk3YjM1NjE2NTRjZjk1NzUzOGVjNjg5ZWEzNTA5NjQ3YjQyNTg4Ne5A16BO-qeH4pXFAL-53fFirIzQZfSEYKOnpbAIMnZD0">by clicking here</a></strong>`,
`<strong>Join the Cardano Stack Exchange Beta <a target="_blank" rel="noopener noreferrer" href="https://cardano.stackexchange.com">by clicking here</a></strong>`,
backgroundColor: "#FD7575", // Defaults to `#fff`.
textColor: "#ffffff", // Defaults to `#000`.
isCloseable: true, // Defaults to `true`.
Expand Down Expand Up @@ -137,7 +137,7 @@ module.exports = {
},
{
label: "Stack Exchange",
href: "https://area51.stackexchange.com/proposals/125174/cardano",
href: "https://cardano.stackexchange.com",
},
{
label: "Slack",
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ module.exports = {
"Getting Started": [
"getting-started/overview",
"getting-started/blockfrost",
"getting-started/cardano-serialization-lib",
"getting-started/cardanocli-js",
"getting-started/dandelion-apis",
"getting-started/ogmios",
],
"Transaction Metadata": [
"transaction-metadata/overview",
Expand Down
5 changes: 4 additions & 1 deletion src/data/builder-tools.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const tools = [
"Library for serialization & deserialization of data structures used in Cardano's Haskell implementation.",
preview: require("./builder-tools/cardano-serialization-lib.png"),
website: "https://github.com/Emurgo/cardano-serialization-lib",
gettingstarted: "/docs/getting-started/cardano-serialization-lib",
gettingstarted: null,
},
{
title: "Dandelion APIs",
Expand All @@ -52,19 +52,22 @@ const tools = [
"In the browser-based Marlowe Playground you can write Marlowe contracts, in a variety of different ways.",
preview: require("./builder-tools/plutus-playground.png"),
website: "https://alpha.marlowe.iohkdev.io/#/",
gettingstarted: null,
},
{
title: "Ogmios",
description: "Ogmios offers a JSON-WSP interface through WebSockets.",
preview: require("./builder-tools/ogmios.png"),
website: "https://ktorz.github.io/cardano-ogmios/",
gettingstarted: "/docs/getting-started/ogmios",
},
{
title: "Plutus Playground",
description:
"The Plutus Playground is a lightweight, web-based environment for exploratory Plutus development.",
preview: require("./builder-tools/plutus-playground.png"),
website: "https://playground.plutus.iohkdev.io",
gettingstarted: null,
},
];

Expand Down
Binary file added src/data/showcase/cotiadapay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/data/showcase/nowpayments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/data/showcase/pooltoolmobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/data/showcase/rewardscalendar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions src/data/showcases.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ export const Tags = {
icon: null,
},

// Gateways
gateway: {
label: "Gateways",
description: "Payment Gateway Providers.",
icon: null,
},

// For open-source sites, a link to the source code is required
opensource: {
label: "Open-Source",
Expand Down Expand Up @@ -383,6 +390,42 @@ const Showcases = [
source: null,
tags: ["featured", "metadata"],
},
{
title: "PoolTool Mobile",
description:
"Explore Cardano, track your rewards and get notified to take action on certain events.",
preview: require("./showcase/pooltoolmobile.png"),
website: "https://pooltool.io/mobile",
source: null,
tags: ["featured", "pooltool", "analytics"],
},
{
title: "Rewards Calendar",
description:
"Shows the epochs and rewards in a calendar.",
preview: require("./showcase/rewardscalendar.png"),
website: "https://dbooster.io/calendar",
source: null,
tags: ["featured", "analytics"],
},
{
title: "NOWPayments",
description:
"Payment gateway provider to accept ada payments and ada donations.",
preview: require("./showcase/nowpayments.png"),
website: "https://nowpayments.io",
source: null,
tags: ["featured", "gateway"],
},
{
title: "Coti adaPay",
description:
"Payment gateway provider to accept ada payments and ada donations.",
preview: require("./showcase/cotiadapay.png"),
website: "https://adapay.coti.io",
source: null,
tags: ["gateway"],
},
];

export const TagList = Object.keys(Tags);
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.