ripple-lib (RippleAPI)

A JavaScript/TypeScript API for interacting with the XRP Ledger

This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.

➡️ Reference Documentation

See the full reference documentation on the XRP Ledger Dev Portal.

➡️ Applications and Projects

What is ripple-lib used for? The applications on the list linked above use ripple-lib. Open a PR to add your app or project to the list!

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

Requirements

Node.js v14 is recommended. Other versions may work but are not frequently tested.
npm is recommended. yarn may work but we use package-lock.json.

Getting Started

Using ripple-lib with React Native

If you want to use ripple-lib with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like rn-nodeify.

Install dependencies (you can use npm as well):

npm install react-native-crypto
npm install ripple-lib
# install peer deps
npm install react-native-randombytes
# install latest rn-nodeify
npm install rn-nodeify@latest --dev

After that, run the following command:

# install node core shims and recursively hack package.json files
# in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
./node_modules/.bin/rn-nodeify --hack --install

Enable crypto:

rn-nodeify will create a shim.js file in the project root directory. Open it and uncomment the line that requires the crypto module:

// If using the crypto shim, uncomment the following line to ensure
// crypto is loaded first, so it can populate global.crypto
require('crypto')

Import shim in your project (it must be the first line):

import './shim'
...

Using ripple-lib with Deno

Until official support for Deno is added, you can use the following work-around to use ripple-lib with Deno:

import ripple from 'https://dev.jspm.io/npm:ripple-lib';

(async () => {
  const api = new (ripple as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
  const address = 'rH8NxV12EuV...khfJ5uw9kT';

  api.connect().then(() => {
    api.getBalances(address).then((balances: any) => {
      console.log(JSON.stringify(balances, null, 2));
    });
  });
})();