{"id":25716306,"url":"https://github.com/interledgerjs/settlement-xrp","last_synced_at":"2025-05-05T20:44:16.635Z","repository":{"id":35140037,"uuid":"198971071","full_name":"interledgerjs/settlement-xrp","owner":"interledgerjs","description":"Settle Interledger payments using on-ledger XRP transfers","archived":false,"fork":false,"pushed_at":"2023-01-04T11:48:10.000Z","size":1004,"stargazers_count":9,"open_issues_count":16,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T23:31:33.483Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/interledgerjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-26T07:41:52.000Z","updated_at":"2023-11-30T06:28:44.000Z","dependencies_parsed_at":"2023-01-15T14:38:02.089Z","dependency_job_id":null,"html_url":"https://github.com/interledgerjs/settlement-xrp","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Fsettlement-xrp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Fsettlement-xrp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Fsettlement-xrp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Fsettlement-xrp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interledgerjs","download_url":"https://codeload.github.com/interledgerjs/settlement-xrp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252573908,"owners_count":21770301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-25T14:52:51.899Z","updated_at":"2025-05-05T20:44:16.613Z","avatar_url":"https://github.com/interledgerjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XRP On-Ledger Settlement Engine\n\n\u003e Settle Interledger payments using on-ledger XRP transfers\n\n[![NPM Package](https://img.shields.io/npm/v/ilp-settlement-xrp.svg?style=flat-square\u0026logo=npm)](https://npmjs.org/package/ilp-settlement-xrp)\n[![CircleCI](https://img.shields.io/circleci/project/github/interledgerjs/settlement-xrp/master.svg?style=flat-square\u0026logo=circleci)](https://circleci.com/gh/interledgerjs/settlement-xrp/master)\n[![Codecov](https://img.shields.io/codecov/c/github/interledgerjs/settlement-xrp/master.svg?style=flat-square\u0026logo=codecov)](https://codecov.io/gh/interledgerjs/settlement-xrp)\n[![Prettier](https://img.shields.io/badge/code_style-prettier-brightgreen.svg?style=flat-square)](https://prettier.io/)\n[![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)\n\n## Install\n\n```bash\nnpm i -g ilp-settlement-xrp\n```\n\n## Run\n\n```bash\nDEBUG=settlement* ilp-settlement-xrp\n```\n\n## Configuration\n\nOptionally configure the settlement engine using these environment variables:\n\n- **`XRP_SECRET`**: The XRP Ledger secret to send outgoing payments and corresponding to the XRP account for receiving incoming payments.\n  - By default, a new [XRP testnet account](https://xrpl.org/xrp-test-net-faucet.html) is automatically generated with 1,000 testnet XRP.\n- **`RIPPLED_URI`**: Rippled WebSocket or JSON-RPC endpoint to submit transactions and query network state.\n  - 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`.\n- **`CONNECTOR_URL`**: URL of the connector's server dedicated to this settlement engine.\n  - Default: `http://localhost:7771`\n- **`ENGINE_PORT`**: Port of the settlement engine server exposed to the connector (e.g. for triggering automated settlements).\n  - Default: `3000`\n- **`REDIS_URI`**: URI to communicate with Redis, typically in the format `redis://[:PASSWORD@]HOST[:PORT][/DATABASE]`.\n  - Default: `127.0.0.1:6379/1` (database index of 1 instead of 0)\n  - Note: this settlement engine **must** use a unique Redis database index (or dedicated Redis instance) for security to prevent conflicting with the connector.\n- **`DEBUG`**: Pattern for printing debug logs. To view logs, `settlement*` is recommended.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Fsettlement-xrp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterledgerjs%2Fsettlement-xrp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Fsettlement-xrp/lists"}