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 take a look at the CONTRIBUTING guidelines. We welcome and appreciate community contributions!
Community calls
We run monthly community calls to update the community with current our direction and gather feedback on what to work on next. The community calls are also a platform for you to update everyone else with what you're working on, and find opportunities to collaborate.
Please join the Google group to receive a calendar invitation for the monthly meeting.
Versioning
We follow Semantic Versioning, though APIs are still under active development.
Resources
License
Copyright © 2022 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.0
Unless 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.