Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs to docusaurus #3511

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
138 commits
Select commit Hold shift + click to select a range
a4a6d1f
renamed 'docs/' directory to 'docs-vuepress/', this directory is to b…
srdtrk Apr 19, 2023
b442fca
ran 'npm init docusaurus' in the root directory with project name an…
srdtrk Apr 19, 2023
ddd031f
removed directory as we will not be using the blog plugin
srdtrk Apr 19, 2023
83a2a89
removed blog entry from the navbar
srdtrk Apr 19, 2023
278ee6f
removed blog entry from the footer
srdtrk Apr 19, 2023
351f629
removed blog entry from the presets
srdtrk Apr 19, 2023
5e06616
removed the landing page files
srdtrk Apr 19, 2023
5abf3ac
routed root directory to the docs
srdtrk Apr 19, 2023
57a1c15
added metadata to intro.md for root to route to docs properly
srdtrk Apr 19, 2023
15ed483
changed the intro page to ibc content
srdtrk Apr 20, 2023
e958728
wip - migrating Using ibc-go section from vuepress
srdtrk Apr 20, 2023
c217848
sidebar position error fixed
srdtrk Apr 20, 2023
c3bb046
added keeper subsubsection
srdtrk Apr 20, 2023
e2a7f39
fixed slug error
srdtrk Apr 20, 2023
033344f
added packet_acks subsubsection
srdtrk Apr 20, 2023
c97bc78
added routing subsubsection
srdtrk Apr 20, 2023
b9646ee
created middleware subcategory
srdtrk Apr 20, 2023
25f6de8
migrated images from docs-vuepress to new docs
srdtrk Apr 20, 2023
c089603
migrated the middleware subcategory
srdtrk Apr 20, 2023
9bb90ff
created the upgrades subcategory
srdtrk Apr 20, 2023
169b0ea
migrated the upgrades subcategory
srdtrk Apr 20, 2023
9d4843e
completed migrating using-ibc-go section
srdtrk Apr 20, 2023
5c9aeb0
removed the default tutorial content from docs/
srdtrk Apr 20, 2023
bf79d90
added cosmos logos to static/img and removed docusaurus logos
srdtrk Apr 20, 2023
cef697b
updated the project info, navbar, and footer
srdtrk Apr 20, 2023
796059e
removed edit this page links
srdtrk Apr 20, 2023
5824d07
added dark mode support to the navbar logo
srdtrk Apr 20, 2023
6cdbf48
created ibc-apps category
srdtrk Apr 20, 2023
fc2acd5
created ica subcategory
srdtrk Apr 20, 2023
095ee8f
migrated overview to ica subcategory
srdtrk Apr 20, 2023
1491179
modified the label of category 01
srdtrk Apr 20, 2023
f60adee
migrated 02-08 to ica subcategory
srdtrk Apr 20, 2023
45190d1
created legacy subsubcategory in ica subcategory
srdtrk Apr 20, 2023
615b425
migrated legacy subsubcategory
srdtrk Apr 20, 2023
3b09b13
created transfer subcategory
srdtrk Apr 20, 2023
efc4b50
migrated transfer subcategory
srdtrk Apr 20, 2023
dab540e
created middleware-modules category
srdtrk Apr 20, 2023
7736efb
created fee-middleware subcategory
srdtrk Apr 20, 2023
6465428
migrated fee-middleware subcategory
srdtrk Apr 20, 2023
1b5ea9c
renamed middleware to 04 to make space for light clients
srdtrk Apr 20, 2023
59b09f2
created light-clients category
srdtrk Apr 20, 2023
7660e90
created dev-guide subcategory
srdtrk Apr 20, 2023
e07d7f0
changed the slug and id of middleware files to use 04 instead of 03
srdtrk Apr 20, 2023
ce72927
migrated dev-guide subcategory
srdtrk Apr 20, 2023
0877ddd
changed the docs logo to ibc.svg
srdtrk Apr 21, 2023
2423e11
created the localhost subcategory
srdtrk Apr 21, 2023
cd2cbd5
migrated the localhost subcategory
srdtrk Apr 21, 2023
4dad83e
created the solomachine subcategory
srdtrk Apr 21, 2023
22ba9be
migrated the solomachine subcategory
srdtrk Apr 22, 2023
93e7ac2
created the migrations category
srdtrk Apr 22, 2023
900cc40
empty description is not allowed.
srdtrk Apr 22, 2023
44a655a
excluding .template.md markdown files
srdtrk Apr 22, 2023
f883caa
migrated the migrations category
srdtrk Apr 22, 2023
2f01e48
renamed the tutorialSidebar to defaultSidebar
srdtrk Apr 22, 2023
fcb63b5
added a resources category to the sidebar
srdtrk Apr 22, 2023
c0c15f4
added version dropdown menu. Added place holder link for pre v7.1 ver…
srdtrk Apr 22, 2023
7ed3319
ran 'npm install tailwindcss'
srdtrk Apr 22, 2023
80b35de
ran 'npx tailwindcss init'
srdtrk Apr 22, 2023
a6bc362
cloned config from cosmos-sdk docs
srdtrk Apr 22, 2023
7e97787
cloned style files from cosmos-sdk docs
srdtrk Apr 22, 2023
87a0801
added missing svg from cosmos-sdk docs
srdtrk Apr 22, 2023
b69e5b0
improved github logo
srdtrk Apr 22, 2023
e8d2847
ran 'npm i postcss'
srdtrk Apr 22, 2023
37c812f
ran 'npm i postcss-import'
srdtrk Apr 22, 2023
4cb45e7
ran 'npm i autoprefixer'
srdtrk Apr 22, 2023
f51cb58
added myPlugin from cosmos-sdk
srdtrk Apr 22, 2023
1f6ef78
ran 'npm i @you54f/theme-github-codeblock'
srdtrk Apr 22, 2023
f68573e
applied @you54f/theme-github-codeblock theme
srdtrk Apr 22, 2023
ad04dbe
changed all the links in '_category_.json' to null
srdtrk Apr 22, 2023
1972f61
commented out documentation navbar item
srdtrk Apr 22, 2023
9af92d1
added ADRs and Documentation to the navbar - todo, implement ADRs
srdtrk Apr 23, 2023
6fc855b
decided to maintain architecture in the same directory as before
srdtrk Apr 23, 2023
e2574dd
ran 'npm i @docusaurus/plugin-content-docs'
srdtrk Apr 23, 2023
d4bd72f
docs generated by script - todo: some links are not perfect, and ther…
srdtrk Apr 23, 2023
2a1e8dc
all the images had been moved into docs directory by the script
srdtrk Apr 23, 2023
f51e9ca
following the new naming conventions that we are coming up with
srdtrk Apr 23, 2023
d07fe12
have a working version of ADRs navbar item - todo: improve its ordering
srdtrk Apr 23, 2023
92923cb
old docs-vuepress is no longer needed in the repo for backup
srdtrk Apr 23, 2023
1948d35
fixed the ::: warning typo
srdtrk Apr 23, 2023
39c019a
moved readme to top in docusaurus
srdtrk Apr 23, 2023
b8b8ddc
merge main
srdtrk Apr 24, 2023
70f6519
moved the migration code to the new docs directory
srdtrk Apr 24, 2023
b21357f
added metadata for docusaurus
srdtrk Apr 24, 2023
28f969e
updated README.md
srdtrk Apr 24, 2023
22996db
cloned from old docs - todo: update in a future PR
srdtrk Apr 24, 2023
4bcc421
found this depreciated unlinked events document. Adding it here for p…
srdtrk Apr 24, 2023
ea47256
fixed some md links
srdtrk Apr 24, 2023
419b320
remove unused sidebar
srdtrk Apr 24, 2023
35ddcfa
renamed to README.md
srdtrk Apr 25, 2023
4a56983
clone ibc-go-image.png
srdtrk Apr 25, 2023
98b5d94
updated todo statements
srdtrk Apr 25, 2023
dd469a3
updated a changed link to docs
srdtrk Apr 25, 2023
efcb627
updated a changed link to docs
srdtrk Apr 25, 2023
9eeb077
renamed DOCS_README.md -> README.md
srdtrk Apr 25, 2023
be7cc71
ran markdownlint (markdownlint . --fix)
srdtrk Apr 25, 2023
7e1d265
ran 'make docs-lint' again
srdtrk Apr 25, 2023
3b4cd8d
added dev files back in docs
srdtrk Apr 25, 2023
a986d89
updated links
srdtrk Apr 25, 2023
ad9dcc0
updated the link to ibc-go-image.png
srdtrk Apr 25, 2023
b455920
added todo lines to easy to forget areas
srdtrk Apr 25, 2023
23ddb4a
updated links
srdtrk Apr 25, 2023
02d91ad
broken reference removed
srdtrk Apr 25, 2023
6081bc3
updated broken references
srdtrk Apr 25, 2023
861e575
title changed
srdtrk Apr 26, 2023
12f7af8
README updated
srdtrk Apr 26, 2023
1e6935c
updated the social card
srdtrk Apr 26, 2023
613cc05
added colors to hyperlinks in dark mode so they are easier to see
srdtrk Apr 26, 2023
1d7018b
cloned the requirements directory from old docs - there is no way to …
srdtrk Apr 26, 2023
34793b1
added more comments about documentation images
srdtrk Apr 26, 2023
436d46e
fixed order: 1 showing as the title
srdtrk Apr 26, 2023
c486789
updated prism additional languages
srdtrk Apr 26, 2023
d980171
fixed footer light mode styling
srdtrk Apr 26, 2023
d20f526
cosmos' logo added to static images
srdtrk Apr 26, 2023
b71c034
added cosmos' logo to the footer
srdtrk Apr 26, 2023
4d26daa
fixed the prerequisite reading sections
srdtrk Apr 26, 2023
e81ad72
removed code block from sidebar
srdtrk Apr 26, 2023
d38829e
fixed content styling in a markdown file
srdtrk Apr 26, 2023
c3aa72e
fixed a styling error in a markdown file
srdtrk Apr 26, 2023
e266529
fixed links to events.md not working
srdtrk Apr 27, 2023
225d893
ran 'npm install --save @docusaurus/plugin-client-redirects'
srdtrk Apr 27, 2023
fce6593
fixed adr links issue in production mode (not dev server)
srdtrk Apr 27, 2023
5a2aeae
fixed adr links issue in production mode (not dev server)
srdtrk Apr 27, 2023
596d840
updated the name of the logo in config
srdtrk Apr 27, 2023
ac0f3c1
remove typo from docs/docs/01-ibc/04-middleware/01-overview.md
srdtrk Apr 27, 2023
22087b2
added issue trackers to TODOs
srdtrk Apr 27, 2023
18aa195
removed readme reference to vuepress and replaced it with an issue tr…
srdtrk Apr 27, 2023
3288617
brought migration template back
srdtrk Apr 27, 2023
222284f
added intro to upgrades back
srdtrk Apr 27, 2023
2d0b68c
added audits back to docs. This document is not hosted on the website…
srdtrk Apr 27, 2023
2893ff9
changed the depreciation notice to a danger element
srdtrk Apr 27, 2023
6cc19c7
fixed broken links
srdtrk Apr 27, 2023
5b5b2a6
added the params.md from the old docs
srdtrk Apr 27, 2023
e1c73de
added slug to params.md
srdtrk Apr 27, 2023
bd6a332
hosting params.md on the website now (even though it is not possible …
srdtrk Apr 27, 2023
eeeec2b
renamed 01-light-clients/ -> 01-developer-guide/
srdtrk Apr 27, 2023
af975a6
renamed 03-ibc/ -> 03-light-clients
srdtrk Apr 27, 2023
a162ad6
fixed broken ref
srdtrk Apr 27, 2023
d97caf5
Resolved conflicts by keeping the deleted files removed
srdtrk May 3, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions .github/ISSUE_TEMPLATE/release-tracker.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
name: Release tracker
about: Create an issue to track release progress

---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template.
v Word of caution: poorly thought-out proposals may be rejected
v without deliberation
v Word of caution: poorly thought-out proposals may be rejected
v without deliberation
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Milestones
Expand All @@ -32,7 +31,7 @@ versions of ibc-go to guarantee that no regression is introduced -->

### Other testing

## Migration
## Migration

<!-- Link to migration document -->

Expand All @@ -42,7 +41,7 @@ versions of ibc-go to guarantee that no regression is introduced -->

- [ ] Bump [go package version](https://github.com/cosmos/ibc-go/blob/main/go.mod#L3).
- [ ] Change all imports starting with `github.com/cosmos/ibc-go/v{x}` to `github.com/cosmos/ibc-go/v{x+1}`.
- [ ] Branch off main to create release branch in the form of `release/vx.y.z` and add branch protection rules.
- [ ] Branch off main to create release branch in the form of `release/vx.y.z` and add branch protection rules.
- [ ] Add branch protection rules to new release branch.
- [ ] Add backport task to [`mergify.yml`](https://github.com/cosmos/ibc-go/blob/main/.github/mergify.yml)
- [ ] Upgrade ibc-go version in [ibctest](https://github.com/strangelove-ventures/ibctest).
Expand All @@ -58,7 +57,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
- Add the new release.
- Remove any tags that might not be recommended anymore.
- [ ] Update the list of [supported release lines in README.md](https://github.com/cosmos/ibc-go#releases), if necessary.
- [ ] Update docs site:
- [ ] (TODO: [#3522](https://github.com/cosmos/ibc-go/issues/3522)) Update docs site:
- [ ] Add new release branch to [`docs/versions`](https://github.com/cosmos/ibc-go/blob/main/docs/versions) file.
- [ ] Add `label` and `key` to `versions` array in [`config.js`](https://github.com/cosmos/ibc-go/blob/main/docs/.vuepress/config.js#L62).
- [ ] Bump ibc-go version in [cosmos/interchain-accounts-demo repository](https://github.com/cosmos/interchain-accounts-demo) and create a tag.
Expand All @@ -71,7 +70,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
- [ ] After changes to docs site are deployed, check [ibc.cosmos.network](https://ibc.cosmos.network) is updated.
- [ ] Open issue in [SDK tutorials repo](https://github.com/cosmos/sdk-tutorials) to update tutorials to the released version of ibc-go.

____
---

#### For Admin Use

Expand Down
20 changes: 10 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
### Features

### Bug Fixes
## [v7.0.0](https://github.com/cosmos/ibc-go/releases/tag/v6.1.0) - 2023-03-17

## [v7.0.0](https://github.com/cosmos/ibc-go/releases/tag/v6.1.0) - 2023-03-17

### Dependencies

Expand Down Expand Up @@ -80,7 +80,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (apps) [\#3149](https://github.com/cosmos/ibc-go/pull/3149) Remove legacy interface function `RandomizedParams`, which is no longer used.
* (light-clients/06-solomachine) [\#2941](https://github.com/cosmos/ibc-go/pull/2941) Remove solomachine header sequence.
* (core) [\#2982](https://github.com/cosmos/ibc-go/pull/2982) Moved the ibc module name into the exported package.

### State Machine Breaking

* (06-solomachine) [\#2744](https://github.com/cosmos/ibc-go/pull/2744) `Misbehaviour.ValidateBasic()` now only enforces that signature data does not match when the signature paths are different.
Expand Down Expand Up @@ -110,27 +110,27 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (modules/core/02-client) [\#1741](https://github.com/cosmos/ibc-go/pull/1741) Emitting a new `upgrade_chain` event upon setting upgrade consensus state.
* (client) [\#724](https://github.com/cosmos/ibc-go/pull/724) `IsRevisionFormat` and `IsClientIDFormat` have been updated to disallow newlines before the dash used to separate the chainID and revision number, and the client type and client sequence.
* (02-client/cli) [\#897](https://github.com/cosmos/ibc-go/pull/897) Remove `GetClientID()` from `Misbehaviour` interface. Submit client misbehaviour cli command requires an explicit client id now.
* (06-solomachine) [\#1972](https://github.com/cosmos/ibc-go/pull/1972) Solo machine implementation of `ZeroCustomFields` fn now panics as the fn is only used for upgrades which solo machine does not support.
* (06-solomachine) [\#1972](https://github.com/cosmos/ibc-go/pull/1972) Solo machine implementation of `ZeroCustomFields` fn now panics as the fn is only used for upgrades which solo machine does not support.
* (light-clients/06-solomachine) Moving `verifyMisbehaviour` function from update.go to misbehaviour_handle.go.
* [\#2434](https://github.com/cosmos/ibc-go/pull/2478) Removed all `TypeMsg` constants
* (modules/core/exported) [\#2539] (https://github.com/cosmos/ibc-go/pull/2539) Removing `GetVersions` from `ConnectionI` interface.
* (modules/core/exported) [\#2539] (<https://github.com/cosmos/ibc-go/pull/2539>) Removing `GetVersions` from `ConnectionI` interface.
* (core/02-connection) [\#2419](https://github.com/cosmos/ibc-go/pull/2419) Add optional proof data to proto definitions of `MsgConnectionOpenTry` and `MsgConnectionOpenAck` for host state machines that are unable to introspect their own consensus state.
* (light-clients/07-tendermint) [\#3046](https://github.com/cosmos/ibc-go/pull/3046) Moved non-verification misbehaviour checks to `CheckForMisbehaviour`.
* (apps/29-fee) [\#2975](https://github.com/cosmos/ibc-go/pull/2975) Adding distribute fee events to ics29.
* (light-clients/07-tendermint) [\#2965](https://github.com/cosmos/ibc-go/pull/2965) Prune expired `07-tendermint` consensus states on duplicate header updates.
* (light-clients) [\#2736](https://github.com/cosmos/ibc-go/pull/2736) Updating `VerifyMembership` and `VerifyNonMembership` methods to use `Path` interface.
* (light-clients) [\#3113](https://github.com/cosmos/ibc-go/pull/3113) Align light client module names.
* (light-clients) [\#3113](https://github.com/cosmos/ibc-go/pull/3113) Align light client module names.

### Features

* (apps/transfer) [\#3079](https://github.com/cosmos/ibc-go/pull/3079) Added authz support for ics20.
* (core/02-client) [\#2824](https://github.com/cosmos/ibc-go/pull/2824) Add genesis migrations for v6 to v7. The migration migrates the solo machine client state definition, removes all solo machine consensus states and removes the localhost client.
* (core/24-host) [\#2856](https://github.com/cosmos/ibc-go/pull/2856) Add `PrefixedClientStorePath` and `PrefixedClientStoreKey` functions to 24-host
* (core/02-client) [\#2819](https://github.com/cosmos/ibc-go/pull/2819) Add automatic in-place store migrations to remove the localhost client and migrate existing solo machine definitions.
* (light-clients/06-solomachine) [\#2826](https://github.com/cosmos/ibc-go/pull/2826) Add `AppModuleBasic` for the 06-solomachine client and remove solo machine type registration from core IBC. Chains must register the `AppModuleBasic` of light clients.
* (light-clients/07-tendermint) [\#2825](https://github.com/cosmos/ibc-go/pull/2825) Add `AppModuleBasic` for the 07-tendermint client and remove tendermint type registration from core IBC. Chains must register the `AppModuleBasic` of light clients.
* (light-clients/06-solomachine) [\#2826](https://github.com/cosmos/ibc-go/pull/2826) Add `AppModuleBasic` for the 06-solomachine client and remove solo machine type registration from core IBC. Chains must register the `AppModuleBasic` of light clients.
* (light-clients/07-tendermint) [\#2825](https://github.com/cosmos/ibc-go/pull/2825) Add `AppModuleBasic` for the 07-tendermint client and remove tendermint type registration from core IBC. Chains must register the `AppModuleBasic` of light clients.
* (light-clients/07-tendermint) [\#2800](https://github.com/cosmos/ibc-go/pull/2800) Add optional in-place store migration function to prune all expired tendermint consensus states.
* (core/24-host) [\#2820](https://github.com/cosmos/ibc-go/pull/2820) Add `MustParseClientStatePath` which parses the clientID from a client state key path.
* (core/24-host) [\#2820](https://github.com/cosmos/ibc-go/pull/2820) Add `MustParseClientStatePath` which parses the clientID from a client state key path.
* (testing/simapp) [\#2842](https://github.com/cosmos/ibc-go/pull/2842) Adding the new upgrade handler for v6 -> v7 to simapp which prunes expired Tendermint consensus states.
* (testing) [\#2829](https://github.com/cosmos/ibc-go/pull/2829) Add `AssertEvents` which asserts events against expected event map.

Expand Down Expand Up @@ -223,7 +223,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Dependencies

* [\#2868](https://github.com/cosmos/ibc-go/pull/2868) Bump ICS 23 to v0.9.0.
* [\#2868](https://github.com/cosmos/ibc-go/pull/2868) Bump ICS 23 to v0.9.0.
* [\#2944](https://github.com/cosmos/ibc-go/pull/2944) Bump Cosmos SDK to v0.46.7 and Tendermint to v0.34.24.

### State Machine Breaking
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Please check out also our [Request For Maintainership](./MAINTAINERSHIP.md) proc

### Architecture Decision Records (ADR)

When proposing an architecture decision for the ibc-go, please create an [ADR](./docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed implementation. Please use the [ADR template](./docs/architecture/adr-template.md) to scaffold any new ADR. If you would like to see some examples of how these are written refer to ibc-go's [ADRs](./docs/architecture/). Solidified designs that will be implemented in ibc-go (and do not have a spec). They should document the architecture that will be built. Most design feedback should be gathered before the initial draft of the ADR. ADR's can/should be written for any design decisions we make which may be changed at some point in the future.
When proposing an architecture decision for the ibc-go, please create an [ADR](./docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed implementation. Please use the [ADR template](./docs/architecture/adr.template.md) to scaffold any new ADR. If you would like to see some examples of how these are written refer to ibc-go's [ADRs](./docs/architecture/). Solidified designs that will be implemented in ibc-go (and do not have a spec). They should document the architecture that will be built. Most design feedback should be gathered before the initial draft of the ADR. ADR's can/should be written for any design decisions we make which may be changed at some point in the future.

### Participating in discussions

Expand Down
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<h1>ibc-go</h1>
</div>

![banner](docs/ibc-go-image.png)
![banner](docs/static/img/ibc-go-image.png)

<div align="center">
<a href="https://github.com/cosmos/ibc-go/releases/latest">
Expand Down Expand Up @@ -41,7 +41,7 @@ This IBC implementation in Golang is built as a Cosmos SDK module. To understand

## Roadmap

For an overview of upcoming changes to ibc-go take a look at the [roadmap](./docs/roadmap/roadmap.md).
For an overview of upcoming changes to ibc-go take a look at the [roadmap](./docs/docs/01-ibc/09-roadmap.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dunno if this is necessary but seems kinda difficult to find this? I.e wouldn't know to look into docs/01-ibc for this, would expect it to be more top level like previously.


This roadmap is also available as a [project board](https://github.com/orgs/cosmos/projects/7/views/25).

Expand All @@ -65,15 +65,15 @@ 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](https://github.com/strangelove-ventures/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](https://github.com/ingenuity-build/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](https://github.com/defund-labs/defund/tree/main/x/query)|`app`|
|An application that enables cross chain NFT transfer.|[NFT Transfer (ICS 721)](https://github.com/bianjieai/nft-transfer)|`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](https://github.com/strangelove-ventures/packet-forward-middleware)|`middleware`|
|Middleware enabling the recovery of tokens sent to unsupported addresses.|[recovery](https://github.com/evmos/evmos/tree/main/x/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](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-rate-limit)|`middleware`|
| 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](https://github.com/strangelove-ventures/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](https://github.com/ingenuity-build/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](https://github.com/defund-labs/defund/tree/main/x/query) | `app` |
| An application that enables cross chain NFT transfer. | [NFT Transfer (ICS 721)](https://github.com/bianjieai/nft-transfer) | `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](https://github.com/strangelove-ventures/packet-forward-middleware) | `middleware` |
| Middleware enabling the recovery of tokens sent to unsupported addresses. | [recovery](https://github.com/evmos/evmos/tree/main/x/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](https://github.com/osmosis-labs/osmosis/tree/main/x/ibc-rate-limit) | `middleware` |

## Support

Expand Down Expand Up @@ -116,33 +116,33 @@ The following audits have been performed on the `ibc-go` source code:

1. **[Core IBC Implementation](https://github.com/cosmos/ibc-go/tree/main/modules/core)**

1.1 [ICS 02 Client](https://github.com/cosmos/ibc-go/tree/main/modules/core/02-client)
1.1 [ICS 02 Client](https://github.com/cosmos/ibc-go/tree/main/modules/core/02-client)

1.2 [ICS 03 Connection](https://github.com/cosmos/ibc-go/tree/main/modules/core/03-connection)
1.2 [ICS 03 Connection](https://github.com/cosmos/ibc-go/tree/main/modules/core/03-connection)

1.3 [ICS 04 Channel](https://github.com/cosmos/ibc-go/tree/main/modules/core/04-channel)
1.3 [ICS 04 Channel](https://github.com/cosmos/ibc-go/tree/main/modules/core/04-channel)

1.4 [ICS 05 Port](https://github.com/cosmos/ibc-go/tree/main/modules/core/05-port)
1.4 [ICS 05 Port](https://github.com/cosmos/ibc-go/tree/main/modules/core/05-port)

1.5 [ICS 23 Commitment](https://github.com/cosmos/ibc-go/tree/main/modules/core/23-commitment/types)
1.5 [ICS 23 Commitment](https://github.com/cosmos/ibc-go/tree/main/modules/core/23-commitment/types)

1.6 [ICS 24 Host](https://github.com/cosmos/ibc-go/tree/main/modules/core/24-host)
1.6 [ICS 24 Host](https://github.com/cosmos/ibc-go/tree/main/modules/core/24-host)

2. **Applications**

2.1 [ICS 20 Fungible Token Transfers](https://github.com/cosmos/ibc-go/tree/main/modules/apps/transfer)
2.1 [ICS 20 Fungible Token Transfers](https://github.com/cosmos/ibc-go/tree/main/modules/apps/transfer)

2.2 [ICS 27 Interchain Accounts](https://github.com/cosmos/ibc-go/tree/main/modules/apps/27-interchain-accounts)
2.2 [ICS 27 Interchain Accounts](https://github.com/cosmos/ibc-go/tree/main/modules/apps/27-interchain-accounts)

3. **Middleware**

3.1 [ICS 29 Fee Middleware](https://github.com/cosmos/ibc-go/tree/main/modules/apps/29-fee)
3.1 [ICS 29 Fee Middleware](https://github.com/cosmos/ibc-go/tree/main/modules/apps/29-fee)

4. **Light Clients**

4.1 [ICS 07 Tendermint](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/07-tendermint)
4.1 [ICS 07 Tendermint](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/07-tendermint)

4.2 [ICS 06 Solo Machine](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/06-solomachine)
4.2 [ICS 06 Solo Machine](https://github.com/cosmos/ibc-go/tree/main/modules/light-clients/06-solomachine)

5. **[E2E Integration Tests](https://github.com/cosmos/ibc-go/tree/main/e2e)**

Expand Down
Loading