rippel-lib

library1.10.1jsnpmunverified

RippleAPI 1.x is a JavaScript/TypeScript library for integrating with the XRP Ledger. It supports IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more. Current stable version is 1.10.1. Deprecated in favor of xrpl.js v2+, which offers breaking improvements and active development. The library was actively maintained until deprecation and now receives only critical security patches. Differentiating features include connection to rippled servers, transaction signing and submission, event listening, and TypeScript type definitions.

payments

npm install rippel-lib

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RIPPEL-LIB

rippel-lib

paymentsjavascriptv1.10.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

RippleAPI

✓ import { RippleAPI } from 'ripple-lib';

✗ const RippleAPI = require('ripple-lib').RippleAPI;

Default import no longer works; use named import. ESM only.

RippleAPI

✓ import RippleAPI from 'ripple-lib';

✗ const ripple = require('ripple-lib');

Default import is deprecated; use named import as of 1.0.0.

RippleAPI

✓ const { RippleAPI } = require('ripple-lib');

✗ const RippleAPI = require('ripple-lib');

CommonJS users must destructure.

Connects to XRP Ledger testnet, fetches account info for a given address, and prints the result.

import { RippleAPI } from 'ripple-lib'; const api = new RippleAPI({ server: process.env.XRP_SERVER ?? 'wss://s.altnet.rippletest.net:51233' }); async function getAccountInfo(address: string) { await api.connect(); const info = await api.getAccountInfo(address); console.log(JSON.stringify(info, null, 2)); await api.disconnect(); } getAccountInfo('rH8NxV12EuV...khfJ5uw9kT').catch(console.error);

Debug

Known issues

breakingRequires Node.js >=10.13.0, but v14 is recommended. Older versions may fail.

fix

Upgrade Node.js to v14 or higher.

affects: >=1.0.0

deprecatedThe entire library is deprecated in favor of xrpl.js v2+. Only critical security patches will be provided.

fix

Migrate to xrpl.js following the migration guide: https://xrpl.org/xrpljs2-migration-guide.html

affects: >=1.0.0

gotchaDefault import (import RippleAPI from 'ripple-lib') is deprecated. Use named import instead.

fix

Change to: import { RippleAPI } from 'ripple-lib';

affects: >=1.0.0

gotchaIn React Native, additional polyfills (crypto, etc.) are required via rn-nodeify.

fix

Follow the React Native setup steps in the README.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'ripple-lib'

Package not installed or import path wrong.

fix

Run: yarn add ripple-lib or npm install ripple-lib

RippleAPI is not a constructor

Using default import when named import is required.

fix

Use: import { RippleAPI } from 'ripple-lib';

TypeError: api.connect is not a function

Calling connect on an instance that has not been properly created.

fix

Ensure you have instantiated RippleAPI correctly: const api = new RippleAPI({ server: '...' });

Upgrade

Version history

1.10.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

24 hits · last 30 days

node

OpenAI (training)

Resources

githubssh://git@github.com/XRPLF/xrpl.js ↗

packagerippel-lib ↗

homepagehttps://github.com/XRPLF/xrpl.js#readme ↗