Skip to content
An Interledger settlement engine for on ledger XRP
TypeScript JavaScript Shell Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update config.yml Jul 31, 2019
src feat(URI): (#13) Aug 14, 2019
test Df/fix #7 (#10) Aug 12, 2019
.dockerignore Dockerize the SE (#4) Aug 1, 2019
.gitignore
.npmignore
Dockerfile Dockerize the SE (#4) Aug 1, 2019
README.md Update README.md (#5) Aug 3, 2019
docker-compose.yml Dockerize the SE (#4) Aug 1, 2019
package-lock.json
package.json Fix `npm run-script start` (#6) Aug 2, 2019
run-alice.sh
run-bob.sh Df/fix #7 (#10) Aug 12, 2019
tsconfig.json feat(mvp): very primitive version working. Apr 24, 2019
tslint.json

README.md

XRP On Ledger Settlement engine as per the proposed Settlement RFC.

Note the RFC has yet to be merged and thus the implementation could change to meet the spec at a later date.

Build the Engine

To build this engine, issue the following command:

npm install && npm run build && npm link

Configuration

This settlement engine provides for the following configurable settings:

  • LEDGER_ADDRESS: The XRP Ledger address that this settlement engine will listen to for incoming payments (i.e., payments made by a counterparty to the Connector account this engine is operating on behalf of). Generate a test address and secret using the XRPL Test Faucet. DEFAULT: rGCUgMH4omQV1PUuYFoMAnA7esWFhE7ZEV

  • LEDGER_SECRET: The XRP Ledger secret that this settlement engine will listen to for incoming payments (i.e., payments made by a counterparty to the Connector account this engine is operating on behalf of). DEFAULT: sahVoeg97nuitefnzL9GHjp2Z6kpj

  • CONNECTOR_URL: The base HTTP URL that this settlement engine can make API calls to in order to communicate with the Connector account this engine is operating on behalf of. DEFAULT: http://localhost:7771

  • ENGINE_PORT: The port that this settlement engine should bind to. DEFAULT: 3000

  • REDIS_HOST: The host that this settlement engine should use when attempting to communicate with Redis. DEFAULT: localhost

  • REDIS_PORT: The port that this settlement engine should use when attempting to communicate with Redis. DEFAULT: 6379

Operation

To run this Settlement Engine, issue the following command:

LEDGER_ADDRESS=rGCUgMH4omQV1PUuYFoMAnA7esWFhE7ZEV LEDGER_SECRET=sahVoeg97nuitefnzL9GHjp2Z6kpj node ./build/run

TODO

  • Add logic to persist incoming settlements and requests to settle to ensure they are executed at a later time.
  • Update README
  • Dockerize the SE
  • Add integration tests
You can’t perform that action at this time.