edge-ripple-lib
v1.0.0-beta.2
Published
A JavaScript API for interacting with Ripple in Node.js and the browser
Downloads
12
Readme
ripple-lib
A JavaScript API for interacting with the XRP Ledger
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
- Clone the repository
cd
into the repository and install dependencies withyarn install
yarn test
oryarn test --coverage
(istanbul
will create coverage reports incoverage/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.