iota.lib.js.powsrvio

0.0.1 • Public • Published

iota.lib.js.powsrvio - IOTA.js Library MonkeyPatch

This library is used to shim the iota.lib.js library to delegate Proof-of-work to powsrv.io. This enables for users to offload PoW from low-power IoT devices, mobile and desktop devices without capabilities.

Basic Usage

The library exposes one function, which your require or import. This function is used to overlay powsrv.io functionality to your current iota.lib.js instance.

// Import your iota library
const IOTA = require("iota.lib.js")
 
// Import the Monkey Patch for the IOTA lib
const usePowSrvIO = require('@powsrvio/iota.lib.js.powsrvio')
 
// Create your iota api instance
const iota = new IOTA({ provider: "https://nodes.thetangle.org:443" });
 
// Patch the current IOTA instance
usePowSrvIO(iota, 5000, null)
  1. iota: Object The iota.lib.js instance in your application
  2. delay: Integer Milliseconds to wait before PoW server timeout. Null value defaults to 5000
  3. key: String API key used to raise the un-authenticated API limits. Optional

MAM Usage

Did you know? You can also use the powsrv.io with Masked Authentication Messaging. Just use the steps below to initialize the official MAM client with powsrv.io.

// Import your iota library
const IOTA = require("iota.lib.js")
 
// Import the Monkey Patch for the IOTA lib
const usePowSrvIO = require('@powsrvio/iota.lib.js.powsrvio')
 
// Import the official MAM client (https://github.com/iotaledger/mam.client.js/)
const Mam = require('../lib/mam.client.js')
 
// Create your iota api instance
const iota = new IOTA({ provider: "https://nodes.iota.fm:443" });
 
// Patch the current IOTA instance
usePowSrvIO(iota, 5000, null)
 
// Initialise MAM State - PUBLIC
let mamState = Mam.init(iota)

API Key

In order to receive an API key, join our Discord channel and contact us!

Package Sidebar

Install

npm i iota.lib.js.powsrvio

Weekly Downloads

1

Version

0.0.1

License

GPL-3.0

Unpacked Size

43.4 kB

Total Files

6

Last publish

Collaborators

  • romansemko