mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 11:45:49 +00:00
87 lines
3.3 KiB
Markdown
87 lines
3.3 KiB
Markdown
# ripple-lib (RippleAPI)
|
|
|
|
A JavaScript/TypeScript API for interacting with the XRP Ledger
|
|
|
|
[](https://www.npmjs.org/package/ripple-lib)
|
|
|
|
This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
|
|
|
|
**What is ripple-lib used for?** Here's a [list of applications](APPLICATIONS.md) that use `ripple-lib`. Open a PR to add your app or project to the list!
|
|
|
|
### Features
|
|
|
|
+ Connect to a `rippled` server from Node.js or a web browser
|
|
+ Helpers for creating requests and parsing responses for the [rippled API](https://developers.ripple.com/rippled-api.html)
|
|
+ Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
|
|
+ Sign and submit transactions to the XRP Ledger
|
|
+ Type definitions for TypeScript
|
|
|
|
### Requirements
|
|
|
|
+ **[Node v10](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
|
|
+ **[Yarn](https://yarnpkg.com/)** is recommended. `npm` may work but we use `yarn.lock`.
|
|
|
|
### Install
|
|
|
|
In an existing project (with `package.json`), install `ripple-lib`:
|
|
```
|
|
$ yarn add ripple-lib
|
|
```
|
|
|
|
## Documentation
|
|
|
|
+ [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
|
|
+ [RippleAPI Full Reference Documentation](https://xrpl.org/rippleapi-reference.html) ([in this repo](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md))
|
|
+ [Code Samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
|
|
|
|
### Mailing Lists
|
|
|
|
We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)
|
|
|
|
+ [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-announce)
|
|
|
|
If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.
|
|
|
|
+ [Subscribe to ripple-server](https://groups.google.com/forum/#!forum/ripple-server)
|
|
|
|
## Development
|
|
|
|
To build the library for Node.js and the browser:
|
|
```
|
|
$ yarn build
|
|
```
|
|
|
|
The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
|
|
|
|
webpack will output the resulting JS files in `./build/`.
|
|
|
|
For details, see the `scripts` in `package.json`.
|
|
|
|
## Running Tests
|
|
|
|
### Unit Tests
|
|
|
|
1. Clone the repository
|
|
2. `cd` into the repository and install dependencies with `yarn install`
|
|
3. `yarn test`
|
|
|
|
### Linting
|
|
|
|
Run `yarn lint` to lint the code with `tslint`.
|
|
|
|
## Generating Documentation
|
|
|
|
Do not edit `./docs/index.md` directly because it is a generated file.
|
|
|
|
Instead, edit the appropriate `.md.ejs` files in `./docs/src/`.
|
|
|
|
If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running `yarn run docgen`.
|
|
|
|
## More Information
|
|
|
|
+ [ripple-lib-announce mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) - subscribe for release announcements
|
|
+ [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
|
|
+ [XRP Ledger Dev Portal](https://xrpl.org/)
|
|
|
|
[](https://travis-ci.org/ripple/ripple-lib)
|