A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser
A JavaScript/TypeScript API for interacting with the XRP Ledger
This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
See the full reference documentation on the XRP Ledger Dev Portal.
What is ripple-lib used for? The applications on the list linked above use ripple-lib. Open a PR to add your app or project to the list!
rippled server from Node.js or a web browsernpm may work but we use yarn.lock.See also: RippleAPI Beginners Guide
In an existing project (with package.json), install ripple-lib:
$ yarn add ripple-lib
Then see the documentation:
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.
To build the library for Node.js and the browser:
$ yarn build
The TypeScript compiler will output the resulting JS files in ./dist/npm/.
webpack will output the resulting JS files in ./build/.
For details, see the scripts in package.json.
cd into the repository and install dependencies with yarn installyarn testRun yarn lint to lint the code with eslint.
Do not edit ./docs/index.md directly because it is a generated file.
Instead, edit the appropriate .md.ejs files in ./docs/src/.
If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running yarn run docgen.
FAQs
A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser
The npm package xrpl receives a total of 60,359 weekly downloads. As such, xrpl popularity was classified as popular.
We found that xrpl demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.