diff --git a/README.md b/README.md index 569e1e878fd..e8b364cd404 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The [Inter-Blockchain Communication protocol (IBC)](https://ibcprotocol.dev/) allows blockchains to talk to each other. This end-to-end, connection-oriented, stateful protocol provides reliable, ordered, and authenticated communication between heterogeneous blockchains. For a high-level explanation of what IBC is and how it works, please read [this blog post](https://medium.com/the-interchain-foundation/eli5-what-is-ibc-def44d7b5b4c). -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](https://tutorials.cosmos.network/academy/3-ibc/), or [our docs](https://ibc.cosmos.network/main/ibc/overview.html). +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](https://tutorials.cosmos.network/academy/3-ibc/), or [our docs](./docs/docs/01-ibc/01-overview.md). ## Roadmap @@ -139,7 +139,7 @@ The following audits have been performed on the `ibc-go` source code: - [IBC Website](https://ibcprotocol.dev/) - [IBC Protocol Specification](https://github.com/cosmos/ibc) -- [Documentation](https://ibc.cosmos.network/main/ibc/overview.html) +- [Documentation](./docs/docs/01-ibc/01-overview.md) - [Interchain Developer Academy](https://tutorials.cosmos.network/academy/3-ibc/) --- diff --git a/docs/docs/03-light-clients/01-developer-guide/08-proposals.md b/docs/docs/03-light-clients/01-developer-guide/08-proposals.md index c7e4a2da51e..1015901ba73 100644 --- a/docs/docs/03-light-clients/01-developer-guide/08-proposals.md +++ b/docs/docs/03-light-clients/01-developer-guide/08-proposals.md @@ -8,7 +8,7 @@ slug: /ibc/light-clients/proposals # Handling proposals -It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](https://ibc.cosmos.network/main/ibc/proposals.html) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `RecoverClient` should be implemented to handle the proposal. +It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](../../01-ibc/07-proposals.md) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `RecoverClient` should be implemented to handle the proposal. ## Implementing `RecoverClient` diff --git a/docs/docs/05-migrations/05-v3-to-v4.md b/docs/docs/05-migrations/05-v3-to-v4.md index 9527f888ba0..091e11375ef 100644 --- a/docs/docs/05-migrations/05-v3-to-v4.md +++ b/docs/docs/05-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to configure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../04-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to configure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels. diff --git a/docs/tutorials/01-fee/01-intro.md b/docs/tutorials/01-fee/01-intro.md index f3bd825f6a9..09b338f2f34 100644 --- a/docs/tutorials/01-fee/01-intro.md +++ b/docs/tutorials/01-fee/01-intro.md @@ -19,7 +19,7 @@ This is a tutorial for wiring up the ICS-29 Fee Middleware to a Cosmos SDK block - Basic Knowledge of [TypeScript](https://www.typescriptlang.org/) - Basic Knowledge of Cosmos SDK - If you are new to Cosmos SDK, we recommend you to go through the first two categories of the [Developer Portal](https://tutorials.cosmos.network/academy/1-what-is-cosmos/) -- Basic Knowledge of [the Fee Middleware module](https://ibc.cosmos.network/main/middleware/ics29-fee/overview) +- Basic Knowledge of [the Fee Middleware module](../../docs/04-middleware/01-ics29-fee/01-overview.md) diff --git a/docs/versioned_docs/version-v4.6.x/04-migrations/05-v3-to-v4.md b/docs/versioned_docs/version-v4.6.x/04-migrations/05-v3-to-v4.md index 067d8738e68..d916ec51252 100644 --- a/docs/versioned_docs/version-v4.6.x/04-migrations/05-v3-to-v4.md +++ b/docs/versioned_docs/version-v4.6.x/04-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../03-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels. diff --git a/docs/versioned_docs/version-v5.4.x/04-migrations/05-v3-to-v4.md b/docs/versioned_docs/version-v5.4.x/04-migrations/05-v3-to-v4.md index 067d8738e68..d916ec51252 100644 --- a/docs/versioned_docs/version-v5.4.x/04-migrations/05-v3-to-v4.md +++ b/docs/versioned_docs/version-v5.4.x/04-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../03-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels. diff --git a/docs/versioned_docs/version-v6.3.x/04-migrations/05-v3-to-v4.md b/docs/versioned_docs/version-v6.3.x/04-migrations/05-v3-to-v4.md index 067d8738e68..d916ec51252 100644 --- a/docs/versioned_docs/version-v6.3.x/04-migrations/05-v3-to-v4.md +++ b/docs/versioned_docs/version-v6.3.x/04-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../03-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels. diff --git a/docs/versioned_docs/version-v7.5.x/03-light-clients/01-developer-guide/07-proposals.md b/docs/versioned_docs/version-v7.5.x/03-light-clients/01-developer-guide/07-proposals.md index 069342bd5ec..7a5dbb54cdd 100644 --- a/docs/versioned_docs/version-v7.5.x/03-light-clients/01-developer-guide/07-proposals.md +++ b/docs/versioned_docs/version-v7.5.x/03-light-clients/01-developer-guide/07-proposals.md @@ -8,7 +8,7 @@ slug: /ibc/light-clients/proposals # Handling proposals -It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](https://ibc.cosmos.network/main/ibc/proposals.html) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `CheckSubstituteAndUpdateState` should be implemented to handle the proposal. +It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](../../01-ibc/06-proposals.md) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `CheckSubstituteAndUpdateState` should be implemented to handle the proposal. ## Implementing `CheckSubstituteAndUpdateState` diff --git a/docs/versioned_docs/version-v7.5.x/05-migrations/05-v3-to-v4.md b/docs/versioned_docs/version-v7.5.x/05-migrations/05-v3-to-v4.md index 067d8738e68..0c6f5fa35e5 100644 --- a/docs/versioned_docs/version-v7.5.x/05-migrations/05-v3-to-v4.md +++ b/docs/versioned_docs/version-v7.5.x/05-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../04-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels. diff --git a/docs/versioned_docs/version-v8.3.x/03-light-clients/01-developer-guide/07-proposals.md b/docs/versioned_docs/version-v8.3.x/03-light-clients/01-developer-guide/07-proposals.md index a5af1b4c705..0172b189023 100644 --- a/docs/versioned_docs/version-v8.3.x/03-light-clients/01-developer-guide/07-proposals.md +++ b/docs/versioned_docs/version-v8.3.x/03-light-clients/01-developer-guide/07-proposals.md @@ -8,7 +8,7 @@ slug: /ibc/light-clients/proposals # Handling proposals -It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](https://ibc.cosmos.network/main/ibc/proposals.html) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `CheckSubstituteAndUpdateState` should be implemented to handle the proposal. +It is possible to update the client with the state of the substitute client through a governance proposal. [This type of governance proposal](../../01-ibc/07-proposals.md) is typically used to recover an expired or frozen client, as it can recover the entire state and therefore all existing channels built on top of the client. `CheckSubstituteAndUpdateState` should be implemented to handle the proposal. ## Implementing `CheckSubstituteAndUpdateState` diff --git a/docs/versioned_docs/version-v8.3.x/05-migrations/05-v3-to-v4.md b/docs/versioned_docs/version-v8.3.x/05-migrations/05-v3-to-v4.md index d2407df20e8..6707286eadc 100644 --- a/docs/versioned_docs/version-v8.3.x/05-migrations/05-v3-to-v4.md +++ b/docs/versioned_docs/version-v8.3.x/05-migrations/05-v3-to-v4.md @@ -41,7 +41,7 @@ where `icaAuthIBCModule` is the Interchain Accounts authentication IBC Module. The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly. -Please read the Fee Middleware [integration documentation](https://ibc.cosmos.network/main/middleware/ics29-fee/integration.html) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. +Please read the Fee Middleware [integration documentation](../04-middleware/01-ics29-fee/02-integration.md) for an in depth guide on how to congfigure the module correctly in order to incentivize IBC packets. Take a look at the following diff for an [example setup](https://github.com/cosmos/ibc-go/pull/1432/files#diff-d18972debee5e64f16e40807b2ae112ddbe609504a93ea5e1c80a5d489c3a08aL366) of how to incentivize ics27 channels.