23 releases
0.29.4 | Nov 20, 2024 |
---|---|
0.29.2 | Aug 14, 2024 |
0.29.1 | Jul 23, 2024 |
0.27.2 | Mar 12, 2024 |
0.1.0 | Oct 28, 2022 |
#869 in Magic Beans
3,034 downloads per month
Used in 17 crates
(8 directly)
2MB
49K
SLoC
Hermes IBC relayer
Rust implementation of an Inter-Blockchain Communication (IBC) relayer.
This project comprises primarily of 6 crates:
ibc-relayer
provides an implementation of an IBC relayer, as a library.ibc-relayer-cli
is a CLI (a wrapper over theibc-relayer
library), comprising thehermes
binary.ibc-chain-registry
provides functions to fetch data from the chain registry and automatically generate chain configuration for Hermes.ibc-telemetry
is a library for use in the Hermes CLI, for gathering telemetry data and exposing that in a Prometheus endpoint.ibc-relayer-rest
is a library for use in the Hermes CLI, for exposing a REST API to inspect the state of the relayer.ibc-test-framework
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.
⚠️ The
ibc
andibc-proto
crates have been moved to their own repositories.
The repository also includes TLA+ specifications.
Status
Crate name | Type | Version | Docs |
---|---|---|---|
ibc-relayer-cli | bin: hermes | ||
ibc-relayer | lib | ||
ibc-chain-registry | lib | ||
ibc-relayer-rest | lib | ||
ibc-telemetry | lib | ||
ibc-test-framework | lib |
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.
Dependencies
~72MB
~1.5M SLoC