Ogmios - Minimal Development Kit

A minimalist development kit in JavaScript for Ogmios.

Installation

yarn add @cardano-ogmios/mdk

Usage

General usage

import { ogmios, Json } from "@cardano-ogmios/mdk";

const tip = await ogmios((ws, done) => {
  ws.once("message", (data) => {
    done(Json.parse(data).result.tip)
  });

  ws.rpc("findIntersection", { points: [ "origin" ] });
});

console.log(tip);

Simple state-query

import { ogmios, Json } from "@cardano-ogmios/mdk";

const result = await ogmios((ws, done) => {
  ws.queryLedgerState("tip").then(done);
});

console.log(Json.stringify(result));

Get a particular block child

import { ogmios, Json } from "@cardano-ogmios/mdk";

await ogmios(async (ws, done) => {
  const chainFollower = await ws.newChainFollower(
    [
      {
        id: "3d6f139f9f019668fe0412cacfaeb9e0be42e7b0f6ab21d6bddbc12d771ec18a",
        slot: 86268539,
      },
    ],
    1
  );

  for await (const { block } of chainFollower()) {
    console.log(block);
  }

  done();
});

Follow the chain from the tip

import { ogmios, Json } from "@cardano-ogmios/mdk";

await ogmios(async (ws, done) => {
  const chainFollower = await ws.newChainFollower();

  for await (const { block } of chainFollower()) {
    console.log(block);
  }

  done();
});