fix(codec): provide legacy amino og type

[julienrbrt]

Description

Found when integrating ignite with 0.52/ibc (ignite/cli#4477)
x/params input aren't satisfied by runtime as it required an actual codec.LegacyAmino. x/params cannot use the amino registrar directly (and i don't think we should take time to refactor it so it can, as this module is deprecated)

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Refactor
  • Updated the ProvideLegacyAmino function to return an additional LegacyAmino pointer alongside the existing AminoRegistrar

This change modifies the function's return type, providing more comprehensive output while maintaining the original functionality of the method.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the ProvideLegacyAmino function in the codec/depinject.go file by changing its return type. Previously, the function returned a single registry.AminoRegistrar, but now it returns a tuple containing registry.AminoRegistrar and a pointer to LegacyAmino. This change involves creating a local amino variable using NewLegacyAmino() and returning both the registrar and the amino instance. The core logic and structure of the function remain unchanged.

Changes

File	Change Summary
codec/depinject.go	Updated ProvideLegacyAmino() function signature to return (registry.AminoRegistrar, *LegacyAmino) instead of just registry.AminoRegistrar

Possibly related PRs

• chore(x/upgrade): Use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23261: Modifies ModuleInputs struct to include a Cdc field of type codec.Codec
• chore(x/auth): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23273: Updates builder struct to include a codec field
• chore(x/auth): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec #23403: Changes DefaultGenesis method's JSON marshaling approach

Suggested reviewers

• tac0turtle
• lucaslopezf
• aljo242

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2675857 and 011786d.

📒 Files selected for processing (1)

• codec/depinject.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

codec/depinject.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🪛 GitHub Actions: v2 core Tests

codec/depinject.go

[warning] Error registering services: unable to make a appmodulev2.HandlerFunc from gRPC handler (cosmos.reflection.v1.ReflectionService, FileDescriptors): no proto message found for cosmos.reflection.v1.FileDescriptorsRequest

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: tests (00)
• GitHub Check: Analyze
• GitHub Check: Summary

🔇 Additional comments (1)

codec/depinject.go (1)

54-56: LGTM! The implementation aligns with the PR objectives.

The change correctly provides both the AminoRegistrar interface and the concrete LegacyAmino type, which is needed for the x/params module. The implementation is efficient as it reuses the same instance for both return values.

Note: Since this is a public API change, please ensure to:

1. Update any relevant documentation
2. Consider adding migration guides if needed

Let's verify the impact of this API change:

✅ Verification successful

API change is safe to proceed ✅

The change to ProvideLegacyAmino is used in a dependency injection context in runtime/module.go, where the framework naturally handles multiple return values. The modification maintains backward compatibility while extending functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for existing usages of ProvideLegacyAmino to identify potential breaking changes
rg -l "ProvideLegacyAmino" --type go

Length of output: 73

---

Script:

#!/bin/bash
# Check the usage context of ProvideLegacyAmino in runtime/module.go
rg "ProvideLegacyAmino" runtime/module.go -B 2 -A 2

Length of output: 221

🧰 Tools

🪛 GitHub Actions: v2 core Tests

[warning] Error registering services: unable to make a appmodulev2.HandlerFunc from gRPC handler (cosmos.reflection.v1.ReflectionService, FileDescriptors): no proto message found for cosmos.reflection.v1.FileDescriptorsRequest

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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.

[github-actions]

@julienrbrt your pull request is missing a changelog!

[julienrbrt]

@julienrbrt your pull request is missing a changelog!

i can add in the backport

[technicallyty]

couldn't we just return the concrete impl here? or does it cause problems?

[julienrbrt]

couldn't we just return the concrete impl here? or does it cause problems?

I think we want to expose both

[tac0turtle]

are you sure you cant type cast for ignite?

[julienrbrt]

are you sure you cant type cast for ignite?

We could type cast in the x/params module input yeah. Would you rather have that? Changes would be only in release/v0.52.x then.

That's more an issue in to solve in the SDK (try to wire x/params in 0.52, without adding extra providers) than in Ignite.

Imho, this is better, as modules that were having the legacy amino codec as input (so not only sdk modules) will still resolve after this -- which is a bit the advantage of depinject/app wiring, we do not break what's being provided, so we don't break the app.go of people.

[aljo242]

I think this logic makes sense to keep as long as we are still exporting the LegacyAmino type