Home

Awesome

Hermes IBC relayer

hermes-banner

Cosmos ecosystem

Build Status Integration tests Apache 2.0 Licensed Rust Stable Rust 1.76+

Rust implementation of an Inter-Blockchain Communication (IBC) relayer.

This project comprises primarily of 6 crates:

See the table below for more details.

⚠️ The ibc and ibc-proto crates have been moved to their own repositories.

The repository also includes TLA+ specifications.

Status

Crate nameTypeVersionDocs
ibc-relayer-clibin: hermesIBC Relayer CLI CrateIBC Relayer CLI Docs
ibc-relayerlibIBC Relayer CrateIBC Relayer Docs
ibc-chain-registrylibChain Registry CrateChain Registry Docs
ibc-relayer-restlibIBC Relayer REST CrateIBC Relayer REST Docs
ibc-telemetrylibIBC Telemetry CrateIBC Telemetry Docs
ibc-test-frameworklibIBC Test Framework CrateIBC Test Framework Docs

Requirements

The crates in this project require Rust 1.76.0.

Hermes Guide

We have 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 © 2023 Informal Systems Inc. and Hermes 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.

<!-- markdown-link-check-disable --> <!-- markdown-link-check-enabled -->