# ripplelib

> A JavaScript API for interacting with Ripple in Node.js and the browser

Latest version **1.2.5** (published 2017-08-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install ripplelib
pnpm add ripplelib
yarn add ripplelib
bun add ripplelib
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2017-08-22 |
| First published | 2016-11-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+10 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | ripplerm |

## Links

- npm: https://www.npmjs.com/package/ripplelib
- Repository: https://github.com/ripplerm/ripplelib
- Homepage: https://github.com/ripplerm/ripplelib#readme
- Issues: https://github.com/ripplerm/ripplelib/issues
- npm.io page: https://npm.io/package/ripplelib

## Dependencies (8)

- [ws](https://npm.io/package/ws.md) ~0.8.1
- [async](https://npm.io/package/async.md) ~0.9.0
- [extend](https://npm.io/package/extend.md) ~1.2.1
- [lodash](https://npm.io/package/lodash.md) ^3.1.0
- [asn1.js](https://npm.io/package/asn1.js.md) ^4.9.0
- [lru-cache](https://npm.io/package/lru-cache.md) ~2.5.0
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^4.0.2
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^5.8.20

## Recent versions

- 1.2.5 (latest) — 2017-08-22
- 1.2.4 — 2017-04-07
- 1.2.3 — 2017-02-22
- 1.2.2 — 2017-02-08
- 1.2.1 — 2017-02-02
- 1.2.0 — 2017-01-25
- 1.1.3 — 2017-01-14
- 1.1.2 — 2016-12-01
- 1.1.1 — 2016-11-20
- 1.1.0 — 2016-11-09
- 1.0.0 — 2016-11-07

## README

# ripplelib

A JavaScript API for interacting with Ripple in Node.js and the browser
(a fork from ripple-lib-0.12)

## Features

+ Connect to a rippled server in JavaScript (Node.js or browser)
+ Issue [rippled API](https://ripple.com/build/rippled-apis/) requests
+ Listen to events on the Ripple network (transaction, ledger, etc.)
+ Sign and submit transactions to the Ripple network


## Installation

**Via npm for Node.js**

```
  $ npm install ripplelib
```

**Building ripplelib for browser environments**

ripplelib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of ripplelib in the `build/` directory.

```
  $ git clone https://github.com/ripplerm/ripplelib
  $ npm install
  $ npm run build
```

**Restricted browser builds**

You may generate browser builds that contain a subset of features. To do this, run `./node_modules/.bin/gulp build-<name>`

+ `build-core` Contains the functionality to make requests and listen for events such as `ledgerClose`. Only `ripple.Remote` is currently exposed. Advanced features like transaction submission and orderbook tracking are excluded from this build.

## Quick start

`Remote.js` ([remote.js](https://github.com/ripplerm/ripplelib/blob/master/dist/npm/remote.js)) is the point of entry for interacting with rippled

```js
/* Loading ripplelib with Node.js */
var Remote = require('ripplelib').Remote;

/* Loading ripplelib in a webpage */
// var Remote = ripple.Remote;

var remote = new Remote({
  // see the API Reference for available options
  servers: [ 'wss://s1.ripple.com:443' ]
});

remote.connect(function() {
  /* remote connected */
  remote.requestServerInfo(function(err, info) {
    // process err and info
  });
});
```

## Running tests

1. Clone the repository

2. `cd` into the repository and install dependencies with `npm install`

3. `npm test`

## More Information

+ [Ripple Dev Portal](https://ripple.com/build/)

---
_Source: https://npm.io/package/ripplelib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._