Skip to content

Conversation

SDavidson1177
Copy link
Contributor

No description provided.

@SDavidson1177 SDavidson1177 changed the title chore(releases): coordinator v1.2.0 migration docs and router v1.3.0 migration docs chore(releases): coordinator v2.0.0, multisig v2.2.0 and router v1.3.0 migration docs Aug 5, 2025
@SDavidson1177 SDavidson1177 marked this pull request as ready for review August 5, 2025 18:01
@SDavidson1177 SDavidson1177 requested a review from a team as a code owner August 5, 2025 18:01
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR adds release documentation for three CosmWasm contracts that are part of a coordinated upgrade: Coordinator v1.2.0, Multisig v2.2.0, and Router v1.3.0. These releases implement an architectural improvement to the Axelar amplifier system by establishing proper integration between the coordinator, router, and multisig contracts.

The Router v1.3.0 upgrade adds the ability to store the coordinator's address in the router contract state, enabling the coordinator to execute messages through the router (particularly for chain registration operations). The Multisig v2.2.0 upgrade similarly stores the coordinator's address, allowing the multisig to grant the coordinator permission to execute messages such as authorizing callers. The Coordinator v1.2.0 upgrade introduces enhanced state management by storing both router and multisig contract addresses and expands chain registration to include gateway and voting verifier addresses alongside multisig prover addresses.

These changes represent a shift toward more centralized coordination of cross-chain operations while maintaining proper access controls. The coordinator now uses a RegisterProtocol message pattern instead of storing the service registry address in the instantiate message, providing a more flexible and modular approach to protocol registration. All three contracts require state migrations to accommodate these new address storage requirements.

Important Files Changed

Files Changed
Filename Score Overview
releases/cosmwasm/2025-07-Router-v1.3.0.md 4/5 Well-structured release documentation for Router v1.3.0 with proper deployment commands and verification steps
releases/cosmwasm/2025-07-Multisig-v2.2.0.md 2/5 Multisig v2.2.0 release documentation with critical title mismatch error and incomplete deployment table
releases/cosmwasm/2025-07-Coordinator-v1.2.0.md 1/5 Coordinator v1.2.0 release documentation with multiple critical issues including wrong title, incomplete table, and malformed JSON

Confidence score: 2/5

  • This PR contains significant documentation errors that would prevent successful deployments and cause confusion
  • Score reflects critical issues including incorrect titles, malformed JSON syntax, and incomplete deployment tables that must be fixed before merge
  • Pay close attention to releases/cosmwasm/2025-07-Coordinator-v1.2.0.md and releases/cosmwasm/2025-07-Multisig-v2.2.0.md which contain blocking errors

Sequence Diagram

sequenceDiagram
    participant User
    participant Governance as "Governance System"
    participant Coordinator as "Coordinator Contract"
    participant Router as "Router Contract"
    participant Multisig as "Multisig Contract"
    participant Chain as "Axelar Chain"

    Note over User, Chain: Coordinator v1.2.0 Migration
    User->>Governance: "Submit proposal to upload Coordinator v1.2.0"
    Governance->>Chain: "Store new Coordinator bytecode"
    
    User->>Chain: "Query coordinator state for chain/prover mappings"
    Chain-->>User: "Return chain prover mappings"
    
    User->>Router: "Query chain info for gateway addresses"
    Router-->>User: "Return gateway addresses"
    
    User->>Multisig: "Query multisig config for voting verifier addresses"
    Multisig-->>User: "Return voting verifier addresses"
    
    User->>Governance: "Submit migration proposal with router, multisig, and chain contracts"
    Governance->>Coordinator: "Migrate to v1.2.0 with new state structure"
    Coordinator->>Coordinator: "Store router and multisig addresses"
    Coordinator->>Coordinator: "Update chain contracts with prover, gateway, and verifier addresses"
    
    Note over User, Chain: Router v1.3.0 Migration
    User->>Governance: "Submit proposal to upload Router v1.3.0"
    Governance->>Chain: "Store new Router bytecode"
    
    User->>Governance: "Submit migration proposal with coordinator address"
    Governance->>Router: "Migrate to v1.3.0"
    Router->>Router: "Store coordinator address in config"
    
    Note over User, Chain: Multisig v2.2.0 Migration
    User->>Governance: "Submit proposal to upload Multisig v2.2.0"
    Governance->>Chain: "Store new Multisig bytecode"
    
    User->>Governance: "Submit migration proposal with coordinator address"
    Governance->>Multisig: "Migrate to v2.2.0"
    Multisig->>Multisig: "Store coordinator address in config"
    
    Note over User, Chain: Verification
    User->>Coordinator: "Query contract version"
    Coordinator-->>User: "Return version 1.2.0"
    
    User->>Coordinator: "Query chain contracts info"
    Coordinator-->>User: "Return prover, gateway, and verifier addresses"
    
    User->>Router: "Query contract version"
    Router-->>User: "Return version 1.3.0"
    
    User->>Router: "Query coordinator address in config"
    Router-->>User: "Return coordinator address"
    
    User->>Multisig: "Query contract version"
    Multisig-->>User: "Return version 2.2.0"
    
    User->>Multisig: "Query coordinator address in config"
    Multisig-->>User: "Return coordinator address"
Loading

3 files reviewed, 4 comments

Edit Code Review Bot Settings | Greptile

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@SDavidson1177 SDavidson1177 changed the title chore(releases): coordinator v2.0.0, multisig v2.2.0 and router v1.3.0 migration docs chore(releases): coordinator v2.1.0, multisig v2.2.0 and router v1.3.0 migration docs Aug 29, 2025
Copy link
Contributor

@nbayindirli nbayindirli left a comment

Choose a reason for hiding this comment

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

naming convention is confusing- branch says feat, PR title says chore, but pr is for release docs

dw about branch name this time around, but please update title to
docs(releases): coordinator v2.1.0 migration

Copy link
Contributor

Choose a reason for hiding this comment

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

put this file in its own PR, and rebase feat/coordinator-migration-july-2025 on top of that branch

something like main < feat/contract-info < feat/coordinator-migration-july-2025

(you could also open a new pr entirely for this on a docs/coordinator-v2 branch)

@SDavidson1177
Copy link
Contributor Author

SDavidson1177 commented Sep 8, 2025

The PR will be closed in favour of #1001 (contract info) and #1002 (release doc). Please address all comments there.

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.

6 participants