ripple-lib
A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser
Last updated 2 months ago by intelliot .
ISC · Repository · Original npm · Tarball · package.json
$ cnpm install ripple-lib 
SYNC missed versions from official npm registry.

ripple-lib (RippleAPI)

A JavaScript/TypeScript API for interacting with the XRP Ledger

NPM

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 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

Documentation

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 and the browser:

$ yarn build

The TypeScript compiler will output the resulting JS files in ./dist/npm/.

webpack will output the resulting JS files in ./build/.

For details, see the scripts in package.json.

Running Tests

Unit Tests

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

Linting

Run yarn lint to lint the code with eslint.

Generating Documentation

Do not edit ./docs/index.md directly because it is a generated file.

Instead, edit the appropriate .md.ejs files in ./docs/src/.

If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running yarn run docgen.

More Information

Build Status

Current Tags

  • 1.6.6-beta.2                                ...           beta (3 months ago)
  • 1.7.1                                ...           latest (2 months ago)

195 Versions

  • 1.7.1                                ...           2 months ago
  • 1.7.0                                ...           2 months ago
  • 1.6.6-beta.2                                ...           3 months ago
  • 1.6.6-beta.1                                ...           3 months ago
  • 1.6.5                                ...           4 months ago
  • 1.6.4                                ...           5 months ago
  • 1.6.3                                ...           5 months ago
  • 1.6.3-beta.1                                ...           5 months ago
  • 1.6.3-beta.0                                ...           5 months ago
  • 1.6.2                                ...           6 months ago
  • 1.6.1                                ...           6 months ago
  • 1.6.0                                ...           6 months ago
  • 1.5.1                                ...           6 months ago
  • 1.5.0                                ...           7 months ago
  • 1.4.2                                ...           8 months ago
  • 1.4.1                                ...           8 months ago
  • 1.4.0                                ...           8 months ago
  • 1.3.4                                ...           9 months ago
  • 1.4.0-b2                                ...           9 months ago
  • 1.4.0-b1                                ...           9 months ago
  • 1.3.3                                ...           10 months ago
  • 1.3.2                                ...           10 months ago
  • 1.3.1                                ...           a year ago
  • 1.3.0                                ...           a year ago
  • 1.2.5                                ...           a year ago
  • 1.2.4                                ...           a year ago
  • 1.2.3                                ...           a year ago
  • 1.2.1                                ...           a year ago
  • 1.2.0                                ...           a year ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 1.0.0-beta.5                                ...           2 years ago
  • 1.0.0-beta.4                                ...           2 years ago
  • 1.0.0-beta.3                                ...           2 years ago
  • 1.0.0-beta.2                                ...           2 years ago
  • 1.0.0-beta.1                                ...           2 years ago
  • 1.0.0-beta.0                                ...           2 years ago
  • 0.22.0                                ...           2 years ago
  • 0.21.0                                ...           2 years ago
  • 0.20.0                                ...           2 years ago
  • 0.19.1                                ...           2 years ago
  • 0.19.0                                ...           2 years ago
  • 0.18.2                                ...           2 years ago
  • 0.18.1                                ...           2 years ago
  • 0.18.0                                ...           2 years ago
  • 0.17.9                                ...           3 years ago
  • 0.17.8                                ...           3 years ago
  • 0.17.7                                ...           3 years ago
  • 0.17.6                                ...           3 years ago
  • 0.17.5                                ...           3 years ago
  • 0.17.4                                ...           4 years ago
  • 0.17.3                                ...           4 years ago
  • 0.17.2                                ...           4 years ago
  • 0.17.1                                ...           4 years ago
  • 0.17.0                                ...           4 years ago
  • 0.16.10                                ...           4 years ago
  • 0.16.9                                ...           4 years ago
  • 0.16.8                                ...           4 years ago
  • 0.16.7                                ...           4 years ago
  • 0.16.6                                ...           4 years ago
  • 0.16.5                                ...           4 years ago
  • 0.16.4                                ...           5 years ago
  • 0.16.3                                ...           5 years ago
  • 0.16.2                                ...           5 years ago
  • 0.16.1                                ...           5 years ago
  • 0.16.0                                ...           5 years ago
  • 0.15.2                                ...           5 years ago
  • 0.15.1                                ...           5 years ago
  • 0.15.0                                ...           5 years ago
  • 0.14.0                                ...           5 years ago
  • 0.13.2                                ...           5 years ago
  • 0.13.1                                ...           5 years ago
  • 0.13.0                                ...           5 years ago
  • 0.13.0-rc16 [deprecated]           ...           5 years ago
  • 0.13.0-rc15 [deprecated]           ...           5 years ago
  • 0.13.0-rc11.1 [deprecated]           ...           5 years ago
  • 0.13.0-rc14 [deprecated]           ...           5 years ago
  • 0.13.0-rc13 [deprecated]           ...           5 years ago
  • 0.13.0-rc12 [deprecated]           ...           5 years ago
  • 0.12.9 [deprecated]           ...           5 years ago
  • 0.13.0-rc11 [deprecated]           ...           5 years ago
  • 0.13.0-rc6.0 [deprecated]           ...           5 years ago
  • 0.12.8 [deprecated]           ...           5 years ago
  • 0.13.0-rc10 [deprecated]           ...           5 years ago
  • 0.12.7 [deprecated]           ...           5 years ago
  • 0.12.6 [deprecated]           ...           5 years ago
  • 0.12.5 [deprecated]           ...           5 years ago
  • 0.13.0-rc1 [deprecated]           ...           5 years ago
  • 0.12.5-rc2 [deprecated]           ...           5 years ago
  • 0.12.5-rc1 [deprecated]           ...           5 years ago
  • 0.12.4 [deprecated]           ...           5 years ago
  • 0.12.4-rc1 [deprecated]           ...           5 years ago
  • 0.12.3 [deprecated]           ...           5 years ago
  • 0.12.3-rc2 [deprecated]           ...           5 years ago
  • 0.12.3-rc1 [deprecated]           ...           5 years ago
  • 0.12.2 [deprecated]           ...           5 years ago
  • 0.12.2-rc1 [deprecated]           ...           5 years ago
  • 0.12.1 [deprecated]           ...           5 years ago
  • 0.12.1-rc6 [deprecated]           ...           5 years ago
  • 0.12.1-rc5 [deprecated]           ...           5 years ago
  • 0.12.1-rc4 [deprecated]           ...           5 years ago
  • 0.12.1-rc3 [deprecated]           ...           5 years ago
  • 0.12.1-rc2 [deprecated]           ...           5 years ago
  • 0.12.1-rc1 [deprecated]           ...           5 years ago
  • 0.12.0 [deprecated]           ...           5 years ago
  • 0.12.0-rc3 [deprecated]           ...           5 years ago
  • 0.12.0-rc2 [deprecated]           ...           5 years ago
  • 0.12.0-rc1 [deprecated]           ...           5 years ago
  • 0.11.0 [deprecated]           ...           5 years ago
  • 0.11.0-rc3 [deprecated]           ...           5 years ago
  • 0.11.0-rc2 [deprecated]           ...           5 years ago
  • 0.11.0-rc1 [deprecated]           ...           5 years ago
  • 0.10.1-rc2 [deprecated]           ...           6 years ago
  • 0.10.1-rc1 [deprecated]           ...           6 years ago
  • 0.10.0 [deprecated]           ...           6 years ago
  • 0.10.0-rc2 [deprecated]           ...           6 years ago
  • 0.10.0-rc1 [deprecated]           ...           6 years ago
  • 0.9.4 [deprecated]           ...           6 years ago
  • 0.9.4-rc2 [deprecated]           ...           6 years ago
  • 0.9.4-rc1 [deprecated]           ...           6 years ago
  • 0.9.3 [deprecated]           ...           6 years ago
  • 0.9.3-rc3 [deprecated]           ...           6 years ago
  • 0.9.3-rc2 [deprecated]           ...           6 years ago
  • 0.9.3-rc1 [deprecated]           ...           6 years ago
  • 0.9.2 [deprecated]           ...           6 years ago
  • 0.9.2-rc6 [deprecated]           ...           6 years ago
  • 0.9.2-rc5 [deprecated]           ...           6 years ago
  • 0.9.2-rc4 [deprecated]           ...           6 years ago
  • 0.9.2-rc3 [deprecated]           ...           6 years ago
  • 0.9.2-rc2 [deprecated]           ...           6 years ago
  • 0.9.2-rc1 [deprecated]           ...           6 years ago
  • 0.9.1 [deprecated]           ...           6 years ago
  • 0.9.1-rc3 [deprecated]           ...           6 years ago
  • 0.9.1-rc2 [deprecated]           ...           6 years ago
  • 0.9.1-rc1 [deprecated]           ...           6 years ago
  • 0.9.0 [deprecated]           ...           6 years ago
  • 0.9.0-rc5 [deprecated]           ...           6 years ago
  • 0.9.0-rc4 [deprecated]           ...           6 years ago
  • 0.9.0-rc3 [deprecated]           ...           6 years ago
  • 0.9.0-rc2 [deprecated]           ...           6 years ago
  • 0.9.0-rc1 [deprecated]           ...           6 years ago
  • 0.8.3-rc1 [deprecated]           ...           6 years ago
  • 0.8.2 [deprecated]           ...           6 years ago
  • 0.8.2-rc2 [deprecated]           ...           6 years ago
  • 0.8.2-rc1 [deprecated]           ...           6 years ago
  • 0.8.1 [deprecated]           ...           6 years ago
  • 0.8.1-rc3 [deprecated]           ...           6 years ago
  • 0.8.1-rc2 [deprecated]           ...           6 years ago
  • 0.8.1-rc1 [deprecated]           ...           6 years ago
  • 0.8.0 [deprecated]           ...           6 years ago
  • 0.8.0-rc3 [deprecated]           ...           6 years ago
  • 0.8.0-rc2 [deprecated]           ...           6 years ago
  • 0.8.0-beta [deprecated]           ...           6 years ago
  • 0.7.39 [deprecated]           ...           6 years ago
  • 0.7.38-beta [deprecated]           ...           6 years ago
  • 0.7.37 [deprecated]           ...           6 years ago
  • 0.7.36 [deprecated]           ...           6 years ago
  • 0.7.35 [deprecated]           ...           6 years ago
  • 0.7.34 [deprecated]           ...           6 years ago
  • 0.7.33 [deprecated]           ...           6 years ago
  • 0.7.32 [deprecated]           ...           6 years ago
  • 0.7.30 [deprecated]           ...           6 years ago
  • 0.7.29 [deprecated]           ...           7 years ago
  • 0.7.28 [deprecated]           ...           7 years ago
  • 0.7.26 [deprecated]           ...           7 years ago
  • 0.7.25 [deprecated]           ...           7 years ago
  • 0.7.24 [deprecated]           ...           7 years ago
  • 0.7.23 [deprecated]           ...           7 years ago
  • 0.7.31 [deprecated]           ...           6 years ago
  • 0.7.22 [deprecated]           ...           7 years ago
  • 0.7.21 [deprecated]           ...           7 years ago
  • 0.7.20 [deprecated]           ...           7 years ago
  • 0.7.19 [deprecated]           ...           7 years ago
  • 0.7.18 [deprecated]           ...           7 years ago
  • 0.7.17 [deprecated]           ...           7 years ago
  • 0.7.16 [deprecated]           ...           7 years ago
  • 0.7.14 [deprecated]           ...           7 years ago
  • 0.7.13 [deprecated]           ...           7 years ago
  • 0.7.12 [deprecated]           ...           7 years ago
  • 0.7.11 [deprecated]           ...           7 years ago
  • 0.7.10 [deprecated]           ...           7 years ago
  • 0.7.9 [deprecated]           ...           7 years ago
  • 0.7.8 [deprecated]           ...           7 years ago
  • 0.7.7 [deprecated]           ...           7 years ago
  • 0.7.6 [deprecated]           ...           7 years ago
  • 0.7.5 [deprecated]           ...           7 years ago
  • 0.7.4 [deprecated]           ...           7 years ago
  • 0.7.3 [deprecated]           ...           7 years ago
  • 0.7.2 [deprecated]           ...           7 years ago
  • 0.7.1 [deprecated]           ...           7 years ago
  • 0.7.0 [deprecated]           ...           7 years ago
Downloads
Today 2
This Week 2
This Month 137
Last Day 0
Last Week 120
Last Month 757
Dependencies (12)
Dev Dependencies (18)
Dependents (104)

Copyright 2014 - 2016 © taobao.org |