ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-04 04:55:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
226ef862ae2209acdb680a01f35c31f83e021498
xahau.js/README.md
Elliot Lee 226ef862ae Link to mailing lists
2018-05-10 16:25:05 -07:00

2.3 KiB
Raw Blame History

ripple-lib

A JavaScript API for interacting with the XRP Ledger

Circle CI Coverage Status

NPM

Features

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

Getting Started

See also: RippleAPI Beginners Guide

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

Install ripple-lib:

$ yarn add ripple-lib

Then see the documentation and code samples.

Mailing lists

We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)

If you're using the XRP Ledger in production, you should run a rippled server and subscribe to the ripple-server mailing list as well.

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