Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

XRP On-Ledger Settlement Engine

Settle Interledger payments using on-ledger XRP transfers

NPM Package CircleCI Codecov Prettier Apache 2.0 License

Install

npm i -g ilp-settlement-xrp

Run

DEBUG=settlement* ilp-settlement-xrp

Configuration

Optionally configure the settlement engine using these environment variables:

  • XRP_SECRET: The XRP Ledger secret to send outgoing payments and corresponding to the XRP account for receiving incoming payments.
  • RIPPLED_URI: Rippled WebSocket or JSON-RPC endpoint to submit transactions and query network state.
    • Defaults to the Ripple testnet: wss://s.altnet.rippletest.net:51233. To operate on mainnet, specify a mainnet validator, such as wss://s1.ripple.com.
  • CONNECTOR_URL: URL of the connector's server dedicated to this settlement engine.
    • Default: http://localhost:7771
  • ENGINE_PORT: Port of the settlement engine server exposed to the connector (e.g. for triggering automated settlements).
    • Default: 3000
  • REDIS_URI: URI to communicate with Redis, typically in the format redis://[:PASSWORD@]HOST[:PORT][/DATABASE].
    • Default: 127.0.0.1:6379/1 (database index of 1 instead of 0)
    • Note: this settlement engine must use a unique Redis database index (or dedicated Redis instance) for security to prevent conflicting with the connector.
  • DEBUG: Pattern for printing debug logs. To view logs, settlement* is recommended.

About

Settle Interledger payments using on-ledger XRP transfers

Resources

License

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •