QORel is an IBC relayer for Cosmos SDK chains, maintained by QoreChain. It is a fork of Hermes and keeps Hermes' behaviour, configuration and commands for every chain that signs transactions the standard way. On top of that it adds a pluggable signer layer, so chains that require an additional post-quantum signature on every transaction (such as QoreChain, which requires a hybrid secp256k1 + ML-DSA-87 signature) can be relayed as well.
signing = "standard"(the default): byte-for-byte the Hermes transaction format, for the Cosmos Hub, Osmosis and any other Cosmos SDK chain.signing = "qorechain-hybrid": adds the ML-DSA-87 (FIPS 204) signature that QoreChain verifies; seecrates/qorel-signer.
Status: v0.1, testnet-ready. IBC classic relaying with QoreChain hybrid signing runs between the QoreChain testnet and the Cosmos Hub public testnet (ICS-20 both ways, timeouts, misbehaviour checks). IBC v2 support comes next.
| Binaries (Linux x86_64/arm64, macOS) | GitHub Releases, mirrored on download.qore.host/qorel |
| Debian / Ubuntu, RHEL family | .deb / .rpm on the release page (hardened systemd unit included) |
| Homebrew | brew install qorechain/tap/qorel |
| Container | docker pull ghcr.io/qorechain/qorel (or docker pull liviuepure/qorel) |
| From source | cargo install --locked --git https://github.com/qorechain/QORel ibc-relayer-cli --bin qorel |
Guides:
- docs/qorel/INSTALL.md: install and verify each channel.
- docs/qorel/OPERATORS.md: configuration, keys and gas.
- docs/qorel/VALIDATOR.md: running next to a validator.
- docs/qorel/SIGNING_FROM_ANY_LANGUAGE.md: the post-quantum signer in Rust, TypeScript, Go, Python and Java.
See NOTICE for attribution.
The upstream Hermes README follows.
Rust implementation of an Inter-Blockchain Communication (IBC) relayer.
This project comprises primarily of 6 crates:
ibc-relayerprovides an implementation of an IBC relayer, as a library.ibc-relayer-cliis a CLI (a wrapper over theibc-relayerlibrary), comprising thehermesbinary.ibc-chain-registryprovides functions to fetch data from the chain registry and automatically generate chain configuration for Hermes.ibc-telemetryis a library for use in the Hermes CLI, for gathering telemetry data and exposing that in a Prometheus endpoint.ibc-relayer-restis a library for use in the Hermes CLI, for exposing a REST API to inspect the state of the relayer.ibc-test-frameworkprovides 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.
⚠️ Theibcandibc-protocrates have been moved to their own repositories.
The repository also includes TLA+ specifications.
| 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 |  |
 |
The crates in this project require Rust 1.85.0.
We have a comprehensive guide at hermes.informal.systems.
If you encounter any issues or have questions related to Hermes, we encourage you to open a GitHub issue. This ensures a streamlined process for tracking and resolving problems.
Please use the following link to report your issue: https://github.com/informalsystems/hermes/issues/new?assignees=&labels=&projects=&template=bug-report.md
Providing clear and detailed information in your issue will help us address it more efficiently.
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.
We follow Semantic Versioning, though APIs are still under active development.
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.