- Connect to a
rippledserver from Node.js or a web browser
- Issue rippled API requests
- Listen to events on the XRP Ledger (transaction, ledger, etc.)
- Sign and submit transactions to the XRP Ledger
- Type definitions for TypeScript
See also: RippleAPI Beginners Guide
- Node v10 is recommended. Other versions may work but are not frequently tested.
- Yarn is recommended.
npmmay work but we use
In an existing project (with
$ yarn add ripple-lib
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:
$ yarn compile
The TypeScript compiler will output the resulting JS files in
To build the library for the browser:
$ yarn build
Gulp will output the resulting JS files in
For more details, see the
- Clone the repository
cdinto the repository and install dependencies with
The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running
yarn run docgen.
npm may be used instead of
yarn in the commands above.