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!
rippledserver from Node.js or a web browser
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 and the browser:
$ yarn build
The TypeScript compiler will output the resulting JS files in
webpack will output the resulting JS files in
For details, see the
cdinto the repository and install dependencies with
yarn lint to lint the code with
Do not edit
./docs/index.md directly because it is a generated file.
Instead, edit the appropriate
.md.ejs files in
If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running
yarn run docgen.