Skip to content

Itheum/sdk-data-marshal-network

Repository files navigation

SDK MX - Data Marshal Network

npm (scoped)

This SDK is currently focused on interacting with the Itheum's Data Marshal Network.

Contributing

  • requires node@19.7X
  • npm install
  • work on typescript code in the /src folder

Dev Testing

  • Only simple dev testing added. First Build as below and then run npm run test and work on the test.mjs file for live reload

Build

  • npm run build
  • New build is sent to dist folder

Usage in 3rd party dApps

  • Install this SDK via npm i @itheum/sdk-data-marshal-network
  • Methods supported are given below is SDK Docs

SDK DOCS

  • Generated docs available here: https://itheum.github.io/sdk-data-marshal-network/
  • Note that all param requirements and method docs are marked up in the typescript code, so if you use typescript in your project your development tool (e.g. Visual Studio Code) will provide intellisense for all methods and functions.