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

feat(gov): disable the governance through set null router #307

Merged
merged 1 commit into from
Feb 23, 2025

Conversation

TimmyExogenous
Copy link
Contributor

@TimmyExogenous TimmyExogenous commented Feb 17, 2025

Description

Max has already added the authority check for all modules when updating parameters. So, this PR only disables governance by setting the routers to null, including both MsgServiceRouter and legacyRouter.

During the early phase of mainnet, the parameters can be updated through a node upgrade without enabling the governance module. An example of updating the gateways is provided in this documentation:
updating gateways by node upgrade

Additionally, I am unsure whether we should provide a precompile interface to update the list of assets supported by Dogfood. This interface should be controlled by the owner of the gateway contract, similar to the registerToken. It would allow us to add supported assets for the Dogfood AVS without upgrading the node. I can add it in this PR if we think it's necessary.

Summary by CodeRabbit

  • Refactor
    • Temporarily disabled governance functionality during the early mainnet phase.
    • Updated message routing within the governance module to align with the transitional state.

These changes are designed to facilitate the platform's adaptation to the evolving mainnet environment.

Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

The changes modify the app/app.go file. Two IBC client imports were removed, and the governance routing logic has been adjusted by commenting out the line that adds the proposal handler. Additionally, the initialization of the message service router was updated from using app.MsgServiceRouter() to baseapp.NewMsgServiceRouter(). These adjustments indicate that governance functionality is temporarily disabled for the early mainnet phase and may be re-enabled later.

Changes

File Summary
app/app.go Removed IBC client imports; commented out governance proposal handler addition; updated MsgServiceRouter initialization to use baseapp.NewMsgServiceRouter()

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant A as Application
    participant R as MsgServiceRouter
    C->>A: Submit governance proposal
    A--)A: Skip governance handler (commented out)
    A->>R: Route message via baseapp.NewMsgServiceRouter()
    Note right of R: Governance proposal handling currently inactive
Loading

Poem

Hoppin' through the lines of code so neat,
I nibble changes that are quite a treat.
Governance sleeps in a temporary den,
Imports removed again and again.
With a joyful hop, my code's complete!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@bwhour bwhour left a comment

Choose a reason for hiding this comment

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

looks good.

@cloud8little cloud8little added this to the Testnet V8 milestone Feb 23, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
app/app.go (1)

639-645: Good approach for temporarily disabling governance.

Commenting out these routes effectively disables governance, but consider taking one of the following steps:

  1. Remove the commented code block entirely if you want a cleaner final implementation.
  2. Provide a toggle-based or feature-flag approach so you can easily re-enable governance later.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 286edd4 and 516affe.

📒 Files selected for processing (1)
  • app/app.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: test-unit-e2e
  • GitHub Check: test-unit-cover
  • GitHub Check: goreleaser
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
app/app.go (1)

651-651:

❓ Verification inconclusive

Verify the impact of using a fresh router instance.

Switching from app.MsgServiceRouter() to baseapp.NewMsgServiceRouter() bypasses your app-level message router. Ensure that no other modules or messages rely on the old router. Also verify that you don’t accidentally disable message handling in modules where it’s still required.


🏁 Script executed:

#!/bin/bash
# Description: Search for references to "app.MsgServiceRouter" to confirm nothing still depends on it.
rg "app\.MsgServiceRouter" -A 5

Length of output: 674


Action Required: Verify Custom Router Dependencies

The switch to using baseapp.NewMsgServiceRouter() in place of app.MsgServiceRouter() has left some references to the old router in the codebase. Our search in app/app.go confirms that app.MsgServiceRouter() is still referenced in a couple of places. Please ensure that:

  • Modules expecting custom routing behavior: Confirm that modules or messages relying on the custom logic in app.MsgServiceRouter() (e.g., in its usage alongside app.AccountKeeper and registration calls) continue to work correctly with the fresh router instance.
  • Message handling consistency: Validate that the new router does not inadvertently disable required message handling, especially in parts of the app that still invoke app.MsgServiceRouter().

If any dependencies on the old router are found, update them accordingly or perform thorough testing to verify that the new configuration meets all required message routing behaviors.

@TimmyExogenous TimmyExogenous added this pull request to the merge queue Feb 23, 2025
Merged via the queue into imua-xyz:develop with commit a4d1dae Feb 23, 2025
23 checks passed
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.

5 participants