这是indexloc提供的服务,不要输入任何密码
Skip to content

extract creating encoding config from initia app #385

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sh-cha
Copy link
Contributor

@sh-cha sh-cha commented Apr 3, 2025

No description provided.

@sh-cha sh-cha self-assigned this Apr 3, 2025
@sh-cha sh-cha requested a review from a team as a code owner April 3, 2025 07:20
Copy link

coderabbitai bot commented Apr 3, 2025

📝 Walkthrough

Walkthrough

This pull request refactors the application’s initialization process. The changes remove deprecated and unused import statements along with legacy codec registrations. A new implementation of the encoding configuration is introduced in favor of the previous temporary app instance method. Simultaneously, the basic module manager initialization is refactored by replacing the old BasicManager functions with a unified NewBasicManager approach. These updates span across encoding, genesis configuration, module management, and the root command instantiation.

Changes

File(s) Change Summary
app/app.go, app/encoding.go Removed unused imports and legacy codec registration calls; implemented a new MakeEncodingConfig function that directly registers codecs and interfaces.
app/genesis.go, app/modules.go,
cmd/initiad/root.go
Replaced old BasicManager functions (e.g., newBasicManagerFromManager and BasicManager) with a unified NewBasicManager method, updating all invocations in genesis state and command initialization.

Sequence Diagram(s)

sequenceDiagram
    participant App as NewInitiaApp
    participant Enc as MakeEncodingConfig
    participant BM as NewBasicManager
    participant Gen as NewDefaultGenesisState
    participant RC as NewRootCmd

    App ->> Enc: Initialize encoding configuration
    App ->> BM: Set up basic module manager
    Gen ->> BM: Generate default genesis state
    RC ->> BM: Configure root command components
Loading

Poem

Oh, I hop with joyful cheer,
New code paths are bright and clear.
Old imports vanish in the breeze,
With codecs and managers at ease.
A nimble leap to version new,
From rabbit paws, kudos to you!
🐰✨


🪧 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

github-actions bot commented Apr 3, 2025

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

Copy link

codecov bot commented Apr 3, 2025

Codecov Report

Attention: Patch coverage is 42.97521% with 69 lines in your changes missing coverage. Please review.

Project coverage is 40.01%. Comparing base (2913dcb) to head (649f3da).

Files with missing lines Patch % Lines
app/modules.go 43.01% 53 Missing ⚠️
app/encoding.go 36.00% 16 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #385      +/-   ##
==========================================
- Coverage   40.03%   40.01%   -0.03%     
==========================================
  Files         294      294              
  Lines       27508    27585      +77     
==========================================
+ Hits        11012    11037      +25     
- Misses      14796    14848      +52     
  Partials     1700     1700              
Files with missing lines Coverage Δ
app/app.go 57.84% <100.00%> (-0.52%) ⬇️
app/genesis.go 97.26% <100.00%> (ø)
app/encoding.go 40.47% <36.00%> (-0.44%) ⬇️
app/modules.go 69.71% <43.01%> (-30.29%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

@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 (2)
app/encoding.go (2)

34-37: Function signature improvement with specific parameter.

The AutoCliOpts function now explicitly accepts the encoding configuration as a parameter rather than creating it internally, which improves modularity. However, the map initializations could be optimized.

-	appModules := make(map[string]appmodule.AppModule, 0)
-	moduleOptions := make(map[string]interface{}, 0)
+	appModules := make(map[string]appmodule.AppModule)
+	moduleOptions := make(map[string]interface{})

40-55: Module processing logic is correct but could be more concise.

The loop correctly processes modules and identifies those with AutoCLI capabilities, storing them appropriately based on their supported interfaces.

The nested interface check could be extracted to a type definition to improve code readability:

+type moduleWithAutoCliOptions interface {
+	AutoCLIOptions() *autocliv1.ModuleOptions
+}

 for _, m := range modules {
 	if moduleWithName, ok := m.(module.HasName); ok {
 		moduleName := moduleWithName.Name()
-		if _, ok := m.(interface {
-			AutoCLIOptions() *autocliv1.ModuleOptions
-		}); ok {
+		if _, ok := m.(moduleWithAutoCliOptions); ok {
 			moduleOptions[moduleName] = m
 		} else {
 			continue
 		}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c321811 and 649f3da.

📒 Files selected for processing (3)
  • app/encoding.go (1 hunks)
  • app/modules.go (5 hunks)
  • cmd/initiad/root.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • cmd/initiad/root.go
  • app/modules.go
🔇 Additional comments (5)
app/encoding.go (5)

9-9: Appropriate imports added for the refactored implementation.

The added imports for std, autocliv1, and cryptocodec properly support the new direct codec registration approach.

Also applies to: 14-14, 17-17


21-27: Clean implementation of encoding configuration creation.

The encoding configuration now directly leverages params.MakeEncodingConfig() and properly registers legacy Amino codecs and interfaces for both standard Cosmos SDK types and custom crypto types. This approach eliminates the previous need for a temporary application instance.


28-30: Appropriate use of the new BasicManager.

The code correctly uses the new NewBasicManager() function to register interfaces and legacy Amino codecs with the encoding configuration, which aligns with the broader refactoring of module management.


38-39: Correct use of modulesForAutoCli function.

The code properly retrieves modules with all necessary components for AutoCLI functionality.


58-59: Properly updated AppOptions return value.

The function now correctly returns AppOptions with appModules instead of the previously used modules and properly extracts module options from the new map.

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