README
¶
Chainbridge Core
ChainBridge-Core was born from and built to improve the maintainability and modularity of the existing version of 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
Installation
Refer to the installation 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.
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.
docker-compose). Note: this entire process will likely take a few minutes to run.
You can also review our Local Setup Guide 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 (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:
- Adhere to the standard Go formatting guidelines, e.g. Effective Go. Run
go fmt. - 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.
- Comments: follow the advice on the Commentary section of Effective Go.
- Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers.
- Lint your code with
golangci-lint(CI will reject your PR if unlinted). - Add tests.
- Title the PR in a meaningful way and describe the rationale and the thought process in the PR description.
- Write clean, thoughtful, and detailed commit messages.
If change entails an update that needs to be documented, please submit a PR to chainbridge-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 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.
License
GNU Lesser General Public License v3.0
Directories
¶
| Path | Synopsis |
|---|---|
|
chains
|
|
|
evm/calls/evmgaspricer/mock
Package mock_evmgaspricer is a generated GoMock package.
|
Package mock_evmgaspricer is a generated GoMock package. |
|
evm/calls/mock
Package mock_calls is a generated GoMock package.
|
Package mock_calls is a generated GoMock package. |
|
evm/calls/transactor/itx/mock
Package mock_itx is a generated GoMock package.
|
Package mock_itx is a generated GoMock package. |
|
evm/calls/transactor/mock
Package mock_transactor is a generated GoMock package.
|
Package mock_transactor is a generated GoMock package. |
|
evm/cli/bridge/mock
Package mock_bridge is a generated GoMock package.
|
Package mock_bridge is a generated GoMock package. |
|
evm/executor/mock
Package mock_executor is a generated GoMock package.
|
Package mock_executor is a generated GoMock package. |
|
The crypto package is used to provide functionality to several keypair types.
|
The crypto package is used to provide functionality to several keypair types. |
|
e2e
|
|
|
The keystore package is used to load keys from keystore files, both for live use and for testing.
|
The keystore package is used to load keys from keystore files, both for live use and for testing. |
|
mock
Package mock_relayer is a generated GoMock package.
|
Package mock_relayer is a generated GoMock package. |
|
mock
Package mock_blockstore is a generated GoMock package.
|
Package mock_blockstore is a generated GoMock package. |