ripple/ripple-lib


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

https://xrpl.org/

License: ISC

Language: TypeScript

Keywords: api, blockchain, javascript, ripple, xrp, xrp-ledger


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.

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!

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

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

Project Statistics

Sourcerank 15
Repository Size 16.5 MB
Stars 840
Forks 377
Watchers 184
Open issues 35
Dependencies 1,172
Contributors 87
Tags 167
Created
Last updated
Last pushed

Top Contributors See all

wltsmrz Geert Weening Stefan Thomas Arthur Britto Chris Clark Elliot Lee Matthew Fettig Ivan Tivonenko Nicholas Dudfield FKSRipple Evan Schwartz Rome Reginelli Elliot Lee Alan Cohen Fred K. Schott Fred K. Schott jatchili Brandon Wilson Vahe Hovhannisyan Bo Chen

Packages Referencing this Repo

ripple-lib
A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser
Latest release 1.6.4 - Updated - 840 stars
bitrock-wallet-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser. This is a modified versi...
Latest release 0.18.1 - Published - 840 stars
ripple-lib-0.9.4
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.9.4 - Published - 840 stars
@aqfr/aqfr-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 1.2.3 - Published - 840 stars
script-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.21 - Updated - 840 stars
ripple-zxlib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 840 stars
ripple-lib-peersafe
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 840 stars
ripple-lib-2
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 840 stars
edge-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 1.0.0-beta.2 - Updated - 840 stars
zc-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.26.27 - Updated - 840 stars
ripple-lib-1
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 840 stars

Recent Tags See all

1.6.4 February 18, 2020
1.6.3 February 06, 2020
1.6.3-beta.0 January 30, 2020
1.6.2 January 17, 2020
1.6.1 January 14, 2020
1.6.0 January 06, 2020
1.5.1 December 28, 2019
1.5.0 December 15, 2019
1.4.2 November 15, 2019
1.4.1 November 07, 2019
1.4.0 October 29, 2019
1.3.4 October 18, 2019
1.3.3 September 11, 2019
1.3.2 September 03, 2019
1.3.1 August 26, 2019

Interesting Forks See all

gdibble/ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
TypeScript - ISC - Updated - 1 stars
OpenDAWN/ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
JavaScript - Updated - 1 stars
BitGo/ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
JavaScript - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-12-15 06:49:10 UTC

Login to resync this repository