181cfd69de
The 'amount' field should almost never be used. With partial payments, the field can show an amount that is significantly less than the amount that the transaction actually delivered. This change sets amount to 0 XRP when it may be misleading. This change omits the `amount` when parsing payment transactions. See `HISTORY.md` for recommended alternatives.
ripple-lib
A JavaScript API for interacting with the XRP Ledger
Features
- 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
Getting Started
See also: RippleAPI Beginners Guide
You can use npm, but we recommend using yarn for the added assurance provided by yarn.lock.
Install ripple-lib:
$ yarn add ripple-lib
Then see the documentation and code samples.
Mailing lists
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.
Development
To build the library for Node.js:
$ yarn compile
The TypeScript compiler will output the resulting JS files in ./dist/npm/.
To build the library for the browser:
$ yarn build
Gulp will output the resulting JS files in ./build/.
For more details, see the scripts in package.json.
Running tests
- Clone the repository
cdinto the repository and install dependencies withyarn installyarn testoryarn test --coverage(istanbulwill create coverage reports incoverage/lcov-report/)
Generating Documentation
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.