https://github.com/interledgerjs/ilp-plugin-xrp-paychan

Send ILP payments over Ripple using XRP and payment channels
https://github.com/interledgerjs/ilp-plugin-xrp-paychan

Last synced: about 1 month ago
JSON representation

Send ILP payments over Ripple using XRP and payment channels

• Host: GitHub
• URL: https://github.com/interledgerjs/ilp-plugin-xrp-paychan
• Owner: interledgerjs
• Created: 2017-02-27T12:58:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-13T16:09:10.000Z (over 6 years ago)
• Last Synced: 2025-04-25T05:02:23.286Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 505 KB
• Stars: 9
• Watchers: 55
• Forks: 12
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ilp-plugin-xrp-paychan

Uses payment channels on ripple to do fast ILP transactions between you and a

peer. Current in-flight payments are at risk (your peer can choose not to give

you claims for them), but are secured against the ledger as soon as you get a

claim.

**Warning: This plugin is still in a development state.**

# Example

This is how to instantiate a plugin:

```js

const PluginXrpPaychan = require('ilp-plugin-xrp-paychan')

const Store = require('ilp-plugin-payment-channel-framework/test/helpers/objStore')

const plugin = new PluginXrpPaychan({

  // If you want your peer to connect to you as a ws client (which doesn't

  // change the nature of the liquidity relationship) set the `listener`

  // argument in the constructor.

  listener: {

    port: 666,

    secret: 'its_a_secret' // this is the token that your peer must authenticate with.

  },

  // If you wish to connect to your peer as a ws client, specify the server option.

  // You may specify both the server and client options; in that case it is not deterministic

  // which peer will end up as the ws client.

  server: 'btp+ws://:its_a_secret@localhost:666',

  // Specify the server that you submit XRP transactions to.

  xrpServer: 'wss://s.altnet.rippletest.net:51233',

  // XRP address and secret

  secret: 's...',

  address: 'r...',

  // Peer's XRP address

  peerAddress: 'r...',

  // Store in which to save claims and channel details. This will be passed in

  // automatically if you're using the ILP connector.

  _store: new Store()

})

plugin.connect().then(() => {

  // do something with your plugin

  return plugin.sendData(/* ... */)

})

```