npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ripple-lib-compat

v1.1.2-2

Published

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

Downloads

4

Readme

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