{"id":13626052,"url":"https://github.com/interledgerjs/interledgerjs","last_synced_at":"2025-09-11T01:07:47.137Z","repository":{"id":36977748,"uuid":"212812134","full_name":"interledgerjs/interledgerjs","owner":"interledgerjs","description":"Interledger.js Monorepo","archived":false,"fork":false,"pushed_at":"2023-07-20T17:44:35.000Z","size":4699,"stargazers_count":74,"open_issues_count":11,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-05T20:52:25.658Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","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":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-04T12:40:02.000Z","updated_at":"2024-12-16T07:34:22.000Z","dependencies_parsed_at":"2024-01-14T08:20:04.615Z","dependency_job_id":"4654e1a0-0c2a-4d66-9060-c742cdfbe05a","html_url":"https://github.com/interledgerjs/interledgerjs","commit_stats":null,"previous_names":[],"tags_count":110,"template":false,"template_full_name":null,"purl":"pkg:github/interledgerjs/interledgerjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Finterledgerjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Finterledgerjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Finterledgerjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Finterledgerjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interledgerjs","download_url":"https://codeload.github.com/interledgerjs/interledgerjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interledgerjs%2Finterledgerjs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274557583,"owners_count":25307516,"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","status":"online","status_checked_at":"2025-09-10T02:00:12.551Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["hacktoberfest"],"created_at":"2024-08-01T21:02:08.674Z","updated_at":"2025-09-11T01:07:47.115Z","avatar_url":"https://github.com/interledgerjs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Interledger.js Monorepo\n\n![status](https://github.com/interledgerjs/interledgerjs/actions/workflows/build.yml/badge.svg?branch=master)\n[![codecov](https://codecov.io/gh/interledgerjs/interledgerjs/branch/master/graph/badge.svg)](https://codecov.io/gh/interledgerjs/interledgerjs)\n\n## Packages\n\n### Payments\n\n| Name                                                         | Version                                                                                                                                                     | Description                                   |\n| :----------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------- |\n| [`@interledger/pay`](./packages/pay)                         | [![NPM Package](https://img.shields.io/npm/v/@interledger/pay.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/@interledger/pay)                         | Send payments over Interledger using STREAM   |\n| [`@interledger/stream-receiver`](./packages/stream-receiver) | [![NPM Package](https://img.shields.io/npm/v/@interledger/stream-receiver.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/@interledger/stream-receiver) | Simple \u0026 composable stateless STREAM receiver |\n\n### Utilities\n\n| Name                                                    | Version                                                                                                                                   | Description                                                |\n|:--------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------|\n| [`ilp-logger`](./packages/ilp-logger)                   | [![NPM Package](https://img.shields.io/npm/v/ilp-logger.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-logger)                   | Debug logging utility for Interledger modules              |\n| [`ilp-packet`](./packages/ilp-packet)                   | [![NPM Package](https://img.shields.io/npm/v/ilp-packet.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-packet)                   | Serialization/deserialization utility for ILP packets      |\n| [`ilp-plugin`](./packages/ilp-plugin)                   | [![NPM Package](https://img.shields.io/npm/v/ilp-plugin.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-plugin)                   | Connect to a local, open BTP server                        |\n| [`ilp-plugin-btp`](./packages/ilp-plugin-btp)           | [![NPM Package](https://img.shields.io/npm/v/ilp-plugin-btp.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-plugin-btp)           | One plugin to rule them all                                |\n| [`ilp-protocol-ccp`](./packages/ilp-protocol-ccp)       | [![NPM Package](https://img.shields.io/npm/v/ilp-protocol-ccp.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-protocol-ccp)       | Serialization/deserialization for the CCP routing protocol |\n| [`ilp-protocol-ildcp`](./packages/ilp-protocol-ildcp)   | [![NPM Package](https://img.shields.io/npm/v/ilp-protocol-ildcp.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-protocol-ildcp)   | Fetch asset and account details from a parent              |\n| [`ilp-protocol-stream`](./packages/ilp-protocol-stream) | [![NPM Package](https://img.shields.io/npm/v/ilp-protocol-stream.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/ilp-protocol-stream) | Reliably send streams of money and data over ILP           |\n| [`oer-utils`](./packages/oer-utils)                     | [![NPM Package](https://img.shields.io/npm/v/oer-utils.svg?style=flat\u0026logo=npm)](https://npmjs.org/package/oer-utils)                     | Tools for OER parsing and serialization                    |\n \n## Installation\n\nThe monorepo is set up to use lerna and pnpm workspaces. To get started run the following:\n\n1. `pnpm install` - pnpm will install the dependencies and do the necessary linking (no need to run `lerna bootstrap`).\n2. `pnpm build`\n3. `pnpm test` - This will run the tests in all the packages.\n\n### Running script commands\n\nScript commands such as `test` and `lint` can be run from the root of the project by running:\n\n```sh\n# Run tests for all packages\npnpm test\n\n# Run tests for a specific module a package\npnpm test --scope=\u003cpackage-name\u003e\n```\n\nOr in the package directory:\n\n```sh\npnpm test\n```\n\nIf you are interested in contributing, please read the [contributing guidelines](./CONTRIBUTING.md).\n\n## For Maintainers\n\n### Versioning\n\nIndependent versioning is used for this project and releases can only be made from `master`. You will need to set the `GH_TOKEN` env variable to your\npersonal [GitHub access token](https://github.com/settings/tokens). Please make sure that you are up to date with master and that the tests and linting pass. Then use the following to create a release:\n\n```sh\n# On master\nGH_TOKEN=\u003cgithub-token\u003e lerna version --conventional-commits --create-release github\n```\n\nand follow the command prompts. This will commit the package version changes and create the necessary tags - all of which will be pushed to master. It will also create changelogs and official GitHub releases.\n\nIf you want to release an `alpha` then run\n\n```sh\n# On master\nGH_TOKEN=\u003cgithub-token\u003e lerna version --conventional-commits --conventional-prerelease --create-release github\n```\n\nThis will append `-alpha.\u003calpha-version\u003e` to the release name. The alpha release can be graduated (`1.0.1-alpha.1` =\u003e `1.0.1`) by running:\n\n```sh\n# On master\nGH_TOKEN=\u003cgithub-token\u003e lerna version --conventional-commits --conventional-graduate --create-release github\n```\n\n### Adding new packages\n\nAll source code is expected to be TypeScript and is placed in the `src` folder. Tests are put in the `test` folder.\nThe NPM package will not contain any TypeScript files (`*.ts`) but will have typings and source maps. A typical project should have the following structure:\n\n```\n|-- src\n|-- test\n|-- package.json\n|-- tsconfig.build.json\n```\n\nThe `tsconfig.build.json` file should have the following\n\n```js\n{\n  \"extends\": \"../../tsconfig.json\",\n  \"compilerOptions\": {\n    \"composite\": true,\n    \"baseUrl\": \".\",\n    \"rootDir\": \"src\",\n    \"outDir\": \"dist\",\n    \"tsBuildInfoFile\": \"./dist/tsconfig.build.tsbuildinfo\"\n  },\n  \"include\": [\n    \"src\"\n  ]\n}\n```\n\nThe `package.json` file should specify the following\n\n```js\n{\n  \"name\": \"\u003cpackage-name\u003e\",\n  \"license\": \"Apache-2.0\",\n  \"publishConfig\": {\n    \"access\": \"public\"\n  }\n}\n```\n\nIn the `scripts` section of the `package.json`, be sure to have `build`, `cover` (which runs tests with coverage) and `codecov`. These will be called from the CI pipeline. Please use the following as a guideline:\n\n```js\n\"scripts\": {\n  \"build\": \"tsc -p tsconfig.build.json\",\n  \"cover\": \"...\",\n  \"codecov\": \"curl -s https://codecov.io/bash | bash -s - -s coverage -F \u003cflagname\u003e\"\n}\n```\n\nThe `cover` script should run the tests with code coverage and output the coverage results in a format that can be uploaded to codecov. The `flagname` will be used by codecov to track coverage per package. Please make sure it matches the regex `^[a-z0-9_]{1,45}$`.\n\n### Importing legacy modules\n\nThis process preserves the commit history of the legacy modules.\n\n```sh\ngit clone git@github.com:adrianhopebailie/interledgerjs.git\ngit clone git@github.com:interledgerjs/legacy-module.git\ncd legacy-module\ngit pull\ncd ../interledgerjs\nlerna import ../legacy-module --dest=packages --preserve-commit --flatten\n```\n\nYou then need to replace the `tsconfig.json` file with the `tsconfig.build.json` and update the `package.json` as described above.\n\n### Dependencies\n\nWe keep devDependencies that are shared across all packages in the root `package.json` file. Dependencies can be added to individual packages using Lerna\n\n```sh\nlerna add \u003cpackage to install\u003e --scope=\u003cpackage-name\u003e\n\n# Add dev dependency\nlerna add \u003cpackage to install\u003e --scope=\u003cpackage-name\u003e --dev\n```\n\n### Running script commands\n\nScript commands such as `test` and `lint` can be run from the root of the project by running\n\n```sh\n# All tests in all packages\nlerna run test\n\n#Scoping to a package\nlerna run test --scope=\u003cpackage-name\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Finterledgerjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterledgerjs%2Finterledgerjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterledgerjs%2Finterledgerjs/lists"}