0.19.0 • Published 2 years ago

divvy-lib v0.19.0

Weekly downloads
7
License
ISC
Repository
github
Last release
2 years ago

divvy-lib

A JavaScript API for interacting with the XDV Ledger

Circle CI Coverage Status

NPM

Features

  • Connect to a divvyd server from Node.js or a web browser
  • Issue divvyd API requests
  • Listen to events on the XDV Ledger (transaction, ledger, etc.)
  • Sign and submit transactions to the XDV Ledger

Getting Started

See also: DivvyAPI Beginners Guide

You can use npm, but we recommend using yarn for the added assurance provided by yarn.lock.

Install divvy-lib:

$ yarn add divvy-lib

Then see the documentation and code samples

Running tests

  1. Clone the repository
  2. cd into the repository and install dependencies with yarn install
  3. yarn test or yarn test --coverage (istanbul will create coverage reports in coverage/lcov-report/)

Generating Documentation

The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running yarn run docgen.

npm may be used instead of yarn in the commands above.

More Information