JSPM

  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q61904F
  • License MIT

SDK Code to Interact with Kolibri, a stablecoin built on Tezos

Package Exports

  • @hover-labs/kolibri-js
  • @hover-labs/kolibri-js/build/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hover-labs/kolibri-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Kolibri.JS

Kolibri.JS contains code for interacting with the Kolibri Protocol, a self balancing algorithmic stablecoin built on Tezos.

Installation

As with other js packages, builds are pushed to NPM and can be installed with

npm install --save @hover-labs/kolibri-js

Documentation

Typedocs can be found at this repo's github pages

The following classes are implemented:

  • ContractErrors: Maps errors from the Kolibri smart contracts into a user friendly enum
  • Network: Enum defining available networks
  • HarbingerClient: Interacts with the Harbinger Oracle Contracts
  • LiquidityPoolClient: Interacts with the Kolibri Liquiidty Pool
  • OvenClient: Interacts with a Kolibri Oven
  • StableCoinClient: Interacts with the top level Kolibri contracts
  • TokenClient: Interacts with the FA1.2 kUSD token contract
  • CONTRACTS: Helper object to get contract addresses on different networks
  • ConversionUtils: Helpers to convert between units
  • ErrorUtils: Error handling utilities