{"id":21429819,"url":"https://github.com/limechain/wisp","last_synced_at":"2025-03-16T21:44:15.229Z","repository":{"id":152306374,"uuid":"587731383","full_name":"LimeChain/wisp","owner":"LimeChain","description":"Wisp Protocol Relayer implementation in TypeScript (NestJS)","archived":false,"fork":false,"pushed_at":"2023-04-12T07:28:18.000Z","size":179,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-23T08:18:12.889Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.wispprotocol.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LimeChain.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-11T13:04:10.000Z","updated_at":"2023-04-29T18:33:30.000Z","dependencies_parsed_at":"2023-04-13T18:17:29.471Z","dependency_job_id":null,"html_url":"https://github.com/LimeChain/wisp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeChain%2Fwisp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeChain%2Fwisp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeChain%2Fwisp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeChain%2Fwisp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LimeChain","download_url":"https://codeload.github.com/LimeChain/wisp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243940062,"owners_count":20372044,"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-22T22:19:16.817Z","updated_at":"2025-03-16T21:44:15.201Z","avatar_url":"https://github.com/LimeChain.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wisp Relayer\n\n\u003ca href=\"https://www.npmjs.com/~nestjscore\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@nestjs/core.svg\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/~nestjscore\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/@nestjs/core.svg\" alt=\"Package License\" /\u003e\u003c/a\u003e\n\n## Description\n\nWisp Relayer node that:\n- Handles Light Client Optimistic/Finality updates, requests ZKPs from\na [Wisp-Prover API](https://github.com/LimeChain/wisp-prover) and updates the on-chain LightClient contract\n- Watches `Outbox` contracts for Cross-Rollup Messages and relays them to `Inbox` contracts once Light Client state is updated\n\n## Installation\n\n```bash\n$ npm install\n```\n\n## Development\n\n**Prerequisite**\n\nCopy and example yaml and populate the ENV variables:\n\n```markdown\ncp ./config/example.yaml ./config/config.yaml\n```\n\n### Docker\n\nExecute the following script\n```bash\nbash ./start.sh\n```\n\n### From Source\n\n**Scripts**\n\n```bash\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n```\n\n**Note**\n\nIn order for the relayer to receive light client finality updates, LimeChain's forked lodestar must be started:\n1. Get the current `checkpointRoot` by executing:\n    ```bash\n   curl https://lodestar-goerli.chainsafe.io/eth/v1/beacon/states/finalized/finality_checkpoints | jq \".data.finalized.root\" | tr -d '\"'\n    ```\n2. Start the `lodestar-wisp1:0` image, populating the returned `checkpointRoot:\n    ```bash\n     docker run limechain/lodestar-wisp:1.0 lightclient --network goerli --beaconApiUrl=https://lodestar-goerli.chainsafe.io --checkpointRoot=${CHECKPOINT_ROOT} --crcApiUrl=http://relayer:8080\n    ```\n\n## License\n\nThe code in this project is free software under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimechain%2Fwisp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flimechain%2Fwisp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimechain%2Fwisp/lists"}