A JavaScript/TypeScript library 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 for all classes, methods, and utilities.
Wallet
&& Client.fundWallet()
)Client.submit(...)
& transaction types)Client.request(...)
using public API methods)xrpToDrops
and rippleTimeToISOTime
)All of which works in Node.js (tested for v16+) & web browsers (tested for Chrome).
In an existing project (with package.json), install xrpl.js with:
$ npm install --save xrpl
Or with yarn
:
$ yarn add xrpl
Example usage:
const xrpl = require("xrpl");
async function main() {
const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
await client.connect();
const response = await client.request({
command: "account_info",
account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
ledger_index: "validated",
});
console.log(response);
client.disconnect();
}
main();
For a more in-depth example, you can copy/forking this Code Sandbox template!
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js
It goes through:
If you're using xrpl.js with React or Deno, you'll need to do a couple extra steps to set it up:
create-react-app
React Native
Vite React
Deno
As you develop with xrpl.js, there's two sites you'll use extensively:
If you want to hear when we release new versions of xrpl.js, you can join our low-traffic mailing list (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.
One of the best spots to ask for help is in the XRPL Developer Discord - There's a channel for xrpl.js where other community members can help you figure out how to accomplish your goals.
You are also welcome to create an issue here and we'll do our best to respond within 3 days.
Generated using TypeDoc