interledger/settlement-xrp repository overview

⁠XRP On-Ledger Settlement Engine

⁠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.
  • By default, a new XRP testnet account⁠ is automatically generated with 1,000 testnet XRP.
• 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.