{"id":13630303,"url":"https://github.com/ChainSafe/chainbridge-core","last_synced_at":"2025-04-17T13:32:04.682Z","repository":{"id":37540243,"uuid":"353055623","full_name":"ChainSafe/chainbridge-core","owner":"ChainSafe","description":"🌁 Sygma core library (ChainBridge)","archived":true,"fork":false,"pushed_at":"2023-11-27T11:43:54.000Z","size":16032,"stargazers_count":97,"open_issues_count":12,"forks_count":55,"subscribers_count":18,"default_branch":"main","last_synced_at":"2024-10-02T19:23:53.426Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChainSafe.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-03-30T15:46:42.000Z","updated_at":"2024-09-03T21:47:09.000Z","dependencies_parsed_at":"2023-11-27T12:47:18.795Z","dependency_job_id":null,"html_url":"https://github.com/ChainSafe/chainbridge-core","commit_stats":null,"previous_names":["chainsafe/chainbridgev2","chainsafe/sygma-core"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChainSafe%2Fchainbridge-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChainSafe%2Fchainbridge-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChainSafe%2Fchainbridge-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChainSafe%2Fchainbridge-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChainSafe","download_url":"https://codeload.github.com/ChainSafe/chainbridge-core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223757374,"owners_count":17197544,"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-08-01T22:01:37.732Z","updated_at":"2024-11-08T21:31:24.707Z","avatar_url":"https://github.com/ChainSafe.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Chainbridge Core\n\n\u003ca href=\"https://discord.gg/ykXsJKfhgq\"\u003e\n  \u003cimg alt=\"discord\" src=\"https://img.shields.io/discord/593655374469660673?label=Discord\u0026style=for-the-badge\u0026logo=discord\u0026logoColor=white\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://chainbridge-docs.chainsafe.io\"\u003e\n  \u003cimg alt=\"docs\" src=\"https://img.shields.io/badge/GitBook-7B36ED?style=for-the-badge\u0026logo=gitbook\u0026logoColor=white/\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://golang.org\"\u003e\n\u003cimg alt=\"go\" src=\"https://img.shields.io/badge/Go-00ADD8?style=for-the-badge\u0026logo=go\u0026logoColor=white\" /\u003e\n\u003c/a\u003e\n\n\u0026nbsp;\n\n# Migration Notice \nPlease note the Chainbridge-Core repo will be migrated to Sygma-Core as part of ongoing work to update the codebase. See [Sygma](https://github.com/sygmaprotocol) to learn more.\n\nChainbridge-Core was born from and built to improve the maintainability and modularity of the existing version of [ChainBridge](https://github.com/ChainSafe/chainbridge). The fundamental distinction between the two is that Chainbridge-Core is more of a framework rather than a stand-alone application.\n\n\u0026nbsp;\n\n*Project still in deep beta*\n\n\u0026nbsp;\n\n### Table of Contents\n\n1. [Installation](#installation)\n2. [Usage](#usage)\n3. [Local Setup](#local-setup)\n4. [Contributing](#contributing)\n\n\n## Installation\nRefer to the [installation](https://github.com/ChainSafe/chainbridge-docs/blob/develop/docs/installation.md) guide for assistance with installing the ChainBridge binary.\n\n## Usage\nSince ChainBridge-Core is a library it will require writing some code to get it running.\n\nYou can find some examples [here](https://github.com/ChainSafe/chainbridge-core-example).\n\nThe deployment scripts of this version uses the V2.1.3 solidity scripts from https://github.com/ChainSafe/sygma-solidity/tree/v2.1.3\n\n\u0026nbsp;\n\n## Local Setup\n\nThis section allows developers with a way to quickly and with minimal effort stand-up a local development environment in order to test out functionality of the ChainBridge.\n\n### Example\nThe example developer setup can be run with the `make example` command which will create a 3 relayer setup with 2 EVM networks with already preconfigured ERC20, ERC721 and Generic handlers and appropriate assets.\n\n##### ^ this command will execute a shell script that contains instructions for running two EVM chains via [Docker](https://www.docker.com/) (`docker-compose`). Note: this entire process will likely take a few minutes to run.\n\n\n\u0026nbsp;\n\nYou can also review our [Local Setup Guide](https://github.com/ChainSafe/chainbridge-docs/blob/develop/docs/guides/local-setup-guide.md) for a more detailed example of setting up a local development environment manually.\n\n\u0026nbsp;\n\n## Contributing\n\nChainbridge-core is a open project and welcomes contributions of all kinds: code, docs, and more. If you wish to submit more complex changes,\nplease check up with the core devs first on our [Discord Server](https://discord.gg/ykXsJKfhgq) (look for CHAINBRIDGE category) or submit an issue on the repo to ensure those changes are in line with the general\nphiloshophy of the project or get some early feedback.\n\nWhen implementing a change:\n\n1. Adhere to the standard Go formatting guidelines, e.g. [Effective Go](https://golang.org/doc/effective_go.html). Run `go fmt`.\n2. Stick to the idioms and patterns used in the codebase. Familiar-looking code has a higher chance of being accepted than eerie code. Pay attention to commonly used variable and parameter names, avoidance of naked returns, error handling patterns, etc.\n3. Comments: follow the advice on the [Commentary](https://golang.org/doc/effective_go.html#commentary) section of Effective Go.\n4. Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers.\n5. Lint your code with [`golangci-lint`](https://golangci-lint.run) (CI will reject your PR if unlinted).\n6. Add tests.\n7. Title the PR in a meaningful way and describe the rationale and the thought process in the PR description.\n8. Write clean, thoughtful, and detailed [commit messages](https://chris.beams.io/posts/git-commit/).\n\nIf change entails an update that needs to be documented, please submit a PR to [chainbridge-docs](https://github.com/ChainSafe/chainbridge-docs/tree/develop/docs) repo.\n\n\n### Submiting a PR\n\nFork the repository, make changes and open a PR to the `main` branch of the repo. Pull requests must be cleanly rebased on top of `main` and changes require at least 2 PR approvals for them to be merged.\n\n### Reporting an issue\n\nA great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!\n\nWhen reporting issues, always include:\n - chainbridge-core version\n - modules used\n - logs (don't forget to remove sensitive data)\n - tx hashes related to issue (if applicable)\n - steps required to reproduce the problem\n\n Putting large logs into a [gist](https://gist.github.com) will be appreciated.\n\n\u0026nbsp;\n\n# ChainSafe Security Policy\n\n## Reporting a Security Bug\n\nWe take all security issues seriously, if you believe you have found a security issue within a ChainSafe\nproject please notify us immediately. If an issue is confirmed, we will take all necessary precautions\nto ensure a statement and patch release is made in a timely manner.\n\nPlease email us a description of the flaw and any related information (e.g. reproduction steps, version) to\n[security at chainsafe dot io](mailto:security@chainsafe.io).\n\n## License\n\n_GNU Lesser General Public License v3.0_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChainSafe%2Fchainbridge-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChainSafe%2Fchainbridge-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChainSafe%2Fchainbridge-core/lists"}