ibc-rs
Rust implementation of the Inter-Blockchain Communication (IBC) protocol that hosts all the data structures and on-chain logic implementations of various IBC core, clients and applications. This repository organized as a collection of sub-crates that can be used independently or together.
Project Structure
Crate |
Description |
|---|---|
| ibc | Re-exports all the data structures and on-chain logic of various IBC core, clients and applications. |
| ibc-data-types | Re-exports all the IBC data types that are shared across different IBC implementations. |
| ibc-core | Contains data structures and implementations of all the IBC core specifications. |
| ibc-clients | Contains data structures and implementations of various IBC light clients. |
| ibc-apps | Contains data structures and implementations of various IBC applications. |
| ibc-testkit | Provides testing toolkit to aid ibc-rs and host chains in writing integration tests. |
| ibc-query | Contains utility traits and implementations for querying states of an integrated IBC module. |
| ibc-derive | Derive macros for ClientState and ConsensusState traits, reducing boilerplate. |
Contributing
IBC is specified in English in the cosmos/ibc repo. Any protocol
changes or clarifications should be contributed there.
If you're interested in contributing, please refer to the CONTRIBUTING guidelines. We welcome and appreciate community contributions!
Community calls
The IBC-rs community calls are now part of the IBC Core community calls. During these calls, we update the community on our current direction and gather feedback on what to work on next. The community calls are also a platform for you to update everyone else on what you're working on and find opportunities to collaborate.
Please join the Google group to receive a calendar invitation to the monthly meetings.
Resources
ibc-rs in the wild
The IBC Protocol is integrated in numerous networks and
projects. The ibc-rs implementation, in particular, is used for IBC
integration, testing, or development for some of the most technically compelling
use cases.
| # | Integration use-case | Team | Used-Modules | Links | Phase |
|---|---|---|---|---|---|
| 1 | Solana IBC implementation | Composable | :100: | Picasso Network | :white_check_mark: |
| 2 | Ethereum IBC relayer | Composable | :100: | Picasso Network | :white_check_mark: |
| 3 | Polkadot SDK IBC implementation | Composable | :100: | Picasso Network | :white_check_mark: |
| 4 | Nomic | Nomic | :100: | Nomic network | :white_check_mark: |
| 5 | CosmWasm Tendermint Light Client | Informal | ics07 |
cosmwasm-ibc | :white_check_mark: |
| 6 | Namada | Anoma | :100: | Namada | :hourglass_flowing_sand: |
| 7 | Sovereign | Informal | :100: | sovereign-ibc |
:hourglass_flowing_sand: |
| 8 | Hermes IBC relayer | Informal | :100: | basecoin-rs |
:hammer_and_pick: |
| 9 | Substrate pallet | Octopus | :100: | Substrate IBC Pallet | :hammer_and_pick: |
| 10 | Near Protocol | Octopus | :100: | near-ibc |
:hourglass_flowing_sand: |
| 11 | Tendermint Light Client | Electron Labs | ics07 |
Electron-Labs/tendermint-rs |
:hourglass_flowing_sand: |
| 12 | Starknet | Informal | :eyes: | :eyes: | :eyes: |
| 13 | SP1 Tendermint Light Client | Interchain | ics07 |
cosmos/sp1-ics07-tendermint |
:hourglass_flowing_sand: |
Legend:
- :white_check_mark: IBC integration in production
- :hourglass_flowing_sand: IBC integration in development (testnet or devnet)
- :hammer_and_pick: used in testing and/or development
- :100: full IBC integration
- :eyes: early exploration phase
License
Copyright © 2024 Informal Systems Inc. and ibc-rs authors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.