A JavaScript API for interacting with the XRP Ledger in Node.js and the browser
Clone or download



A JavaScript API for interacting with the XRP Ledger



  • 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
  • Type definitions for TypeScript

Getting Started

See also: RippleAPI Beginners Guide


  • Node v10 is recommended. Other versions may work but are not frequently tested.
  • Yarn is recommended. npm may work but we use yarn.lock.


In an existing project (with package.json), 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.


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 more details, see the scripts in package.json.

Running Tests

  1. Clone the repository
  2. cd into the repository and install dependencies with yarn install
  3. yarn test

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