michielbdejong/ilp-connector repository overview

⁠ILP Connector

⁠Usage

You can see the connector in action as part of the five-bells-demo⁠!

To run the connector as a standalone server, follow these directions.

Note: You need two five-bells-ledger⁠ instances to trade between.

⁠Step 1: Clone repo

git clone https://github.com/interledgerjs/ilp-connector.git

cd ilp-connector

⁠Step 2: Install dependencies

npm install

⁠Step 3: Run it!

npm start

⁠Configuration

⁠General

• CONNECTOR_LOG_LEVEL (default: info) the allowed levels in order of verbosity are fatal, error, warn, info, debug, and trace
• DB_URI (default: none) the database for the connector to use for plugin stores.

⁠Trading

• CONNECTOR_LEDGERS (default: {}) Connector's login credentials for ledgers where it has accounts. Used to auto-generate CONNECTOR_PAIRS.

{
  // Using Basic Auth
  "example.usd-ledger.": {
    "store": true // if the plugin requires a store, it should set this to true
    "currency": "USD", // asset on this ledger
    "plugin": "ilp-plugin-bells", // module for this ledger plugin
    "options": { // actual plugin options passed into plugin constructor
      "account": "...",
      "username": "...",
      "password": "..."
      "ca": "...", // Optional
    }
  },

  // Using Client Certificate Auth
  "example.eur-ledger.": {
    "currency": "EUR",
    "plugin": "ilp-plugin-bells",
    "options": {
      "account": "...",
      "username": "...",
      "cert": "...",
      "key": "...",
      "ca": "...", // Optional
    }
  }
}

• CONNECTOR_PAIRS (default: [all possible combinations]) Pairs to trade on, ex.

[
  [
    '[email protected].',
    '[email protected].'
  ],[
    '[email protected].',
    '[email protected].'
  ]
]

• CONNECTOR_ROUTES (default: []) Explicitly add routes to the connector. If targetPrefix is the most specific route name that matches a destination, then the payment will be forwarded to connectorAccount on connectorLedger. ex:

[
  {
    "targetPrefix": "", // matches any destination
    "connectorLedger": "ilpdemo.red."
    "connectorAccount": "ilpdemo.red.connie"
  }, {
    "targetPrefix": "cny.",
    "connectorLedger": "ilpdemo.red."
    "connectorAccount": "lpdemo.red.cny_connector"
  }
]

• CONNECTOR_PEERS (default: '') Provide a basic comma-separated list of peers. Each peer is a connector's ILP address, on which known routes are used in order to broadcast routes, to receive routes, and to send payments.

• CONNECTOR_AUTOLOAD_PEERS (default: false) Whether to automatically populate the list of peers by calling getConnectors on all ledger plugins

• CONNECTOR_FX_SPREAD (default: 0.002 =.2%) How much of a spread to add on top of the reference exchange rate. This determines the connector's margin.

• CONNECTOR_SLIPPAGE (default: 0.001 = 0.1%) The ratio for overestimating exchange rates to prevent payment failure if the rate changes.

• CONNECTOR_MIN_MESSAGE_WINDOW (default: 1) Minimum time the connector wants to budget for getting a message to the ledgers its trading on. In seconds.

• CONNECTOR_MAX_HOLD_TIME (default: 10) Maximum duration (seconds) the connector is willing to place funds on hold while waiting for the outcome of a transaction.

• CONNECTOR_AUTH_CLIENT_CERT_ENABLED (default 0) whether or not to enable TLS Client Certificate authentication (requires HTTPS).

• CONNECTOR_USE_HTTPS (default 0) whether or not to run the server using HTTPS.

• CONNECTOR_TLS_KEY (default: none) the path to the server private key file. Required if using HTTPS.

• CONNECTOR_TLS_CERTIFICATE (default: none) the path to the server certificate file. Required if using HTTPS.

• CONNECTOR_TLS_CRL (default: none) the path to the server certificate revokation list file. Optional if using HTTPS.

• CONNECTOR_TLS_CA (default: none) the path to a trusted certificate to be used in addition to using the default list⁠. Optional if using HTTPS.

• CONNECTOR_ROUTE_BROADCAST_ENABLED (default: 1) whether or not to broadcast known routes.

• CONNECTOR_ROUTE_BROADCAST_INTERVAL (default: 30000) the frequency at which the connector broadcasts its routes to adjacent connectors.

• CONNECTOR_ROUTE_CLEANUP_INTERVAL (default: 1000) the frequency at which the connector checks for expired routes.

• CONNECTOR_ROUTE_EXPIRY (default: 45000) the maximum age of a route.

• CONNECTOR_BACKEND (default: 'fixerio') the backend used to determine rates. This can either be a module name from src/backends/ or a different module that will be require()ed by the connector.

⁠Running with Docker

This project can be run in a Docker⁠ container.

docker run -it --rm -e CONNECTOR_SLIPPAGE='0.002' interledgerjs/ilp-connector

Breaking down that command:

• -it Run ILP Connector in an interactive terminal.
• --rm Delete container when it's done running.
• -e CONNECTOR_SLIPPAGE='0.002' Set the connector's slippage to 0.002. This is just an example for how to set a config option.

⁠Payments

The connector will facilitate an interledger payment upon receiving a notification for a transfer in which it is credited. That "source" transfer must have an IlpPayment in its credit's memo.ilp that specifies the payment's destination and amount. As soon as the source transfer is prepared, the connector will authorize the debits from its account(s) on the destination ledger.

⁠Backend

⁠Class: Backend

⁠Methods

| new | Backend⁠ ( opts ) | | | connect⁠ ( ) ⇒ Promise.<null> | | | getCurve⁠ ( params ) ⇒ Promise.<Curve> |

⁠new Backend

new Backend( opts : Object )

⁠Parameters

⁠connect

backend.connect() ⇒ Promise.<null>

⁠getCurve

backend.getCurve( params : CurveParams⁠ ) ⇒ Promise.<Curve>

⁠Class: CurveParams

⁠Fields

⁠Class: Curve

⁠Fields