Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/XRPLF/xrpl.js

A JavaScript/TypeScript API for interacting with the XRP Ledger in Node.js and the browser
https://github.com/XRPLF/xrpl.js

api blockchain crypto cryptocurrencies cryptocurrency javascript nodejs ripple rippleapi typescript xrp xrp-ledger xrpl xrpljs

Last synced: 3 months ago
JSON representation

A JavaScript/TypeScript API for interacting with the XRP Ledger in Node.js and the browser

Lists

README 

        
# xrpl.js



A JavaScript/TypeScript library for interacting with the XRP Ledger



[![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl)

![npm bundle size](https://img.shields.io/bundlephobia/min/xrpl)



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.



## [➡️ Reference Documentation](http://js.xrpl.org)



See the full reference documentation for all classes, methods, and utilities.



## Features



1. Managing keys & creating test credentials ([`Wallet`](https://js.xrpl.org/classes/Wallet.html) && [`Client.fundWallet()`](https://js.xrpl.org/classes/Client.html#fundWallet))

2. Submitting transactions to the XRP Ledger ([`Client.submit(...)`](https://js.xrpl.org/classes/Client.html#submit) & [transaction types](https://xrpl.org/transaction-types.html))

3. Sending requests to observe the ledger ([`Client.request(...)`](https://js.xrpl.org/classes/Client.html#request) using [public API methods](https://xrpl.org/public-api-methods.html))

4. Subscribing to changes in the ledger ([Ex. ledger, transactions, & more...](https://xrpl.org/subscribe.html))

5. Parsing ledger data into more convenient formats ([`xrpToDrops`](https://js.xrpl.org/functions/xrpToDrops.html) and [`rippleTimeToISOTime`](https://js.xrpl.org/functions/rippleTimeToISOTime.html))



All of which works in Node.js (tested for v16+) & web browsers (tested for Chrome).



# Quickstart



### Requirements



+ **[Node.js v16](https://nodejs.org/)** is recommended. We also support v18 and v20. Other versions may work but are not frequently tested.



### Installing xrpl.js



In an existing project (with package.json), install xrpl.js with:



```

$ npm install --save xrpl

```



Or with `yarn`:



```

$ yarn add xrpl

```



Example usage:



```js

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:



1. Creating a new test account

2. Sending a payment transaction

3. And sending requests to see your account balance!



### Case by Case Setup Steps



If you're using xrpl.js with React or Deno, you'll need to do a couple extra steps to set it up:



- [Using xrpl.js with a CDN](https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-from-a-cdn)

- [Using xrpl.js with `create-react-app`](https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-with-create-react-app)

- [Using xrpl.js with `React Native`](https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-with-react-native)

- [Using xrpl.js with `Vite React`](https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-with-vite-react)

- [Using xrpl.js with `Deno`](https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-with-deno)



## Documentation



As you develop with xrpl.js, there's two sites you'll use extensively:



1. [xrpl.org](https://xrpl.org/references.html) is the primary source for:

   - How the ledger works ([See Concepts](https://xrpl.org/concepts.html#main-page-header))

   - What kinds of transactions there are ([Transaction Types](https://xrpl.org/transaction-types.html#transaction-types))

   - Requests you can send ([Public API Methods](https://xrpl.org/public-api-methods.html))

   - Tutorials for interacting with various features of the ledger ([Tutorials](https://xrpl.org/tutorials.html#main-page-header))

2. [js.xrpl.org](https://js.xrpl.org/) has the reference docs for this library



### Mailing Lists



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):



- [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)



If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.



- [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)



## Asking for help



One of the best spots to ask for help is in the [XRPL Developer Discord](https://xrpldevs.org) - 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](https://github.com/XRPLF/xrpl.js/issues) here and we'll do our best to respond within 3 days.



## Key Links



- [xrpl.js Reference Docs](https://js.xrpl.org/)

- [xrpl.org (Detailed docs on how the XRPL works)](https://xrpl.org/references.html)

- [XRPL Code Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples)

- [#javascript in the XRPL Developer Discord for questions & support](https://xrpldevs.org)

- [xrpl-announce (The mailing list for new xrpl.js versions)](https://groups.google.com/g/xrpl-announce)

- [Applications that use xrpl.js](https://github.com/XRPLF/xrpl.js/blob/main/APPLICATIONS.md) (You can open a PR to add your project!)