{"id":25716321,"url":"https://github.com/interledgerjs/ilp-plugin-http","last_synced_at":"2025-05-05T20:45:35.054Z","repository":{"id":34150872,"uuid":"167255372","full_name":"interledgerjs/ilp-plugin-http","owner":"interledgerjs","description":"ILP Plugin over HTTP","archived":false,"fork":false,"pushed_at":"2022-12-22T09:39:08.000Z","size":168,"stargazers_count":6,"open_issues_count":7,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T23:31:34.301Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-23T21:15:36.000Z","updated_at":"2022-11-13T06:44:17.000Z","dependencies_parsed_at":"2023-01-15T04:55:59.651Z","dependency_job_id":null,"html_url":"https://github.com/interledgerjs/ilp-plugin-http","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Filp-plugin-http","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Filp-plugin-http/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Filp-plugin-http/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Filp-plugin-http/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interledgerjs","download_url":"https://codeload.github.com/interledgerjs/ilp-plugin-http/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252574434,"owners_count":21770400,"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:59.322Z","updated_at":"2025-05-05T20:45:35.030Z","avatar_url":"https://github.com/interledgerjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ILP Plugin HTTP\n\n\u003e ILP Plugin that uses HTTP requests\n\n- [Overview](#overview)\n- [Usage](#usage)\n- [Protocol](#protocol)\n\n## Overview\n\nPlugin HTTP allows for a bilateral or multilateral Interledger relationship which doesn't maintain state around websockets like Plugin BTP. It can also easily be placed behind a load balancer so that packets are distributed between a cluster of connectors.\n\nTo learn more about the architecture this plugin is designed for, read [this article by @emschwartz.](https://medium.com/interledger-blog/thoughts-on-scaling-interledger-connectors-7e3cad0dab7f)\n\n## Usage\n\nFor an example of usage, see the test script in `test/test.js`.\n\n```js\nnew PluginHttp({\n  multi: true, // whether to behave as a multilateral plugin\n  multiDelimiter: '%', // to specifiy a delimiter other than default `%`\n  ildcp: {\n    // ildcp details. fetched if multilateral and unspecified.\n    clientAddress: 'test.example',\n    assetCode: 'XRP',\n    assetScale: 9\n  },\n  incoming: { // (required) describes the http server\n    port: 4000, // (required) port to listen on\n\n    // Simple bearer authentication\n    staticToken: 'shhh', // (required if using simple)\n\n    // JWT authentication\n    jwtSecret: 'shhh' // (required if using JWTs)\n  },\n  outgoing: { // (required) describes outgoing http calls\n    url: 'https://example.com/ilp/%', // (required) endpoint to POST packets to\n    // if url contains a percent and the plugin is in `multi` mode, then the\n    // segment after this plugin's own address will be filled where the `%` is\n    // when routing packets.\n\n    // Simple bearer authentication\n    staticToken: 'othersecret', // (required if using simple)\n\n    // JWT authentication\n    jwtSecret: 'othersecret', // (required if using JWTs)\n    jwtExpiry: 10 * 1000, // how often to sign a new token for auth\n\n    http2: false, // whether `url` uses http2\n    name: 'alice' // name to send in `ILP-Peer-Name` header, for ilp addr.\n  }\n})\n```\n\n## Protocol\n\n### Authentication\n\nTwo token formats are supported:\n- **Simple auth**, using simple, static bearer tokens\n- **JWT auth**, using JSON web tokens\n\nBoth peer plugins must be configured with the same authentication method.\n\nNote: v1.6.0 and greater use bearer tokens by default. However, to peer with a plugin using v1.5.0 or lower, the `secret` (for JWT auth) or `secretToken` (for simple auth) configuration options must be provided instead.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Filp-plugin-http","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterledgerjs%2Filp-plugin-http","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Filp-plugin-http/lists"}