@aqfr/aqfr-ripple-lib v1.2.3
ripple-lib
A JavaScript API for interacting with the XRP Ledger
Features
- Connect to a
rippled
server from Node.js or a web browser - Helpers for creating requests and parsing responses for the rippled API
- Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
- Sign and submit transactions to the XRP Ledger
- Type definitions for TypeScript
Getting Started
See also: RippleAPI Beginners Guide
Requirements
- Node v10 is recommended. Other versions may work but are not frequently tested.
- Yarn is recommended.
npm
may work but we useyarn.lock
.
Install
In an existing project (with package.json
), install ripple-lib
:
$ yarn add ripple-lib
Then see the documentation and code samples.
What is ripple-lib used for? Here's a list of applications that use ripple-lib
. Open a PR to add your app or project to the list!
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.
Development
To build the library for Node.js:
$ yarn compile
The TypeScript compiler will output the resulting JS files in ./dist/npm/
.
To build the library for the browser:
$ yarn build
Gulp will output the resulting JS files in ./build/
.
For details, see the scripts
in package.json
.
Running Tests
- Clone the repository
cd
into the repository and install dependencies withyarn install
yarn test
Also, run yarn lint
to lint the code with tslint
.
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
.
More Information
6 years ago