{"id":19783672,"url":"https://github.com/intersectmbo/cardano-launcher","last_synced_at":"2025-04-30T22:31:37.766Z","repository":{"id":42932625,"uuid":"235273014","full_name":"IntersectMBO/cardano-launcher","owner":"IntersectMBO","description":"Shelley cardano-node and cardano-wallet launcher for NodeJS applications","archived":false,"fork":false,"pushed_at":"2023-12-16T16:33:20.000Z","size":3809,"stargazers_count":34,"open_issues_count":19,"forks_count":9,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-04-06T05:34:28.715Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://input-output-hk.github.io/cardano-launcher/","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/IntersectMBO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-01-21T06:40:54.000Z","updated_at":"2024-11-17T13:33:45.000Z","dependencies_parsed_at":"2024-01-04T18:03:35.740Z","dependency_job_id":"d92d88c5-5854-4077-b0ca-a2a1ea76044a","html_url":"https://github.com/IntersectMBO/cardano-launcher","commit_stats":null,"previous_names":["input-output-hk/cardano-launcher"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardano-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntersectMBO","download_url":"https://codeload.github.com/IntersectMBO/cardano-launcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251791620,"owners_count":21644432,"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":"2024-11-12T06:08:57.048Z","updated_at":"2025-04-30T22:31:36.972Z","avatar_url":"https://github.com/IntersectMBO.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cardano-launcher Shelley\n\n[![cardano-launcher CI](https://github.com/input-output-hk/cardano-launcher/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/input-output-hk/cardano-launcher/actions?query=branch%3Amaster)\n\n`cardano-launcher` is a Node.js module for starting\n[cardano-wallet](https://github.com/input-output-hk/cardano-wallet)\nand the Shelley\n[cardano-node](https://github.com/input-output-hk/cardano-node).\n\nIts primary user is\n[Daedalus](https://github.com/input-output-hk/daedalus); however it\ncould be used by any Javascript application. Tagged versions are published to the [npm Registry](https://www.npmjs.com/package/cardano-launcher) as `cardano-launcher`.\n\n## Documentation\n\nSee the generated API docs at https://input-output-hk.github.io/cardano-launcher/latest/modules.html.\n\nSee [docs/example.js](./docs/example.js) for example code.\n\n## Component diagram\n\n![Component diagram](./docs/component-diagram.png)\n\n## Message sequence diagram - launch\n\n![Component diagram](./docs/launch.png)\n\n\n## Local Development\n\n```\nnix-shell\n```\nThis runs a bash shell with project development dependencies\n(e.g. `npm`, `cardano-wallet`) in the `PATH`. See [nix.md](https://github.com/input-output-hk/iohk-nix/blob/master/docs/nix.md)\nfor information on how to set up Nix.\n\n### Build the code\n\nTranspile TypeScript to Javascript in the `dist` directory, checking for errors:\n\n    npm run build\n\nDo the compile as above, but automatically rebuild when a file changes\n\n    npm run build -- --watch\n\n### Run the tests\n\nRuns all tests:\n\n    npm test\n\nTo run only `unit` tests matching `idempotent` (for example):\n\n    npm test unit -- -t idempotent\n\nRun the test watcher ([Jest](https://jestjs.io/docs/en/getting-started)) and prompt for usage:\n\n    npm test -- --watch\n\nSee the [Jest command-line reference](https://jestjs.io/docs/en/cli) for all the options.\n\nNote that the `cli` tests require the code to already have been built\nwith `npm run build`.\n\n### Linting and formatting the code\n\nTo check linter rules defined in `.eslintrc.json`:\n\n    npm run lint\n\nTo automatically fix lint and formatting errors, where possible:\n\n    npm run lint -- --fix\n\n[JavaScript Standard Style](https://standardjs.com/)\n\n### Generate API Documentation\n\nGenerates API documentation to the `site` folder.\n\n    npm run typedoc\n\n### Updating cardano-wallet version\n\nTo modify the cardano-wallet version, use [`niv update`](https://github.com/nmattia/niv#update).\n\n    nix-shell --run \"niv update cardano-wallet -a rev={GIT_TAG}\"\n\nor, to use the latest `master` branch revsion:\n\n    nix-shell --run \"niv update cardano-wallet --branch master\"\n\nThe version of `cardano-node` is defined by cardano-wallet because it\nhas specific version requirements for its backends.\n\n#### Overriding node backend versions\n\nTo use your own build of `cardano-node`, export your `PATH`\nenvironment variable so that your build is ahead of those set by the\n`nix-shell`.\n\n## Design docs\n\n * [ADP-92](https://jira.iohk.io/browse/ADP-92) - Jira ticket\n   containing user stories and task acceptance criteria.\n\n * [`update-system-byron.md`](./docs/update-system-byron.md) -\n   Overview of how the update system works in the old codebase (Byron\n   era).\n\n * [`windows-clean-shutdown.md`](./docs/windows-clean-shutdown.md) -\n   How to stop the wallet and node processes on Windows.\n\n * [`dev.md`](./docs/dev.md) - Development information.\n\n## Demo CLI\n\nThis is a very basic executable that lets you test the compiled\nlibrary code from your shell.\n\n```shell script\n# Build the javascript first.\nnpm run build\n\n# cardano-node mainnet\n./bin/cardano-launcher shelley mainnet $CARDANO_NODE_CONFIGS/mainnet ./state-mainnet\n\n# cardano-node testnet\n./bin/cardano-launcher shelley testnet $CARDANO_NODE_CONFIGS/testnet ./state-testnet\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardano-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersectmbo%2Fcardano-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardano-launcher/lists"}