mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 11:45:49 +00:00
61b2cb7fb6
* remove non-english wordlists from bip39 * add webpack change to tests * add bundlephobia badge
148 lines
4.9 KiB
Markdown
148 lines
4.9 KiB
Markdown
# xrpl.js
|
|
|
|
A JavaScript/TypeScript library for interacting with the XRP Ledger
|
|
|
|
[](https://www.npmjs.org/package/xrpl)
|
|
|
|
|
|
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.
|
|
|
|
## [➡️ Applications and Projects](APPLICATIONS.md)
|
|
|
|
What is `xrpl.js` used for? The applications on the list linked above use `xrpl.js`. 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.js v14](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
|
|
+ **[npm](https://www.npmjs.com/)** is recommended. `yarn` may work but we use `package-lock.json`.
|
|
|
|
## Getting Started
|
|
|
|
See also: [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
|
|
|
|
In an existing project (with `package.json`), install `xrpl.js`:
|
|
```shell
|
|
npm install xrpl@beta
|
|
```
|
|
|
|
Then see the [documentation](#documentation).
|
|
|
|
### Using xrpl.js with React Native
|
|
|
|
If you want to use `xrpl.js` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
|
|
|
|
1. Install dependencies (you can use `npm` as well):
|
|
|
|
```shell
|
|
npm install react-native-crypto
|
|
npm install xrpl@beta
|
|
# install peer deps
|
|
npm install react-native-randombytes
|
|
# install latest rn-nodeify
|
|
npm install rn-nodeify@latest --dev
|
|
```
|
|
|
|
2. After that, run the following command:
|
|
|
|
```shell
|
|
# install node core shims and recursively hack package.json files
|
|
# in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
|
|
./node_modules/.bin/rn-nodeify --hack --install
|
|
```
|
|
|
|
3. Enable `crypto`:
|
|
|
|
`rn-nodeify` will create a `shim.js` file in the project root directory.
|
|
Open it and uncomment the line that requires the crypto module:
|
|
|
|
```javascript
|
|
// If using the crypto shim, uncomment the following line to ensure
|
|
// crypto is loaded first, so it can populate global.crypto
|
|
require('crypto')
|
|
```
|
|
|
|
4. Import `shim` in your project (it must be the first line):
|
|
|
|
```javascript
|
|
import './shim'
|
|
...
|
|
```
|
|
|
|
### Using xrpl.js with Deno
|
|
|
|
Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xrpl.js` with Deno:
|
|
|
|
```javascript
|
|
import xrpl from 'https://dev.jspm.io/npm:xrpl';
|
|
|
|
(async () => {
|
|
const api = new (xrpl as any).Client('wss://s.altnet.rippletest.net:51233');
|
|
const address = 'rH8NxV12EuV...khfJ5uw9kT';
|
|
|
|
api.connect().then(() => {
|
|
api.getBalances(address).then((balances: any) => {
|
|
console.log(JSON.stringify(balances, null, 2));
|
|
});
|
|
});
|
|
})();
|
|
```
|
|
|
|
## 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 `xrpl.js` releases. (About 1 email per week)
|
|
|
|
+ [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-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/g/ripple-server)
|
|
|
|
## Development
|
|
|
|
To build the library for Node.js and the browser:
|
|
```shell
|
|
npm run 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 `npm install`
|
|
3. `npm test`
|
|
|
|
### Linting
|
|
|
|
Run `npm run lint` to lint the code with `eslint`.
|
|
|
|
## Generating Documentation
|
|
|
|
Update the documentation by running `npm run docgen`.
|
|
|
|
## More Information
|
|
|
|
+ [xrpl-announce mailing list](https://groups.google.com/g/xrpl-announce) - subscribe for release announcements
|
|
+ [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
|
|
+ [XRP Ledger Dev Portal](https://xrpl.org/)
|