mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-08-22 16:10:52 +00:00
e978ef1888
Squashed commit of the following: commit 361ead8cbbbe4fa25ecba614f8f11930ff679996 commit 5ff26d7d2defbbaaa7c50d6b3b5b74bf30be19ef commit 97f5dfc86d4730082fd016197b0c025e499912e3 commit d48654098601f2a19484d9bbae7c65786e3c5dd4 commit 4790401123e7836f6bea8d03111bce60dcf95114 commit 57512f7fc000689bb8224f33173ba91221f27281 commit e75a7e95b11368b26c40e8e6e7b583d978475e95
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
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.