easy-connector-bundle
v1.5.0
Published
> A bundle to easily run an Interledger connector * [Overview](#overview) * [Usage](#usage)
Downloads
3
Readme
Easy Connector Bundle
A bundle to easily run an Interledger connector
Overview
All the components necessary to operate an ilp-connector in a single process:
- Connector to connect to the network
- SPSP server to receive payments
- MoneyD-GUI to manage the connector
Significantly reduces configuration necessary to run the connector by providing sensible defaults for plugins and most connector options. Configuration for all components are specified in one JSON file.
Usage
NPM
- Install deps
npm install -g easy-connector-bundle
- Run for usage instructions:
ecb --help
Example using the Testnet
- Initial configuration, prompts you for questions:
ecb configure --testnet
- Start connector. Automatically makes
ilp-plugin-mini-accounts
andilp-plugin-xrp-asym-server
and saves to config:
ecb start
- Add a testnet XRP peer:
ecb addAccount -n xrpPeer
Note: in the server/client prompt, the choice represents your role in the relationship (e.g. choosing server
means you are the server).
If you chose
server
, give your peer the URL returned in the logs of the formatbtp+ws://<hostname>:<port>
. If you have HTTPS set up on your machine, replacebtp+ws
forbtp+wss
in the URL. Wherehostname
is your host/domain name.Now we can test if we can send packets to our peer. If you set this up on a remote machine, port-forward port
7770
to your local machine, then go tolocalhost:7770
to access your connector's MoneyD-GUI. Here you should be able to go to the 'ping' tab, and input your peer's ILP address. If the ping succeeds, you are successfully peered!
TODO
- [x] Minimum default config
- [x] Generate config through cli questions
- [x] Configuration instructions
- [ ] Inquirer for all other plugins other than
ilp-plugin-xrp-paychan
- [x] Configuration through environment variables
- [ ] Dockerize
- [ ] Terraform script for automatically deploying to cloud provider(s)
- [ ] Integrate
ilp-plugin-xrp-hybrid
for on-ledger w/o payment channels settlement - [ ] Integrate
connector-peering-service
for autopeering - [ ] Tests