Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ChainSafe/chainbridge-core

🌁 Sygma core library (ChainBridge)
https://github.com/ChainSafe/chainbridge-core

Last synced: 1 day ago
JSON representation

🌁 Sygma core library (ChainBridge)

Awesome Lists containing this project

README 

        
# Chainbridge Core





  discord





  docs





go




 



# Migration Notice 

Please 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.



Chainbridge-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.



 



*Project still in deep beta*



 



### Table of Contents



1. [Installation](#installation)

2. [Usage](#usage)

3. [Local Setup](#local-setup)

4. [Contributing](#contributing)



## Installation

Refer to the [installation](https://github.com/ChainSafe/chainbridge-docs/blob/develop/docs/installation.md) guide for assistance with installing the ChainBridge binary.



## Usage

Since ChainBridge-Core is a library it will require writing some code to get it running.



You can find some examples [here](https://github.com/ChainSafe/chainbridge-core-example).



The deployment scripts of this version uses the V2.1.3 solidity scripts from https://github.com/ChainSafe/sygma-solidity/tree/v2.1.3



 



## Local Setup



This 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.



### Example

The 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.



##### ^ 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.



 



You 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.



 



## Contributing



Chainbridge-core is a open project and welcomes contributions of all kinds: code, docs, and more. If you wish to submit more complex changes,

please 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

philoshophy of the project or get some early feedback.



When implementing a change:



1. Adhere to the standard Go formatting guidelines, e.g. [Effective Go](https://golang.org/doc/effective_go.html). Run `go fmt`.

2. 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.

3. Comments: follow the advice on the [Commentary](https://golang.org/doc/effective_go.html#commentary) section of Effective Go.

4. Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers.

5. Lint your code with [`golangci-lint`](https://golangci-lint.run) (CI will reject your PR if unlinted).

6. Add tests.

7. Title the PR in a meaningful way and describe the rationale and the thought process in the PR description.

8. Write clean, thoughtful, and detailed [commit messages](https://chris.beams.io/posts/git-commit/).



If 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.



### Submiting a PR



Fork 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.



### Reporting an issue



A 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!



When reporting issues, always include:

 - chainbridge-core version

 - modules used

 - logs (don't forget to remove sensitive data)

 - tx hashes related to issue (if applicable)

 - steps required to reproduce the problem



 Putting large logs into a [gist](https://gist.github.com) will be appreciated.



 



# ChainSafe Security Policy



## Reporting a Security Bug



We take all security issues seriously, if you believe you have found a security issue within a ChainSafe

project please notify us immediately. If an issue is confirmed, we will take all necessary precautions

to ensure a statement and patch release is made in a timely manner.



Please email us a description of the flaw and any related information (e.g. reproduction steps, version) to

[security at chainsafe dot io](mailto:[email protected]).



## License



_GNU Lesser General Public License v3.0_