Skip to content

Commit f705142

Browse files
fix broken links (#415)
* fix for a large portion of the broken links and adding config file for the markdown link checker * modify link checker yaml to use config file * fix link checker yaml * fix some more links and the path to the config file for the markdown link checker * fix some more dead links * tweak markdown link checker configuration and remove deprecated section from docs * address review comments * fix url for png Co-authored-by: Carlos Rodriguez <[email protected]>
1 parent 9e39349 commit f705142

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+83
-86
lines changed
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "(localhost)"
5+
}
6+
],
7+
"retryOn429": true,
8+
"retryCount": 3,
9+
"fallbackRetryDelay": "10s"
10+
}

.github/workflows/link-check.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ jobs:
55
runs-on: ubuntu-latest
66
steps:
77
- uses: actions/checkout@v2
8-
- uses: gaurav-nelson/github-action-markdown-link-check@v1
8+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
9+
with:
10+
config-file: '.github/workflows/link-check-config.json'

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The IBC module was originally released in [v0.40.0](https://github.com/cosmos/co
120120
Please see the [Release Notes](https://github.com/cosmos/cosmos-sdk/blob/v0.40.0/RELEASE_NOTES.md).
121121

122122
The IBC module is also contained in the releases for [v0.41.x](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.0) and [v0.42.x](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.0).
123-
Please see the Release Notes for [v0.41.x](https://github.com/cosmos/cosmos-sdk/blob/release/v0.41.x/RELEASE_NOTES.md) and [v0.42.x](https://github.com/cosmos/cosmos-sdk/blob/release/v0.42.x/RELEASE_NOTES.md).
123+
Please see the Release Notes for [v0.41.x](https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/RELEASE_NOTES.md) and [v0.42.x](https://github.com/cosmos/cosmos-sdk/blob/v0.42.0/RELEASE_NOTES.md).
124124

125125
The IBC module was removed in the commit hash [da064e13d56add466548135739c5860a9f7ed842](https://github.com/cosmos/cosmos-sdk/commit/da064e13d56add466548135739c5860a9f7ed842) on the SDK. The release for SDK v0.43.0 will be the first release without the IBC module.
126126

SECURITY.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Security
22

33
> **IMPORTANT**: If you find a security issue, you can contact our team directly at
4-
[email protected], or report it to our [bug bounty program](https://hackerone.com/tendermint) on HackerOne. *DO NOT* open a public issue on the repository.
4+
[email protected], or report it to our [bug bounty program](https://hackerone.com/cosmos) on HackerOne. *DO NOT* open a public issue on the repository.
55

66
## Bug Bounty
77

88
As part of our [Coordinated Vulnerability Disclosure Policy](https://tendermint.com/security), we operate a
9-
[bug bounty program](https://hackerone.com/tendermint) with Hacker One.
9+
[bug bounty program](https://hackerone.com/cosmos) with Hacker One.
1010

1111
See the policy linked above for more details on submissions and rewards and read
1212
this [blog post](https://blog.cosmos.network/bug-bounty-program-for-tendermint-cosmos-833c67693586) for the program scope.
1313

1414
The following is a list of examples of the kinds of bugs we're most interested
15-
in for the IBC Golang repository. Please refer to the corresponding repositories for vulnerabilities on the [Cosmos SDK]((https://github.com/cosmos/cosmos-sdk/blob/master/SECURITY.md)) and [Tendermint](https://github.com/tendermint/tendermint/blob/master/SECURITY.md) repositories.
15+
in for the IBC Golang repository. Please refer to the corresponding repositories for vulnerabilities on the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/blob/master/SECURITY.md) and [Tendermint](https://github.com/tendermint/tendermint/blob/master/SECURITY.md) repositories.
1616

1717
### IBC Core
1818

19-
- [`02-client`](https://github.com/cosmos/ibc-go/tree/modules/core/02-client)
20-
- [`03-connection`](https://github.com/cosmos/ibc-go/tree/modules/core/03-connection)
21-
- [`04-channel`](https://github.com/cosmos/ibc-go/tree/modules/core/04-channel)
22-
- [`05-port`](https://github.com/cosmos/ibc-go/tree/modules/core/05-port)
23-
- [`23-commitment`](https://github.com/cosmos/ibc-go/tree/modules/core/23-commitment)
24-
- [`24-host`](https://github.com/cosmos/ibc-go/tree/modules/core/24-host)
19+
- [`02-client`](https://github.com/cosmos/ibc-go/tree/main/modules/core/02-client)
20+
- [`03-connection`](https://github.com/cosmos/ibc-go/tree/main/modules/core/03-connection)
21+
- [`04-channel`](https://github.com/cosmos/ibc-go/tree/main/modules/core/04-channel)
22+
- [`05-port`](https://github.com/cosmos/ibc-go/tree/main/modules/core/05-port)
23+
- [`23-commitment`](https://github.com/cosmos/ibc-go/tree/main/modules/core/23-commitment)
24+
- [`24-host`](https://github.com/cosmos/ibc-go/tree/main/modules/core/24-host)
2525

2626
### IBC Applications
2727

28-
- [`transfer`](https://github.com/cosmos/ibc-go/tree/modules/apps/transfer)
28+
- [`transfer`](https://github.com/cosmos/ibc-go/tree/main/modules/apps/transfer)
2929

3030
### Light Clients
3131

32-
- [`07-tendermint`](https://github.com/cosmos/ibc-go/tree/modules/light-clients/07-tendermint)
32+
- [`07-tendermint`](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/07-tendermint)

docs/DOCS_README.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you want to update the documentation please open a pr on ibc-go.
1010

1111
## Docs Build Workflow
1212

13-
The documentation for the Cosmos SDK is hosted at https://ibc.cosmos.network/
13+
The documentation for IBC-Go is hosted at https://ibc.cosmos.network.
1414

1515
built from the files in this (`/docs`) directory for
1616
[main](https://github.com/cosmos/ibc-go/tree/main/docs).
@@ -87,16 +87,6 @@ Run `pre` and `post` hooks and start a hot-reloading web-server. See output of t
8787

8888
To build documentation as a static website run `npm run build`. You will find the website in `.vuepress/dist` directory.
8989

90-
## Build RPC Docs
91-
92-
TODO: is this still true?
93-
94-
First, run `make tools` from the root of repo, to install the swagger-ui tool.
95-
96-
Then, edit the `swagger.yaml` manually; it is found [here](https://github.com/cosmos/cosmos-sdk/blob/master/client/lcd/swagger-ui/swagger.yaml)
97-
98-
Finally, run `make update_gaia_lite_docs` from the root of the repo.
99-
10090
## Search
10191

10292
TODO: update or remove

docs/OLD_README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ parent:
55
title: "ibc"
66
-->
77

8+
<!-- markdown-link-check-disable -->
89
# `ibc`
910

1011
## Abstract
@@ -113,3 +114,4 @@ x/ibc
113114
│   └── 09-localhost/
114115
└── testing/
115116
```
117+
<!-- markdown-link-check-enable-->

docs/architecture/adr-001-coin-source-tracing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Accepted, Implemented
1212
## Context
1313

1414
The specification for IBC cross-chain fungible token transfers
15-
([ICS20](https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer)), needs to
15+
([ICS20](https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer)), needs to
1616
be aware of the origin of any token denomination in order to relay a `Packet` which contains the sender
1717
and recipient addressed in the
1818
[`FungibleTokenPacketData`](https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures).
@@ -199,7 +199,7 @@ func (msg MsgTransfer) ValidateBasic() error {
199199
// ValidateIBCDenom validates that the given denomination is either:
200200
//
201201
// - A valid base denomination (eg: 'uatom')
202-
// - A valid fungible token representation (i.e 'ibc/{hash}') per ADR 001 https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-001-coin-source-tracing.md
202+
// - A valid fungible token representation (i.e 'ibc/{hash}') per ADR 001 https://github.com/cosmos/ibc-go/blob/main/docs/architecture/adr-001-coin-source-tracing.md
203203
func ValidateIBCDenom(denom string) error {
204204
denomSplit := strings.SplitN(denom, "/", 2)
205205

docs/architecture/adr-015-ibc-packet-receiver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -296,4 +296,4 @@ Proposed
296296
## References
297297

298298
- Relevant comment: [cosmos/ics#289](https://github.com/cosmos/ics/issues/289#issuecomment-544533583)
299-
- [ICS26 - Routing Module](https://github.com/cosmos/ics/blob/master/spec/ics-026-routing-module)
299+
- [ICS26 - Routing Module](https://github.com/cosmos/ibc/tree/master/spec/core/ics-026-routing-module)

docs/ibc/apps.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 3
77
Learn how to configure your application to use IBC and send data packets to other chains. {synopsis}
88

99
This document serves as a guide for developers who want to write their own Inter-blockchain
10-
Communication Protocol (IBC) applications for custom [use-cases](https://github.com/cosmos/ics/blob/master/ibc/4_IBC_USECASES.md).
10+
Communication Protocol (IBC) applications for custom use cases.
1111

1212
Due to the modular design of the IBC protocol, IBC
1313
application developers do not need to concern themselves with the low-level details of clients,
@@ -255,7 +255,7 @@ to implement callbacks for handling the packet flow through a channel.
255255
Once a module A and module B are connected to each other, relayers can start relaying packets and
256256
acknowledgements back and forth on the channel.
257257

258-
![IBC packet flow diagram](https://media.githubusercontent.com/media/cosmos/ics/master/spec/ics-004-channel-and-packet-semantics/packet-state-machine.png)
258+
![IBC packet flow diagram](https://media.githubusercontent.com/media/cosmos/ibc/old/spec/ics-004-channel-and-packet-semantics/channel-state-machine.png)
259259

260260
Briefly, a successful packet flow works as follows:
261261

@@ -353,7 +353,7 @@ receive acknowledegments with the IBC modules as byte strings.
353353

354354
Thus, modules must agree on how to encode/decode acknowledgements. The process of creating an
355355
acknowledgement struct along with encoding and decoding it, is very similar to the packet data
356-
example above. [ICS 04](https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope)
356+
example above. [ICS 04](https://github.com/cosmos/ibc/blob/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope)
357357
specifies a recommended format for acknowledgements. This acknowledgement type can be imported from
358358
[channel types](https://github.com/cosmos/ibc-go/tree/main/modules/core/04-channel/types).
359359

@@ -366,7 +366,7 @@ While modules may choose arbitrary acknowledgement structs, a default acknowledg
366366
// conflicts with other protobuf message formats used for acknowledgements.
367367
// The first byte of any message with this format will be the non-ASCII values
368368
// `0xaa` (result) or `0xb2` (error). Implemented as defined by ICS:
369-
// https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope
369+
// https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope
370370
message Acknowledgement {
371371
// response contains either a result or an error and must be non-empty
372372
oneof response {

docs/ibc/integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ connection handhake.
178178
The IBC module also has
179179
[`BeginBlock`](https://github.com/cosmos/ibc-go/blob/main/modules/core/02-client/abci.go) logic as
180180
well. This is optional as it is only required if your application uses the [localhost
181-
client](https://github.com/cosmos/ics/blob/master/spec/ics-009-loopback-client) to connect two
181+
client](https://github.com/cosmos/ibc/blob/master/spec/client/ics-009-loopback-client) to connect two
182182
different modules from the same chain.
183183
184184
::: tip

docs/ibc/overview.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Learn what IBC is, its components and use cases. {synopsis}
1111
## What is the Interblockchain Communication Protocol (IBC)?
1212

1313
This document serves as a guide for developers who want to write their own Inter-blockchain
14-
Communication Protocol (IBC) applications for custom [use-cases](https://github.com/cosmos/ics/blob/master/ibc/4_IBC_USECASES.md).
14+
Communication Protocol (IBC) applications for custom use cases.
1515

1616
Due to the modular design of the IBC protocol, IBC
1717
application developers do not need to concern themselves with the low-level details of clients,
@@ -61,12 +61,12 @@ 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](./ocap.md)
64+
### [Capabilities](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/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
6868
appropriate permissions can use them. This is accomplished using [dynamic
69-
capabilities](../architecture/adr-003-dynamic-capability-store.md). Upon binding to a port or
69+
capabilities](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-003-dynamic-capability-store.md). Upon binding to a port or
7070
creating a channel for a module, IBC will return a dynamic capability that the module must claim in
7171
order to use that port or channel. This prevents other modules from using that port or channel since
7272
they will not own the appropriate capability.
@@ -175,8 +175,8 @@ Once an acknowledgement is received successfully on the original sender the chai
175175

176176
If you want to learn more about IBC, check the following specifications:
177177

178-
* [IBC specification overview](https://github.com/cosmos/ics/blob/master/ibc/README.md)
179-
* [IBC SDK specification](../../modules/ibc)
178+
* [IBC specification overview](https://github.com/cosmos/ibc/blob/master/README.md)
179+
* [IBC SDK specification](../../modules/core/spec/README.md)
180180

181181
## Next {hide}
182182

docs/ibc/proto-docs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ upgrade.
616616
### MsgTransfer
617617
MsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between
618618
ICS20 enabled chains. See ICS Spec here:
619-
https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures
619+
https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures
620620

621621

622622
| Field | Type | Label | Description |
@@ -675,7 +675,7 @@ Msg defines the ibc/transfer Msg service.
675675
### FungibleTokenPacketData
676676
FungibleTokenPacketData defines a struct for the packet payload
677677
See FungibleTokenPacketData spec:
678-
https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures
678+
https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures
679679

680680

681681
| Field | Type | Label | Description |
@@ -715,7 +715,7 @@ NOTE: The field numbers 21 and 22 were explicitly chosen to avoid accidental
715715
conflicts with other protobuf message formats used for acknowledgements.
716716
The first byte of any message with this format will be the non-ASCII values
717717
`0xaa` (result) or `0xb2` (error). Implemented as defined by ICS:
718-
https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope
718+
https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope
719719

720720

721721
| Field | Type | Label | Description |

docs/migrations/ibc-migration-043.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The IBC Keeper now takes in the Upgrade Keeper. Please add the chains' Upgrade K
104104

105105
### UpdateClientProposal
106106

107-
The `UpdateClient` has been modified to take in two client-identifiers and one initial height. Please see the [documentation](../proposals.md) for more information.
107+
The `UpdateClient` has been modified to take in two client-identifiers and one initial height. Please see the [documentation](../ibc/proposals.md) for more information.
108108

109109
### UpgradeProposal
110110

modules/apps/transfer/keeper/msg_server.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99

1010
var _ types.MsgServer = Keeper{}
1111

12-
// See createOutgoingPacket in spec:https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
12+
// See createOutgoingPacket in spec:https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#packet-relay
1313

1414
// Transfer defines a rpc handler method for MsgTransfer.
1515
func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.MsgTransferResponse, error) {

modules/apps/transfer/keeper/relay.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func (k Keeper) SendTransfer(
8181
}
8282

8383
// begin createOutgoingPacket logic
84-
// See spec for this logic: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#packet-relay
84+
// See spec for this logic: https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#packet-relay
8585
channelCap, ok := k.scopedKeeper.GetCapability(ctx, host.ChannelCapabilityPath(sourcePort, sourceChannel))
8686
if !ok {
8787
return sdkerrors.Wrap(channeltypes.ErrChannelCapabilityNotFound, "module does not own channel capability")

modules/apps/transfer/spec/01_concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 1
66

77
## Acknowledgements
88

9-
ICS20 uses the recommended acknowledgement format as specified by [ICS 04](https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics#acknowledgement-envelope).
9+
ICS20 uses the recommended acknowledgement format as specified by [ICS 04](https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope).
1010

1111
A successful receive of a transfer packet will result in a Result Acknowledgement being written
1212
with the value `[]byte(byte(1))` in the `Response` field.

modules/apps/transfer/spec/02_state.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ order: 2
44

55
# State
66

7-
The transfer IBC application module keeps state of the port to which the module is binded and the denomination trace information as outlined in [ADR 01](./../../../../../docs/architecture/adr-001-coin-source-tracing.md).
7+
The transfer IBC application module keeps state of the port to which the module is binded and the denomination trace information as outlined in [ADR 01](./../../../../docs/architecture/adr-001-coin-source-tracing.md).
88

99
- `Port`: `0x01 -> ProtocolBuffer(string)`
1010
- `DenomTrace`: `0x02 | []bytes(traceHash) -> ProtocolBuffer(DenomTrace)`

modules/apps/transfer/spec/04_messages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This message is expected to fail if:
2929
- `Sender` is empty
3030
- `Receiver` is empty
3131
- `TimeoutHeight` and `TimeoutTimestamp` are both zero
32-
- `Token.Denom` is not a valid IBC denomination as per [ADR 001 - Coin Source Tracing](./../../../../../docs/architecture/adr-001-coin-source-tracing.md).
32+
- `Token.Denom` is not a valid IBC denomination as per [ADR 001 - Coin Source Tracing](./../../../../docs/architecture/adr-001-coin-source-tracing.md).
3333

3434
This message will send a fungible token to the counterparty chain represented
3535
by the counterparty Channel End connected to the Channel End with the identifiers

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

+1-1
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](./../../../../../docs/core/telemetry.md).
7+
The transfer IBC application module exposes the following set of [metrics](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/telemetry.md).
88

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

modules/apps/transfer/spec/07_params.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,12 @@ The transfers enabled parameter controls send cross-chain transfer capabilities
1717
tokens.
1818

1919
To prevent a single token from being transferred from the chain, set the `SendEnabled` parameter to `true` and
20-
then set the bank module's [`SendEnabled` parameter](./../../../../bank/spec/05_params.md#sendenabled) for
21-
the denomination to `false`.
20+
then set the bank module's [`SendEnabled` parameter](https://github.com/cosmos/cosmos-sdk/blob/master/x/bank/spec/05_params.md#sendenabled) for the denomination to `false`.
2221

2322
## ReceiveEnabled
2423

2524
The transfers enabled parameter controls receive cross-chain transfer capabilities for all fungible
2625
tokens.
2726

2827
To prevent a single token from being transferred to the chain, set the `ReceiveEnabled` parameter to `true` and
29-
then set the bank module's [`SendEnabled` parameter](./../../../../bank/spec/05_params.md#sendenabled) for
30-
the denomination to `false`.
28+
then set the bank module's [`SendEnabled` parameter](https://github.com/cosmos/cosmos-sdk/blob/master/x/bank/spec/05_params.md#sendenabled) for the denomination to `false`.

modules/apps/transfer/spec/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ parent:
1111

1212
This paper defines the implementation of the ICS20 protocol on the Cosmos SDK.
1313

14-
For the general specification please refer to the [ICS20 Specification](https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer).
14+
For the general specification please refer to the [ICS20 Specification](https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer).
1515

1616
## Contents
1717

modules/apps/transfer/types/packet.pb.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)