Skip to content

DaMandal0rian/ibc-rs

 
 

Repository files navigation

ibc-rs

Cosmos ecosystem

Build Status End to End testing Apache 2.0 Licensed Rust Stable Rust 1.60+

Rust implementation of the Inter-Blockchain Communication (IBC) protocol.

This project comprises primarily seven crates:

  • The ibc crate defines the main data structures and on-chain logic for the IBC protocol.
  • The ibc-chain-registry provides functions to fetch data from the chain registry and automatically generate chain configuration for hermes.
  • The ibc-relayer crate provides an implementation of an IBC relayer, as a library.
  • The ibc-relayer-cli crate is a CLI (a wrapper over the ibc-relayer library), comprising the hermes binary.
  • The ibc-proto crate is a library with Rust types generated from .proto definitions necessary for interacting with Cosmos SDK and its IBC structs.
  • The ibc-telemetry crate is a library for use in the hermes CLI, for gathering telemetry data and exposing that in a Prometheus endpoint.
  • The ibc-test-framework crate provides the infrastructure and framework for writing end-to-end (E2E) tests that include the spawning of the relayer together with Cosmos full nodes.

See the table below for more details.

Includes TLA+ specifications.

Crate name Type Version Docs
ibc lib IBC Crate IBC Docs
ibc-relayer lib IBC Relayer Crate IBC Relayer Docs
ibc-relayer-cli bin: hermes IBC Relayer CLI Crate IBC Relayer CLI Docs
ibc-relayer-rest lib IBC Relayer REST Crate IBC Relayer REST Docs
ibc-proto lib IBC Proto Crate IBC Proto Docs
ibc-telemetry lib IBC Telemetry Crate IBC Telemetry Docs
ibc-test-framework lib IBC Test Framework Crate IBC Test Framework Docs
ibc-chain-registry lib Chain Registry Crate Chain Registry Docs

Requirements

The crates in this project require the latest stable version of Rust: 1.60.0.

Hermes Guide

The relayer CLI binary, called hermes, has a comprehensive guide at hermes.informal.systems.

Contributing

IBC is specified in English in the cosmos/ibc repo. Any protocol changes or clarifications should be contributed there.

This repo contains the TLA+ specification and Rust implementation for the IBC modules and relayer. If you're interested in contributing, please comment on an issue or open a new one!

See also CONTRIBUTING.md.

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.

About

IBC Relayer (Hermes) and Modules in Rust

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 95.0%
  • Shell 1.6%
  • TLA 1.6%
  • Python 1.4%
  • CSS 0.4%
  • Makefile 0.0%