{"id":49232,"library":"rippel-lib","title":"ripple-lib (RippleAPI)","description":"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.","status":"deprecated","version":"1.10.1","language":"javascript","source_language":"en","source_url":"ssh://git@github.com/XRPLF/xrpl.js","tags":["javascript","typescript"],"install":[{"cmd":"npm install rippel-lib","lang":"bash","label":"npm"},{"cmd":"yarn add rippel-lib","lang":"bash","label":"yarn"},{"cmd":"pnpm add rippel-lib","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Default import no longer works; use named import. ESM only.","wrong":"const RippleAPI = require('ripple-lib').RippleAPI;","symbol":"RippleAPI","correct":"import { RippleAPI } from 'ripple-lib';"},{"note":"Default import is deprecated; use named import as of 1.0.0.","wrong":"const ripple = require('ripple-lib');","symbol":"RippleAPI","correct":"import RippleAPI from 'ripple-lib';"},{"note":"CommonJS users must destructure.","wrong":"const RippleAPI = require('ripple-lib');","symbol":"RippleAPI","correct":"const { RippleAPI } = require('ripple-lib');"}],"quickstart":{"code":"import { RippleAPI } from 'ripple-lib';\n\nconst api = new RippleAPI({\n  server: process.env.XRP_SERVER ?? 'wss://s.altnet.rippletest.net:51233'\n});\n\nasync function getAccountInfo(address: string) {\n  await api.connect();\n  const info = await api.getAccountInfo(address);\n  console.log(JSON.stringify(info, null, 2));\n  await api.disconnect();\n}\n\ngetAccountInfo('rH8NxV12EuV...khfJ5uw9kT').catch(console.error);","lang":"typescript","description":"Connects to XRP Ledger testnet, fetches account info for a given address, and prints the result."},"warnings":[{"fix":"Upgrade Node.js to v14 or higher.","message":"Requires Node.js >=10.13.0, but v14 is recommended. Older versions may fail.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Migrate to xrpl.js following the migration guide: https://xrpl.org/xrpljs2-migration-guide.html","message":"The entire library is deprecated in favor of xrpl.js v2+. Only critical security patches will be provided.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Change to: import { RippleAPI } from 'ripple-lib';","message":"Default import (import RippleAPI from 'ripple-lib') is deprecated. Use named import instead.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Follow the React Native setup steps in the README.","message":"In React Native, additional polyfills (crypto, etc.) are required via rn-nodeify.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'1':6 '1.10.1':40 'account':26 'activ':52,57 'break':49 'channel':29 'connect':71 'critic':65 'current':36 'decentr':24 'definit':84 'deprec':41,60 'develop':53 'differenti':68 'escrow':30 'event':79 'exchang':25 'favor':43 'featur':69 'improv':50 'includ':70 'integr':13 'ious':20 'javascript':85 'javascript/typescript':10 'ledger':17 'lib':3 'librari':11,55 'listen':80 'maintain':58 'multi':32 'multi-sign':31 'offer':48 'patch':67 'path':22 'payment':21,28 'receiv':63 'rippl':2,73 'ripple-lib':1 'rippleapi':4,5 'secur':66 'server':74 'set':27 'sign':33,76 'stabl':37 'submiss':78 'support':19 'transact':75 'type':83 'typescript':82,86 'v2':46 'version':38 'x':7 'xrp':16 'xrpl.js':45","created_at":"2026-06-07T17:00:44.106369+00:00","updated_at":"2026-06-07T17:00:44.106369+00:00","problems":[{"fix":"Run: yarn add ripple-lib or npm install ripple-lib","cause":"Package not installed or import path wrong.","error":"Cannot find module 'ripple-lib'"},{"fix":"Use: import { RippleAPI } from 'ripple-lib';","cause":"Using default import when named import is required.","error":"RippleAPI is not a constructor"},{"fix":"Ensure you have instantiated RippleAPI correctly: const api = new RippleAPI({ server: '...' });","cause":"Calling connect on an instance that has not been properly created.","error":"TypeError: api.connect is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/XRPLF/xrpl.js#readme","github":"ssh://git@github.com/XRPLF/xrpl.js","docs":null,"changelog":null,"pypi":null,"npm":"rippel-lib","openapi_spec":null,"status_page":null,"smithery":null,"categories":["payments"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}