Skip to content

Pfm updates#327

Open
evanorti wants to merge 2 commits into
mainfrom
pfm-updates
Open

Pfm updates#327
evanorti wants to merge 2 commits into
mainfrom
pfm-updates

Conversation

@evanorti

Copy link
Copy Markdown
Contributor

Update PFM docs in IBC docs

@evanorti evanorti requested a review from srdtrk July 10, 2026 18:30
@mintlify

mintlify Bot commented Jul 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cosmos-docs 🟢 Ready View Preview Jul 10, 2026, 6:34 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@greptile-apps

greptile-apps Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates the Packet Forward Middleware (PFM) documentation across both latest/ and next/ versions, and registers the PFM pages in the site navigation via docs.json.

  • Import paths bumped from v10 to v11 in both latest/ and next/ integration.mdx files, the deprecated ModuleBasics/AppModuleBasic{} registration block removed, and sdk.NewKVStoreKeys replaced with storetypes.NewKVStoreKeys.
  • Error-ACK flow corrected in example-usage.mdx: the duplicate "Forward (errors)" sequence diagram arrow was removed, the numbered steps (10–14 → 10–13) were rewritten for accuracy (the old step 13 incorrectly described a timeout path, and step 14 incorrectly described a success ACK in an error scenario).
  • docs.json navigation updated for both latest/ and next/ to include the PFM group (overview, integration, example-usage); all three referenced .mdx files exist on disk.

Confidence Score: 5/5

Safe to merge — all changes are documentation corrections with no behavioral impact.

Every referenced page (overview, integration, example-usage) already exists on disk for both latest/ and next/. The v10→v11 import bump, removal of the deprecated AppModuleBasic block, and storetypes fix are accurate reflections of ibc-go v11. The error-ACK numbered steps were genuinely wrong before; the replacements are correct. No style guide violations were introduced.

No files require special attention.

Important Files Changed

Filename Overview
docs.json Adds PFM navigation group to both latest/ and next/ sections; all three referenced page files exist on disk.
ibc/latest/middleware/packet-forward-middleware/integration.mdx Import paths updated from v10 to v11, deprecated AppModuleBasic registration removed, and store key init updated to storetypes.NewKVStoreKeys.
ibc/latest/middleware/packet-forward-middleware/example-usage.mdx Error-ACK sequence diagram corrected (duplicate arrow removed), numbered steps rewritten for accuracy, and next memo description clarified.
ibc/next/middleware/packet-forward-middleware/integration.mdx Mirrors the latest/ integration changes; v11 import paths, storetypes.NewKVStoreKeys, and removal of deprecated AppModuleBasic block.
ibc/next/middleware/packet-forward-middleware/example-usage.mdx Mirrors the latest/ example-usage changes; error-ACK flow and next memo description both corrected.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant A as Chain A
    participant B as Chain B (PFM)
    participant C as Chain C

    Note over A,C: Happy Path
    A->>B: MsgTransfer (memo: forward to C)
    B->>B: recv_packet, mint/unescrow tokens
    B->>C: Forward packet
    C->>B: ACK success
    B->>A: ACK success

    Note over A,C: Error Path (C returns error ACK)
    A->>B: MsgTransfer (memo: forward to C)
    B->>B: recv_packet, store in-flight packet
    B->>C: Forward packet
    C->>B: ACK error
    B->>B: delete in-flight packet, reverse tokens
    B->>A: ACK error (refund)

    Note over A,C: Timeout / Retry Path
    A->>B: MsgTransfer (memo: forward to C)
    B->>C: Forward packet
    C--xB: Timeout
    B->>C: Retry forward
    C--xB: Timeout (retries exhausted)
    B->>A: ACK error (refund)
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
    participant A as Chain A
    participant B as Chain B (PFM)
    participant C as Chain C

    Note over A,C: Happy Path
    A->>B: MsgTransfer (memo: forward to C)
    B->>B: recv_packet, mint/unescrow tokens
    B->>C: Forward packet
    C->>B: ACK success
    B->>A: ACK success

    Note over A,C: Error Path (C returns error ACK)
    A->>B: MsgTransfer (memo: forward to C)
    B->>B: recv_packet, store in-flight packet
    B->>C: Forward packet
    C->>B: ACK error
    B->>B: delete in-flight packet, reverse tokens
    B->>A: ACK error (refund)

    Note over A,C: Timeout / Retry Path
    A->>B: MsgTransfer (memo: forward to C)
    B->>C: Forward packet
    C--xB: Timeout
    B->>C: Retry forward
    C--xB: Timeout (retries exhausted)
    B->>A: ACK error (refund)
Loading

Reviews (1): Last reviewed commit: "Update docs.json" | Re-trigger Greptile

@linear-code

linear-code Bot commented Jul 15, 2026

Copy link
Copy Markdown

FOU-636

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.

2 participants