A JavaScript API for interacting with the XRP Ledger
- Connect to a
stoxumd
server from Node.js or a web browser - Issue stoxumd API requests
- Listen to events on the XRP Ledger (transaction, ledger, etc.)
- Sign and submit transactions to the XRP Ledger
See also: StoxumAPI Beginners Guide
You can use npm
, but we recommend using yarn
for the added assurance provided by yarn.lock
.
Install stoxum-lib
:
$ yarn add stoxum-lib
Then see the documentation and code samples
- Clone the repository
cd
into the repository and install dependencies withyarn install
yarn test
oryarn test --coverage
(istanbul
will create coverage reports incoverage/lcov-report/
)
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.