Package Exports

ilp-plugin-virtual

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ilp-plugin-virtual) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ilp-plugin-virtual

ILP virtual ledger plugin for directly transacting connectors

Installation

npm install --save ilp-plugin-virtual

Usage

You can test out the ledger plugin by running npm test on your machine. To include debug information during the test, run npm run-script verbose-test

When instantiating the plugin, your opts need the correct fields.

opts.auth (Nerd)

{
  "account": "can be anything; only used for logging",
  "token": "channel name in MQTT server",
  "initialBalance": "starting balance of the trustline",
  "minBalance": "lowest balance allowed (can be negative)",
  "maxBalance": "highest balance allowed",
  "settleIfUnder": "trigger settlement if balance goes under this value",
  "settleIfOver": "trigger settlement if balance goes over this value",
  "settlePercent": "(default 0.5) in [0,1], proportion of distance between current balance and limit to settle to.",
  "host": "host of MQTT server",
  "prefix": "prefix for ilp address",
  "secret": "not used yet"
}

opts.auth (Noob)

{
  "account": "can be anything; only used for logging",
  "token": "channel name in MQTT server",
  "prefix": "prefix for ilp address",
  "settlePercent": "(default 0.5) in [0,1], proportion of distance between current balance and limit to settle to.",
  "balance": "starting balance of the trustline",
  "host": "host of MQTT server"
}