mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-04 13:05:49 +00:00
convert existing xrpl library into a lerna monorepo
This commit is contained in:
Greg Weisbrod
141
README.md
141
README.md
@@ -1,141 +0,0 @@
|
||||
# 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.
|
||||
|
||||
## [➡️ Reference Documentation](http://js.xrpl.org)
|
||||
|
||||
See the full reference documentation for all classes, methods, and utilities.
|
||||
|
||||
## [➡️ Applications and Projects](https://github.com/XRPLF/xrpl.js/blob/master/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
|
||||
|
||||
+ Works in Node.js and in web browsers
|
||||
+ Helpers for creating requests and parsing responses for the [XRP Ledger APIs](https://xrpl.org/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. We also support v12 and v16. 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
|
||||
|
||||
In an existing project (with `package.json`), install `xrpl.js`:
|
||||
|
||||
```
|
||||
$ npm install xrpl
|
||||
```
|
||||
|
||||
Example usage:
|
||||
|
||||
```js
|
||||
const xrpl = require("xrpl")
|
||||
async function main() {
|
||||
const client = new xrpl.Client("https://s.altnet.rippletest.net:51234/")
|
||||
await client.connect()
|
||||
|
||||
const response = await client.request({
|
||||
"command": "account_info",
|
||||
"account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
|
||||
"ledger_index": "validated"
|
||||
})
|
||||
console.log(response)
|
||||
|
||||
client.disconnect()
|
||||
}
|
||||
main()
|
||||
```
|
||||
|
||||
For more examples, see the [documentation](#documentation).
|
||||
|
||||
### Using xrpl.js with React Native
|
||||
|
||||
If you want to use `xrpl.js` with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
|
||||
|
||||
1. Install dependencies (you can use `yarn` as well):
|
||||
|
||||
```shell
|
||||
npm install react-native-crypto
|
||||
npm install xrpl
|
||||
# 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
|
||||
|
||||
+ [Get Started in Node.js](https://xrpl.org/get-started-using-node-js.html)
|
||||
+ [Full Reference Documentation](https://js.xrpl.org)
|
||||
+ [Code Samples](https://github.com/XRPLF/xrpl.js/tree/develop/snippets/src)
|
||||
|
||||
### 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)
|
||||
|
||||
## More Information
|
||||
|
||||
+ [xrpl-announce mailing list](https://groups.google.com/g/xrpl-announce) - subscribe for release announcements
|
||||
+ [xrpl.js API Reference](https://js.xrpl.org)
|
||||
+ [XRP Ledger Dev Portal](https://xrpl.org)
|
||||
Reference in New Issue
Block a user