https://github.com/cardanosolutions/ogmios-mdk

A minimalist JavaScript development kit for Ogmios.
https://github.com/cardanosolutions/ogmios-mdk

cardano client javascript ogmios sdk

Last synced: 10 months ago
JSON representation

A minimalist JavaScript development kit for Ogmios.

• Host: GitHub
• URL: https://github.com/cardanosolutions/ogmios-mdk
• Owner: CardanoSolutions
• License: apache-2.0
• Created: 2025-03-13T14:54:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-14T14:51:43.000Z (over 1 year ago)
• Last Synced: 2025-06-30T08:45:11.702Z (about 1 year ago)
• Topics: cardano, client, javascript, ogmios, sdk
• Language: JavaScript
• Homepage: https://cardanosolutions.github.io/ogmios-mdk/
• Size: 26.4 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Ogmios - Minimal Development Kit

[![Licence](https://img.shields.io/github/license/CardanoSolutions/ogmios-mdk?style=for-the-badge)](https://github.com/CardanoSolutions/ogmios-mdk/blob/main/LICENSE)

[![NPM](https://img.shields.io/npm/v/%40cardano-ogmios%2Fmdk?style=for-the-badge)](https://www.npmjs.com/package/@cardano-ogmios/mdk)

A minimalist development kit in JavaScript for Ogmios.

## Installation

```

yarn add @cardano-ogmios/mdk

```

## Usage

### General usage

```js

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

```js

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

```js

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

```js

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();

});

```