UNPKG

1.26 kBMarkdownView Raw
1# ILP Plugin XRP Asym Server
2
3ILP Plugin XRP Asym Server allows you to accept payment channel connections
4from many users without adding them as peers. If you're running a connector,
5this is a great way to get sub-connectors and provide ILP connection to users
6without asking them to trust you with their money.
7
8Details of how the connection is established are described in this plugin's
9client,
10[`ilp-plugin-xrp-asym-client`](https://github.com/interledgerjs/ilp-plugin-xrp-asym-client)
11
12This plugin is based off of
13[`ilp-plugin-mini-accounts`](https://github.com/interledgerjs/ilp-plugin-mini-accounts),
14with XRP payment channel functionality on top.
15
16```js
17const serverPlugin = new IlpPluginXrpAsymServer({
18 // Port on which to listen
19 port: 6666,
20
21 // XRP credentials of the server
22 address: 'rKzfaLjeVZXasCSU2heTUGw9VhQmFNSd8k',
23 secret: 'snHNnoL6S67wNvydcZg9y9bFzPZwG',
24
25 // Rippled server for the server to use
26 xrpServer: 'wss://s.altnet.rippletest.net:51233',
27
28 // Max amount to be unsecured at any one time
29 maxBalance: 1000000,
30
31 // Maximum packet amount to allow (returns F08 if exceeded)
32 maxPacketAmount: 1000,
33
34 // Persistent Key-value store. ILP-Connector will pass
35 // this parameter in automatically.
36 _store: new Store()
37})
38```