README
¶
ibc-go
The Inter-Blockchain Communication protocol (IBC) allows blockchains to talk to each other. This end-to-end, connection-oriented, stateful protocol provides reliable, ordered, and authenticated communication between heterogeneous blockchains.
This IBC implementation in Golang is built as a Cosmos SDK module. To understand more about how to use the ibc-go module as well as about the IBC protocol, please check out the Interchain Developer Academy section on IBC, or our docs.
Roadmap
For an overview of upcoming changes to ibc-go take a look at the roadmap.
This roadmap is also available as a project board.
For the latest expected release timelines, please check here.
For the latest information on the progress of the work or the decisions made that might influence the roadmap, please follow our engineering updates.
Releases
The release lines currently supported are v3, v4, v5 and v6.
Please refer to the Stable Release Policy section of RELEASES.md for more details.
Please refer to our versioning guide for more information on how to understand our release versioning.
Ecosystem
Discover the applications, middleware and light clients developed by other awesome teams in the ecosystem:
In the table below
app refers to IBC application modules for custom use cases and
middleware refers to modules that wrap an IBC application enabling custom logic to be executed.
| Description | Repository | Type |
|---|---|---|
An application that enables on chain querying of another IBC enabled chain utilizing baseapp.Query. Both chains must have implemented the query application and ICA (for queries requiring consensus). |
async-icq | app |
| An application that enables on chain querying of another IBC enabled chains state without the need for the chain being queried to implement the application. | interchain-queries | app |
| An application that enables on chain querying of another IBC enabled chains state without the need for the chain being queried to implement the application. Similar to the interchain-queries application in the row above but without callbacks. | query | app |
| An application that enables cross chain NFT transfer. | NFT Transfer (ICS 721) | app |
| Middleware enabling a packet to be sent to a destination chain via an intermediate chain, e.g. going from Juno to Osmosis via the Hub. | packet-forward-middleware | middleware |
| Middleware enabling the recovery of tokens sent to unsupported addresses. | recovery | middleware |
| Middleware that limits the in or out flow of an asset in a certain time period to minimise the risks of cross chain token transfers. This is implemented as a middleware wrapping ICS20 with the rate limiting logic implemented by cosmwasm contracts | ibc-rate-limit | middleware |
Support
We have active, helpful communities on Discord and Telegram.
For questions and support please use the developers channel in the Cosmos Network Discord server or join the IBC Gang Discord server. The issue list of this repo is exclusively for bug reports and feature requests.
To receive announcements of new releases or other technical updates, please join the Telegram group that we administer.
Contributing
If you're interested in contributing to ibc-go, please take a look at the contributing guidelines. We welcome and appreciate community contributions!
This project adheres to ibc-go's code of conduct. By participating, you are expected to uphold this code.
To help contributors understand which issues are good to pick up, we have the following two categories:
- Issues with the label
good first issueshould be pretty well defined and are best suited for developers new to ibc-go. - Issues with the label
help wantedare a bit more involved and they usually require some familiarity already with the codebase.
If you are interested in working on an issue, please comment on it; then we will be able to assign it to you. We will be happy to answer any questions you may have and help you out while you work on the issue.
If you have any general questions or feedback, please reach out to us in the IBC Gang Discord server.
Request for maintainership
We have a document that describes the process for submitting a feature for maintainership in the ibc-go codebase.
Security
To report a security vulnerability, see our bug bounty program.
Audits
The following audits have been performed on the ibc-go source code:
- ICS27 Interchain Accounts by Trail of Bits
Quick Navigation
-
1.1 ICS 02 Client
1.3 ICS 04 Channel
1.4 ICS 05 Port
1.6 ICS 24 Host
-
Applications
-
Middleware
-
Light Clients
Documentation and Resources
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
modules
|
|
|
apps/27-interchain-accounts
Package ica implements the packet data structure, state machine handling logic, and encoding details for the account management system over an IBC channel between separate chains.
|
Package ica implements the packet data structure, state machine handling logic, and encoding details for the account management system over an IBC channel between separate chains. |
|
apps/27-interchain-accounts/controller/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
apps/27-interchain-accounts/host/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
apps/29-fee
Package fee implements the packet data structure, state machine handling logic, and encoding details for handling fee payments on top of any ICS application protocol.
|
Package fee implements the packet data structure, state machine handling logic, and encoding details for handling fee payments on top of any ICS application protocol. |
|
apps/29-fee/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
apps/transfer
Package transfer implements the packet data structure, state machine handling logic, and encoding details for the transfer of fungible tokens over an IBC channel between two modules on separate chains.
|
Package transfer implements the packet data structure, state machine handling logic, and encoding details for the transfer of fungible tokens over an IBC channel between two modules on separate chains. |
|
apps/transfer/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/02-client
Package client implements the ICS 02 - Client Semantics specification (https://github.com/cosmos/ibc/tree/master/spec/core/ics-002-client-semantics).
|
Package client implements the ICS 02 - Client Semantics specification (https://github.com/cosmos/ibc/tree/master/spec/core/ics-002-client-semantics). |
|
core/02-client/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/03-connection
Package connection implements the ICS 03 - Connection Semantics specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-003-connection-semantics).
|
Package connection implements the ICS 03 - Connection Semantics specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-003-connection-semantics). |
|
core/03-connection/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/04-channel
Package channel implements the ICS 04 - Channel and Packet Semantics specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics).
|
Package channel implements the ICS 04 - Channel and Packet Semantics specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics). |
|
core/04-channel/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/05-port
Package port implements the ICS 05 - Port Allocation specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-005-port-allocation).
|
Package port implements the ICS 05 - Port Allocation specification (https://github.com/cosmos/ibc/tree/main/spec/core/ics-005-port-allocation). |
|
core/24-host
24-host is an implementation of ICS 24.
|
24-host is an implementation of ICS 24. |
|
light-clients/06-solomachine
Package solomachine implements a concrete ClientState, ConsensusState, Header and Misbehaviour types for the Solo Machine light client.
|
Package solomachine implements a concrete ClientState, ConsensusState, Header and Misbehaviour types for the Solo Machine light client. |
|
light-clients/07-tendermint
Package tendermint implements a concrete ClientState, ConsensusState, Header, Misbehaviour and types for the Tendermint consensus light client.
|
Package tendermint implements a concrete ClientState, ConsensusState, Header, Misbehaviour and types for the Tendermint consensus light client. |
|
This file contains the variables, constants, and default values used in the testing package and commonly defined in tests.
|
This file contains the variables, constants, and default values used in the testing package and commonly defined in tests. |
|
mock
This package is only intended to be used for testing core IBC.
|
This package is only intended to be used for testing core IBC. |
|
simapp/params
Package params defines the simulation parameters in the simapp.
|
Package params defines the simulation parameters in the simapp. |