-
Notifications
You must be signed in to change notification settings - Fork 597
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* fix broken links (#2511) Co-authored-by: Carlos Rodriguez <crodveg@gmail.com> (cherry picked from commit 4c45212) # Conflicts: # docs/ibc/apps/apps.md # docs/middleware/ics29-fee/fee-distribution.md # modules/apps/transfer/spec/06_metrics.md * resolving conflicts * deleting fee middleware doc Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Damian Nolan <damiannolan@gmail.com>
- Loading branch information
1 parent
c7936a0
commit eb02f1a
Showing
8 changed files
with
58 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
<!-- | ||
order: 1 | ||
--> | ||
|
||
# IBC Applications | ||
|
||
Learn how to build custom IBC application modules that enable packets to be sent to and received from other IBC-enabled chains. {synopsis} | ||
|
||
This document serves as a guide for developers who want to write their own Inter-blockchain Communication Protocol (IBC) applications for custom use cases. | ||
|
||
Due to the modular design of the IBC protocol, IBC application developers do not need to concern themselves with the low-level details of clients, connections, and proof verification. Nevertheless, an overview of these low-level concepts can be found in [the Overview section](../overview.md). | ||
The document goes into detail on the abstraction layer most relevant for application developers (channels and ports), and describes how to define your own custom packets, `IBCModule` callbacks and more to make an application module IBC ready. | ||
|
||
**To have your module interact over IBC you must:** | ||
|
||
- implement the `IBCModule` interface, i.e.: | ||
- channel (opening) handshake callbacks | ||
- channel closing handshake callbacks | ||
- packet callbacks | ||
- bind to a port(s) | ||
- add keeper methods | ||
- define your own packet data and acknowledgement structs as well as how to encode/decode them | ||
- add a route to the IBC router | ||
|
||
The following sections provide a more detailed explanation of how to write an IBC application | ||
module correctly corresponding to the listed steps. | ||
|
||
## Pre-requisites Readings | ||
|
||
- [IBC Overview](../overview.md)) {prereq} | ||
- [IBC default integration](../integration.md) {prereq} | ||
|
||
## Working example | ||
|
||
For a real working example of an IBC application, you can look through the `ibc-transfer` module | ||
which implements everything discussed in this section. | ||
|
||
Here are the useful parts of the module to look at: | ||
|
||
[Binding to transfer | ||
port](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/keeper/genesis.go) | ||
|
||
[Sending transfer | ||
packets](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/keeper/relay.go) | ||
|
||
[Implementing IBC | ||
callbacks](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/ibc_module.go) | ||
|
||
## Next {hide} | ||
|
||
Learn about [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/01-intro.md) {hide} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters