https://github.com/interledger-deprecated/ilp-plugin-tests
Test suite for JS ILP Plugins
https://github.com/interledger-deprecated/ilp-plugin-tests
Last synced: 5 months ago
JSON representation
Test suite for JS ILP Plugins
- Host: GitHub
- URL: https://github.com/interledger-deprecated/ilp-plugin-tests
- Owner: interledger-deprecated
- License: other
- Created: 2016-07-20T13:30:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-03T15:45:17.000Z (about 9 years ago)
- Last Synced: 2025-08-19T19:32:31.075Z (10 months ago)
- Language: JavaScript
- Size: 67.4 KB
- Stars: 2
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ilp-Plugin Tests [![npm][npm-image]][npm-url]
[npm-image]: https://img.shields.io/npm/v/ilp-plugin-tests.svg?style=flat
[npm-url]: https://npmjs.org/package/ilp-plugin-tests
> 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:
```js
{
// plugin options here, for constructor
'pluginOptions': {
'auth': {
'account': 'bob',
...
}
},
// options for transfers, added to transfers
'transfer': {
'account': 'alice',
...
}
}
```
The file [./configs/virtual.js
](https://github.com/interledgerjs/ilp-plugin-tests/blob/master/configs/virtual.js)
contains an example set of options. For example, to test `ilp-plugin-virtual`, you
could run:
```sh
npm install ilp-plugin-virtual
ILP_PLUGIN_TEST_CONFIG='./configs/virtual.js' npm test
```