@zapjs/bondage
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

@zapjs/bondage

This package provides an interface to the Zap bondage contract. This package enables subscribers to bond and unbond Zap and Dots from registered oracles.

Prerequisites

- Node 12.20 <=14.15
- Typescript

Usage

Using Zap Arbiter to listen to subscriptions events
npm install --save `@zapjs/bondage`
import {ZapBondage} from '@zapjs/bondage';

let myZapBondage = new ZapBondage();

Custom configuration

let myZapBondage = new ZapBondage({networkId,networkProvider,coordinator})

Methods

Get methods

const zapBound = await myZapBondage.getZapBound({provider,endpoint});
const dotsBound = await myZapBondage.getBoundDots({subscriber,provider,endpoint});
const gotsIssued = await myZapBondage.getDotsIssued({provider,endpoint});
const currentCostOfDots  = await myZapBondage.currentCostOfDots({provider,ednpoint,dots});
const bondRate = await myZapBondage.calcBondRate({provider,endpoint,zapNum});
const zapRequired = await myZapBondate.calcZapForDots({provider,endpoint,dots});

Listen to events

myZapBondate.listenBound(filters,callback);
myZapBondate.listenUnbound(filters,callback);
myZapBondate.listenEscrowed(filters,callback);
myZapBondate.listenRelease(filters,callback);

Listen to all events

myZapBondate.listen(callback);

See more Usages of each packages

Dependents (5)

Package Sidebar

Install

npm i @zapjs/bondage

Weekly Downloads

2

Version

3.0.1

License

ISC

Unpacked Size

27.9 kB

Total Files

5

Last publish

Collaborators

  • zwalla
  • zaporg
  • propulsor
  • michael99man
  • avisaven