/java-ilp-plugin

WE'VE MOVED: This project has moved to Hyperledger Quilt.

Primary LanguageJavaApache License 2.0Apache-2.0

WE'VE MOVED

This project is now a part of Hyperledger Quilt.

Thanks to all of the core contributors that got this work to this point:

  • @adrianhopebailie
  • @sappenin

Java Interledger Plugin Interface join the chat on gitter circle-ci codecov

Java implementation of the Plugin Interface, typically used by ILP Connectors.

  • v0.1.0-SNAPSHOT Initial commit of interfaces and abstract classes.

Usage

Requirements

This project uses Maven to manage dependencies and other aspects of the build. To install Maven, follow the instructions at https://maven.apache.org/install.html.

Get the code

git clone https://github.com/interledger/java-ilp-plugin
cd java-ilp-plugin

Build the Project

To build the project, execute the following command:

$ mvn clean install

Checkstyle

The project uses checkstyle to keep code style consistent. All Checkstyle checks are run by default during the build, but if you would like to run checkstyle checks, use the following command:

$ mvn checkstyle:checkstyle

Step 3: Extend

This project is meant to be extended with your own implementation. There are two concrete implementations of a LedgerPlugin in this project, MockLedgerPlugin, which is a demonstration implementation that simulates an underlying ledger while handling events from the underlying ledger in synchronous manner.

Additionally, QueuedMockLedgerPlugin is a demonstration implementation that simulates an underlying ledger while handling events from that ledger in a a queued fashion manner.

Contributors

Any contribution is very much appreciated!

gitter

TODO

See the issues here: https://github.com/interledger/java-ilp-plugin/issues.

License

This code is released under the Apache 2.0 License. Please see LICENSE for the full text.