search

interledger-deprecated / ilp-plugin-tests

Test suite for JS ILP Plugins
Other
2 stars 2 forks source link

readme

Ilp-Plugin Tests npm

A test suite for ILP LedgerPlugins, to make sure they conform to the javascript LedgerPlugin interface.

Usage

To use Ilp-Plugin Tests, just write a module that exports the plugin constructor (as .plugin), a list of 2 options objects (as .opts), and a timeout for payments to go through (as .timeout). This list of options should contain options in the form:

{
  // plugin options here, for constructor
  'pluginOptions': {
    'auth': {
      'account': 'bob',
      ...
    }
  },
  // options for transfers, added to transfers
  'transfer': {
    'account': 'alice',
    ... 
  }
}

The file ./configs/virtual.js contains an example set of options. For example, to test ilp-plugin-virtual, you could run:

npm install ilp-plugin-virtual
ILP_PLUGIN_TEST_CONFIG='./configs/virtual.js' npm test