@sodazone/ocelloids-client
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

Ocelloids Client Library

npm @sodazone/ocelloids-client

TypeScript client library to interact with Ocelloids Service APIs.

Documentation Site.

Install

NPM

npm install @sodazone/ocelloids-client

Yarn

yarn add @sodazone/ocelloids-client

Usage

import { OcelloidsClient, xcm } from "@sodazone/ocelloids-client";

const client = new OcelloidsClient({
  httpUrl: "http://127.0.0.1:3000",
  wsUrl: "ws://127.0.0.1:3000"
});

// subscribe on-demand
const ws = client.subscribe<xcm.XcmInputs>({
  agent: "xcm",
  args: {
    origin: "urn:ocn:polkadot:2004",
    senders: "*",
    events: "*",
    destinations: [ 
      "urn:ocn:polkadot:0",
      "urn:ocn:polkadot:1000",
      "urn:ocn:polkadot:2000",
      "urn:ocn:polkadot:2034",
      "urn:ocn:polkadot:2104"
    ]
  }
 }, {
  onMessage: msg => {
    if(xcm.isXcmReceived(msg)) {
      console.log("RECV", msg.subscriptionId);
    } else if(xcm.isXcmSent(msg)) {
      console.log("SENT", msg.subscriptionId)
    }
    console.log(msg);
  },
  onError: error => console.log(error),
  onClose: event => console.log(event.reason)
});

Explore the documentation site for further details.

Development

Enable corepack:

corepack enable

Install dependencies and build the project:

yarn && yarn build

Testing

Run unit tests:

yarn test

Compatibility

Compatible with browser environments, Node and Bun.

Readme

Keywords

none

Package Sidebar

Install

npm i @sodazone/ocelloids-client

Weekly Downloads

58

Version

2.0.0

License

Apache-2.0

Unpacked Size

139 kB

Total Files

26

Last publish

Collaborators

  • xueyingw
  • mfornos
  • frankie.om