Skip to content
A JavaScript API for interacting with the XRP Ledger in Node.js and the browser
Branch: develop
Clone or download
intelliot No working browser version for 1.2.2
Using `"noEmitOnError": true` in `tsconfig.json` prevents the browser build from being created
Latest commit f6a22d2 Apr 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Prevent prepareTransaction from overwriting values in txJSON (#1000) Apr 13, 2019
scripts
snippets Use TypeScript project reference (#1002) Apr 15, 2019
src
test Prevent prepareTransaction from overwriting values in txJSON (#1000) Apr 13, 2019
.gitignore
.npmignore Set up babel transpiler May 14, 2015
.nvmrc Add DepositPreauth (#958) Oct 31, 2018
.nycrc update istanbul to nyc (their new cli) to get typescript coverage Jan 12, 2018
.travis.yml Use TypeScript project reference (#1002) Apr 15, 2019
APPLICATIONS.md Add list of applications using ripple-lib (#976) Nov 30, 2018
Gulpfile.js Don't generate TS definitions for browser build (#864) Mar 7, 2018
HISTORY.md No working browser version for 1.2.2 Apr 18, 2019
LICENSE LICENSE: add title (#803) Nov 5, 2017
README.md
circle.yml Update for CircleCI Sep 27, 2017
package.json Release 1.2.2 Apr 15, 2019
tsconfig-base.json Use TypeScript project reference (#1002) Apr 15, 2019
tsconfig.json
tslint.json Add DepositPreauth (#958) Oct 31, 2018
yarn.lock Use TypeScript project reference (#1002) Apr 15, 2019

README.md

ripple-lib

A JavaScript API for interacting with the XRP Ledger

NPM

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 use yarn.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

  1. Clone the repository
  2. cd into the repository and install dependencies with yarn install
  3. 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

You can’t perform that action at this time.