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


Build Status

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

Project Statistics

Sourcerank 15
Repository Size 15.1 MB
Stars 828
Forks 364
Watchers 182
Open issues 29
Dependencies 734
Contributors 84
Tags 158
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 Vahe Hovhannisyan Brandon Wilson Bo Chen

Packages Referencing this Repo

ripple-lib-0.9.4
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.9.4 - Published - 828 stars
ripple-zxlib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 828 stars
zc-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.26.27 - Updated - 828 stars
ripple-lib-2
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 828 stars
ripple-lib-peersafe
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 828 stars
ripple-lib-1
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.4 - Published - 828 stars
ripple-lib
A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser
Latest release 1.4.2 - Updated - 828 stars
@aqfr/aqfr-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 1.2.3 - Published - 828 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 - 828 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 - 828 stars
script-ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
Latest release 0.16.21 - Updated - 828 stars

Recent Tags See all

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
1.3.0 August 17, 2019
1.2.5 August 17, 2019
1.2.4 June 06, 2019
1.2.3 April 30, 2019
1.2.2 April 15, 2019
1.2.1 March 23, 2019
1.2.0 March 19, 2019
1.1.2 December 12, 2018
1.1.1 November 27, 2018

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-11-15 04:55:27 UTC

Login to resync this repository