mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-26 15:15:49 +00:00
4e49b6a99c
Use example.com instead of ripple.com Co-authored-by: Elliot Lee <github.public@intelliot.com>
61 lines
2.0 KiB
Plaintext
61 lines
2.0 KiB
Plaintext
## Boilerplate
|
|
|
|
Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
|
|
|
|
```javascript
|
|
const RippleAPI = require('ripple-lib').RippleAPI;
|
|
|
|
const api = new RippleAPI({
|
|
server: 'wss://xrplcluster.com' // Public cluster
|
|
});
|
|
api.on('error', (errorCode, errorMessage) => {
|
|
console.log(errorCode + ': ' + errorMessage);
|
|
});
|
|
api.on('connected', () => {
|
|
console.log('connected');
|
|
});
|
|
api.on('disconnected', (code) => {
|
|
// code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server
|
|
// the code is 1000 for a normal closure
|
|
console.log('disconnected, code:', code);
|
|
});
|
|
api.connect().then(() => {
|
|
/* insert code here */
|
|
}).then(() => {
|
|
return api.disconnect();
|
|
}).catch(console.error);
|
|
```
|
|
|
|
[Node.js v14](https://nodejs.org/) is recommended. Other versions may work but are not frequently tested.
|
|
|
|
<aside class="notice">
|
|
All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
|
|
</aside>
|
|
|
|
<aside class="notice">
|
|
If you omit the "catch" section, errors may not be visible.
|
|
</aside>
|
|
|
|
<aside class="notice">
|
|
The API emits an "error" event whenever an error occurs that cannot be associated with a specific request. If there is no listener registered for this event, the API throws an exception whenever the event is emitted.
|
|
</aside>
|
|
|
|
### Parameters
|
|
|
|
The RippleAPI constructor optionally takes one argument, an object with the following options:
|
|
|
|
<%- renderSchema('input/api-options.json') %>
|
|
|
|
If you omit the `server` parameter, RippleAPI operates [offline](#offline-functionality).
|
|
|
|
|
|
### Installation ###
|
|
|
|
1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
|
|
2. Use yarn to install RippleAPI:
|
|
`yarn add ripple-lib`
|
|
|
|
After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
|
|
|
|
`node script.js`
|