https://github.com/interledgerjs/settlement-xrp

Settle Interledger payments using on-ledger XRP transfers
https://github.com/interledgerjs/settlement-xrp

Last synced: about 1 month ago
JSON representation

Settle Interledger payments using on-ledger XRP transfers

• Host: GitHub
• URL: https://github.com/interledgerjs/settlement-xrp
• Owner: interledgerjs
• License: apache-2.0
• Created: 2019-07-26T07:41:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T11:48:10.000Z (over 2 years ago)
• Last Synced: 2025-03-30T23:31:33.483Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 980 KB
• Stars: 9
• Watchers: 3
• Forks: 6
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# XRP On-Ledger Settlement Engine

> Settle Interledger payments using on-ledger XRP transfers

[![NPM Package](https://img.shields.io/npm/v/ilp-settlement-xrp.svg?style=flat-square&logo=npm)](https://npmjs.org/package/ilp-settlement-xrp)

[![CircleCI](https://img.shields.io/circleci/project/github/interledgerjs/settlement-xrp/master.svg?style=flat-square&logo=circleci)](https://circleci.com/gh/interledgerjs/settlement-xrp/master)

[![Codecov](https://img.shields.io/codecov/c/github/interledgerjs/settlement-xrp/master.svg?style=flat-square&logo=codecov)](https://codecov.io/gh/interledgerjs/settlement-xrp)

[![Prettier](https://img.shields.io/badge/code_style-prettier-brightgreen.svg?style=flat-square)](https://prettier.io/)

[![Apache 2.0 License](https://img.shields.io/github/license/interledgerjs/settlement-xrp.svg?style=flat-square)](https://github.com/interledgerjs/settlement-xrp/blob/master/LICENSE)

## Install

```bash

npm i -g ilp-settlement-xrp

```

## Run

```bash

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](https://xrpl.org/xrp-test-net-faucet.html) 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.