| Language | Code Coverage | Test |
|---|---|---|
| Java |  |
 |
| Rust |  |
 |
The Inter-Blockchain Communication protocol (IBC) is an end-to-end, connection-oriented, stateful protocol for reliable, ordered, and authenticated communication between heterogeneous blockchains arranged in an unknown and dynamic topology. xCall, a standard for generic cross-chain messaging along with IBC provides dynamic and coherent solution for interconnected dapps.
Additional information on how IBC works can be found here. and xCall spec is defined here
Relayer for these contracts deviates slightly from official cosmos relayer due to the fact that ICON uses BTP Blocks as storage for messages and also on cosmwasm side the ibc host is deployed as contracts rather than the native ibc host module of cosmos chain. Relayer for ibc-icon can be found here. The deviation from cosmos relayer is documented here.
This project uses git submodules. Use the following command to clone this repository including the required submodules.
git clone --recurse-submodules https://github.com/icon-project/IBC-IntegrationOr To update submodules, run the following command,
git submodule init
git submodule update --remote
Make sure you have following installed on your machine to build the contracts or you can use docker.
- Go (at least version 1.20)
- Rust (version 1.68)
- Wasm-Opt (version 110)
- Java (JDK 11)
- Docker (for running tests)
- ICON
- Archway
| Directory | Description |
|---|---|
| /contracts/cosmwasm-vm | Includes contracts for cosmwasm based chains |
| /contracts/evm | Includes contracts for evm based chains |
| /contracts/javascore | Includes contracts for ICON chain |
| /docs | Documentation |
| /libraries/rust | Common rust libraries used across multiple integrations |
| /proto | Proto files used for IBC |
| /resources | Static resources in project. For example images, bin files, etc |
| /scripts | Scripts to automate task in project, for example build scripts, deploy scripts |
| /test | Test Framework and Test Suite including e2e test and functional test |
| /utils | Utilities used for build, setup, CI/CD |
For Setting up nodes , deploy contracts and end-to-end testing follow steps provided here
Run following command on root directory to build the rust contracts. The built wasm files will be available in the artifacts directory in the root.
./scripts/optimize-cosmwasm.sh
To build the java contracts run following command.
make optimize-jar
To build all contracts using docker follow steps below Step1: Update git submodules:
git submodule init
git submodule update --remote
Step2: Run following commands to build the builder image and compile contracts.
make build-builder-img
make optimize-build
For deployment and usage follow steps provided here.
To build dapp that is compatible with our smart contract based IBC Host you can follow the docs provided in mock ibc dapp samples. Sample for cosmwasm contract here. Sample for icon contract here
We highly value community contributions and appreciate your interest in improving the IBC Integration for ICON Project. This section outlines the steps you should follow to contribute effectively.
If you encounter a bug or have an idea for a new feature, please follow these steps:
-
Before submitting a bug report, search the existing issues to see if the bug has already been reported. If you find a similar issue, you can add relevant details in the comments.
-
If the bug hasn't been reported yet, open a new issue with a clear and descriptive title. Provide as much detail as possible, including:
- A clear description of the bug and its impact.
- Steps to reproduce the bug.
- Your environment details (OS, ICON node version, etc.).
- Any relevant error messages or logs.
-
Assign appropriate labels to the issue, such as "bug" and any other relevant tags.
-
Before submitting a feature request, again, check the existing issues to ensure that the feature hasn't already been requested. If you find a similar request, you can add your insights in the comments.
-
To submit a new feature request, open a new issue and select the "Feature Request" template. Provide a clear and comprehensive description of the feature you're proposing, including:
- The problem the feature aims to solve.
- How the feature would work.
- Any potential benefits or use cases.
-
Assign appropriate labels to the issue, such as "enhancement" or "feature request," and any other relevant tags.
If you're interested in contributing code to the project, follow these steps to submit a pull request (PR):
-
Fork the Repository: Click the "Fork" button at the top of the repository page to create your own fork of the project. This will allow you to work on your changes in your own copy of the repository.
-
Create a Branch: Create a new branch in your forked repository that will contain your changes. Naming the branch according to the changes you're making is a good practice (e.g.,
feature/new-featureorbugfix/fix-issue-123). -
Make Changes: Make your changes in the new branch. Follow the project's coding standards, and write clear and concise commit messages.
-
Test Your Changes: If applicable, ensure that your changes work as intended and do not introduce new bugs. If tests exist in the project, make sure to run them.
-
Open a Pull Request: When you're ready to submit your changes, open a new pull request from your branch to the
mainbranch of the main repository. Provide a detailed description of your changes, including the problem you're solving, your solution, and any relevant context. -
Review and Iteration: Your pull request will be reviewed by the project maintainers. Be prepared to address any feedback or changes requested by the reviewers. Collaboration and constructive discussion are key.
-
Merge: Once your pull request passes the review process and meets the project's standards, it will be merged into the
mainbranch.
Contributors are expected to adhere to the project's Code of Conduct at all times. This ensures a respectful and inclusive environment for all contributors and participants.
We appreciate your dedication to contributing to the IBC Integration for ICON Project. Your efforts help improve the project's quality and expand its capabilities. Thank you for being a part of our community!
This project is licensed under the Apache 2.0.
If you need assistance, have questions, or want to collaborate on this project, feel free to contact the team at our community chat.
Thank you for your interest in the IBC Integration for ICON Project. We look forward to your contributions and the positive impact they will bring to the ICON blockchain and its interoperability capabilities!