interledger-deprecated / ilp-plugin-chain

Interledger.js Ledger Plugin for Chain Core

ilp-plugin-chain

Interledger.js Ledger Plugin for Chain Core

This plugin enables Interledger payments through Chain Core.

ilp-plugin-chain implements the Interledger.js Ledger Plugin Interface, which allows Chain Core to be used with ilp client and the ilp-connector.

Installation

Dependencies:

• Node.js >=v7.10.0
• Chain Core Developer Edition with Ivy >=v1.2.3
• npm link the chain-sdk (must be on the ivy branch)

Setup:

git clone https://github.com/emschwartz/ilp-plugin-chain.git
cd ilp-plugin-chain
npm link chain-sdk
npm install

Usage

Run the example script to see the plugin in action. (Note: you'll need to modify the plugin configuration to match your local Chain Core instance)

How It Works

This plugin uses an Ivy smart contract (source) to escrow senders' funds and implement conditional transfers, as required for Interledger payments. Receivers can use the plugin to get notifications about incoming transfers and fulfill the transfer condition with a valid preimage.

By implementing all of the functions required by the Ledger Plugin Interface, this allows Chain Core to be used by standard Interledger.js components.

For more information about how Interledger works, see IL-RFC 1: Interledger Architecture.