Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.76 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.76 KB
Raw

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