Skip to content

Commit 40d4c87

Browse files
mergify[bot]crodriguezvegadamiannolan
authored
chore: fix broken links (backport #2511) (#2518)
* 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>
1 parent 96464aa commit 40d4c87

File tree

8 files changed

+58
-7
lines changed

8 files changed

+58
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ write a little note why.
2020

2121
- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
2222
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
23-
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
23+
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/10-structure.md).
2424
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
2525
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
2626
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).

docs/DOCS_README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ We are using [Algolia](https://www.algolia.com) to power full-text search. This
9696
## Consistency
9797

9898
Because the build processes are identical (as is the information contained herein), this file should be kept in sync as
99-
much as possible with its [counterpart in the Cosmos SDK repo](https://github.com/cosmos/cosmos-sdk/tree/master/docs/DOCS_README.md).
99+
much as possible with its [counterpart in the Cosmos SDK repo](https://github.com/cosmos/cosmos-sdk/blob/main/docs/README.md).
100100

101101
### Update and Build the RPC docs
102102

docs/ibc/apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,4 +462,4 @@ callbacks](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/ibc_
462462
463463
## Next {hide}
464464
465-
Learn about [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/intro.md) {hide}
465+
Learn about [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/01-intro.md) {hide}

docs/ibc/apps/apps.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!--
2+
order: 1
3+
-->
4+
5+
# IBC Applications
6+
7+
Learn how to build custom IBC application modules that enable packets to be sent to and received from other IBC-enabled chains. {synopsis}
8+
9+
This document serves as a guide for developers who want to write their own Inter-blockchain Communication Protocol (IBC) applications for custom use cases.
10+
11+
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).
12+
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.
13+
14+
**To have your module interact over IBC you must:**
15+
16+
- implement the `IBCModule` interface, i.e.:
17+
- channel (opening) handshake callbacks
18+
- channel closing handshake callbacks
19+
- packet callbacks
20+
- bind to a port(s)
21+
- add keeper methods
22+
- define your own packet data and acknowledgement structs as well as how to encode/decode them
23+
- add a route to the IBC router
24+
25+
The following sections provide a more detailed explanation of how to write an IBC application
26+
module correctly corresponding to the listed steps.
27+
28+
## Pre-requisites Readings
29+
30+
- [IBC Overview](../overview.md)) {prereq}
31+
- [IBC default integration](../integration.md) {prereq}
32+
33+
## Working example
34+
35+
For a real working example of an IBC application, you can look through the `ibc-transfer` module
36+
which implements everything discussed in this section.
37+
38+
Here are the useful parts of the module to look at:
39+
40+
[Binding to transfer
41+
port](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/keeper/genesis.go)
42+
43+
[Sending transfer
44+
packets](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/keeper/relay.go)
45+
46+
[Implementing IBC
47+
callbacks](https://github.com/cosmos/ibc-go/blob/main/modules/apps/transfer/ibc_module.go)
48+
49+
## Next {hide}
50+
51+
Learn about [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/01-intro.md) {hide}

docs/ibc/integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func NewApp(...args) *App {
139139
140140
### Module Managers
141141
142-
In order to use IBC, we need to add the new modules to the module `Manager` and to the `SimulationManager` in case your application supports [simulations](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/simulator.md).
142+
In order to use IBC, we need to add the new modules to the module `Manager` and to the `SimulationManager` in case your application supports [simulations](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/13-simulator.md).
143143
144144
```go
145145
// app.go

docs/ibc/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ must use for committing IBC messages is defined in
6161
[ICS-24](https://github.com/cosmos/ics/tree/master/spec/core/ics-024-host-requirements) and the proof
6262
format that all implementations must be able to produce and verify is defined in this [ICS-23 implementation](https://github.com/confio/ics23).
6363

64-
### [Capabilities](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/ocap.md)
64+
### [Capabilities](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/core/10-ocap.md)
6565

6666
IBC is intended to work in execution environements where modules do not necessarily trust each
6767
other. Thus IBC must authenticate module actions on ports and channels so that only modules with the

docs/ibc/relayer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 4
77
## Pre-requisites Readings
88

99
- [IBC Overview](./overview.md) {prereq}
10-
- [Events](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/events.md) {prereq}
10+
- [Events](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/core/08-events.md) {prereq}
1111

1212
## Events
1313

modules/apps/transfer/spec/06_metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ order: 6
44

55
# Metrics
66

7-
The transfer IBC application module exposes the following set of [metrics](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/telemetry.md).
7+
The IBC transfer application module exposes the following set of [metrics](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/core/09-telemetry.md).
88

99
| Metric | Description | Unit | Type |
1010
|:--------------------------------|:------------------------------------------------------------------------------------------|:----------------|:--------|

0 commit comments

Comments
 (0)