Skip to content

docs: v11.1 migration docs#8958

Open
srdtrk wants to merge 4 commits into
mainfrom
serdar/xxx-migration-v11.1
Open

docs: v11.1 migration docs#8958
srdtrk wants to merge 4 commits into
mainfrom
serdar/xxx-migration-v11.1

Conversation

@srdtrk

@srdtrk srdtrk commented May 20, 2026

Copy link
Copy Markdown
Member

Description

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Include changelog entry when appropriate (e.g. chores should be omitted from changelog).
  • Wrote unit and integration tests if relevant.
  • Updated documentation (docs/) if anything is changed.
  • Added godoc comments if relevant.
  • Self-reviewed Files changed in the GitHub PR explorer.
  • Provide a conventional commit message to follow the repository standards.

@srdtrk
srdtrk requested a review from a team as a code owner May 20, 2026 19:18

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 01a751c734

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


### If your chain already uses PFM from ibc-apps

Replace all ibc-apps PFM imports with the new ibc-go imports and review the [integration instructions](../04-middleware/02-packet-forward-middleware/02-integration.md).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Point migration steps to v11.1-compatible PFM integration docs

This step sends users to ../04-middleware/02-packet-forward-middleware/02-integration.md, but that page still documents the old ibc-apps module (github.com/cosmos/ibc-apps/.../packetforward at lines 27-29) and legacy keeper wiring (e.g. GetSubspace-based constructor flow at lines 63-79). For a v11.1 upgrade, following this link as written produces non-compiling integration code and can block upgrades; the migration guide should either include the new ibc-go wiring directly or link to updated v11.1 instructions.

Useful? React with 👍 / 👎.

@codecov

codecov Bot commented May 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.93%. Comparing base (241b3ed) to head (fc1babd).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8958   +/-   ##
=======================================
  Coverage   66.93%   66.93%           
=======================================
  Files         329      329           
  Lines       17358    17358           
=======================================
  Hits        11618    11618           
  Misses       5014     5014           
  Partials      726      726           
Flag Coverage Δ
08-wasm 65.04% <ø> (ø)
ibc-go 66.99% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@greptile-apps

greptile-apps Bot commented May 20, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds two new migration guides for the ibc-go v11.1 release: one for chains already on v11.0 upgrading to v11.1, and one for chains upgrading directly from v10 to v11.1. Both guides focus on the Packet Forward Middleware (PFM) being moved from cosmos/ibc-apps into ibc-go proper.

  • 16-v11-to-v11_1.md covers PFM store upgrade steps for first-time PFM adopters on v11.0, with a note about the intentional packetfowardmiddleware spelling preserved for backwards compatibility.
  • 17-v10-to-v11_1.md is a combined guide for chains skipping directly from v10 to v11.1, reproducing the v10→v11 constructor changes (removing ParamSubspace, adding AddressCodec()) alongside the new PFM and ICS27-GMP store upgrade instructions.

Confidence Score: 4/5

Documentation-only change; no runtime code is modified, so there is no risk of breakage from merging.

The cross-reference in the v11-to-v11.1 guide sends v11.0 chains with existing PFM into a guide whose opening section lists constructor changes they have already applied, without any skip qualifier. The confusing GMP guard note in the v10-to-v11.1 guide applies to no reader of that guide. Both are clarity issues with no runtime consequence, but they could cause chain operators to make incorrect upgrade decisions.

Both new migration files benefit from a second read, particularly the cross-reference on line 18 of 16-v11-to-v11_1.md and the trailing GMP caveat on line 122 of 17-v10-to-v11_1.md.

Important Files Changed

Filename Overview
docs/docs/05-migrations/16-v11-to-v11_1.md New migration guide for v11.0 to v11.1; covers PFM integration for first-time adopters but the cross-reference for existing PFM users could mislead v11.0 chains into re-applying already-done constructor changes.
docs/docs/05-migrations/17-v10-to-v11_1.md New combined migration guide for chains skipping directly from v10 to v11.1; largely accurate but contains a confusing GMP guard note that cannot apply to its target audience.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Chain operator planning upgrade] --> B{Current ibc-go version?}
    B -->|v10| C[Use guide: 17-v10-to-v11_1.md]
    B -->|v11.0| D[Use guide: 16-v11-to-v11_1.md]
    C --> E{Already using PFM from ibc-apps?}
    E -->|Yes| F[Replace imports + review integration docs]
    E -->|No| G[Add PFM + GMP store keys in StoreUpgrades]
    D --> H{Already using PFM from ibc-apps?}
    H -->|Yes| I[Follow only the PFM section of 17-v10-to-v11_1.md]
    H -->|No| J[Add packetforwardtypes.StoreKey in StoreUpgrades]
    F --> K[Run in-place PFM v3 to v4 migration]
    G --> L[Upgrade complete]
    I --> K
    J --> L
    K --> L
Loading

Reviews (1): Last reviewed commit: "docs: improved" | Re-trigger Greptile

Comment thread docs/docs/05-migrations/16-v11-to-v11_1.md
Comment thread docs/docs/05-migrations/17-v10-to-v11_1.md Outdated
@srdtrk
srdtrk requested a review from a team as a code owner July 16, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant