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

fix(depinject): Authtx was not accepting custom signers #19549

Merged
merged 1 commit into from
Feb 25, 2024

Conversation

itsdevbear
Copy link
Contributor

@itsdevbear itsdevbear commented Feb 24, 2024

Description

Closes: #XXXX


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

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

  • New Features
    • Enhanced transaction signing capabilities with custom signers support for more flexible and secure transaction processing.

@itsdevbear itsdevbear requested a review from a team as a code owner February 24, 2024 23:01
Copy link
Contributor

coderabbitai bot commented Feb 24, 2024

Walkthrough

Walkthrough

This update introduces a new mechanism to customize signer retrieval in the authentication module by leveraging the protoreflect package. It adds a CustomGetSigners field to ModuleInputs, allowing for dynamic signers processing. This field is populated in the ProvideModule function, and its presence influences the enabled signing modes, especially when MetadataBankKeeper is involved. This enhancement facilitates more flexible and efficient signer management within the module.

Changes

File Change Summary
x/auth/tx/config/depinject.go - Imported protoreflect for enhanced reflection capabilities.
- Added and initialized CustomGetSigners in ModuleInputs.
- Processed CustomGetSigners for dynamic signer retrieval.
- Adjusted enabled sign modes based on MetadataBankKeeper.

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

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between aa9ff3d and 66d985c.
Files selected for processing (1)
  • x/auth/tx/config/depinject.go (3 hunks)
Additional comments: 4
x/auth/tx/config/depinject.go (4)
  • 11-11: The addition of the protoreflect import from google.golang.org/protobuf/reflect/protoreflect is necessary for handling protocol buffer message reflection, which is likely crucial for the implementation of custom signers. This change aligns with the PR's objective to enhance the SDK's flexibility in cryptographic operations.
  • 81-81: Initializing the CustomGetSigners map within the ProvideModule function is a crucial step for setting up the infrastructure to support custom signers. This initialization ensures that the map is ready to be populated with custom signer functions, facilitating the SDK's ability to handle transactions signed with custom algorithms. This change is well-implemented and follows best practices for map initialization in Go.
  • 86-90: The processing of CustomGetSigners to populate SigningOptions is effectively implemented. By iterating over the CustomGetSigners slice and assigning each custom signer function to the corresponding message type in the map, this code segment ensures that custom signing mechanisms are correctly integrated into the SDK's transaction handling process. This approach is both efficient and clear, contributing to the SDK's extensibility.
  • 91-91: The conditional logic to update enabled sign modes based on the presence of MetadataBankKeeper is a thoughtful addition. By enabling SIGN_MODE_TEXTUAL only when MetadataBankKeeper is available, this change introduces a nuanced approach to managing sign modes, potentially offering more tailored signing configurations. This adjustment is in line with the PR's objectives to enhance the SDK's flexibility and developer experience.

@@ -50,6 +51,7 @@ type ModuleInputs struct {
AccountKeeper ante.AccountKeeper `optional:"true"`
FeeGrantKeeper ante.FeegrantKeeper `optional:"true"`
CustomSignModeHandlers func() []txsigning.SignModeHandler `optional:"true"`
CustomGetSigners []txsigning.CustomGetSigner `optional:"true"`
Copy link
Contributor

Choose a reason for hiding this comment

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

The introduction of the CustomGetSigners field to ModuleInputs is a key change that enables the support for custom signers. This addition is essential for the SDK to accommodate a broader range of signing algorithms, improving its adaptability for various projects. It's important to ensure that this field is properly documented to guide developers on how to utilize this new functionality effectively.

Consider adding comprehensive documentation for the CustomGetSigners field to explain its purpose, usage, and how developers can implement custom signers using this new feature.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Good find! Can we get a changelog?

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Feb 24, 2024
@tac0turtle tac0turtle merged commit 7c05f41 into cosmos:main Feb 25, 2024
57 of 60 checks passed
mergify bot pushed a commit that referenced this pull request Feb 25, 2024
julienrbrt added a commit that referenced this pull request Feb 26, 2024
) (#19551)

Co-authored-by: Devon Bear <itsdevbear@berachain.com>
Co-authored-by: Qt <golang.chen@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Mar 27, 2024
…0.50.5

* fix: in-place-testnet edgecases (backport cosmos#19516) (cosmos#19526)

Co-authored-by: Adam Tucker <adam@osmosis.team>

* fix(simapp): typo in GetStoreKeys (cosmos#19544)

* build(deps): Bump cosmossdk.io/math from 1.2.0 to 1.3.0 (cosmos#19562)

* fix(depinject): Authtx was not accepting custom signers (backport cosmos#19549) (cosmos#19551)

Co-authored-by: Devon Bear <itsdevbear@berachain.com>
Co-authored-by: Qt <golang.chen@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): Bump github.com/cosmos/cosmos-db from 1.0.0 to 1.0.2 (cosmos#19566)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* Merge pull request from GHSA-86h5-xcpx-cfqc

* fix slashing hole with test

* release notes + changelog

* word

* date

* updates

---------

Co-authored-by: Julien Robert <julien@rbrt.fr>

* ci: run test pipeline on merge v0.50 branch (cosmos#19582)

* fix(staking): fix impossible conditions (cosmos#19621)

* docs: add section on creating a testnets from mainnet exports (backport cosmos#19475) (cosmos#19648)

Co-authored-by: Marko <marbar3778@yahoo.com>

* build(deps): Bump cosmossdk.io/x/tx from 0.13.0 to 0.13.1 (cosmos#19665)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(client/v2): marshal enum as string (cosmos#19653)

* refactor(x/auth): allow empty public keys for GetSignBytesAdapter (backport cosmos#19651) (cosmos#19675)

Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(types): check for HasABCIGenesis in CoreAppModuleBasicAdaptor (cosmos#19709)

* build(deps): Bump deps (backport cosmos#19655) (cosmos#19711)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* Merge pull request from GHSA-95rx-m9m5-m94v

* validate ExtendedCommit against LastCommit

test cases

* account for core.comet types

* logging

* linting

* cherry-pick staking fix

* nits

* linting fix

* run tests

---------

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com>

* feat(baseapp): add option to disable block gas meter (cosmos#19626)

* feat(x/distribution): add rewards-by-validator autocli config (backport cosmos#19707) (cosmos#19714)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(x/gov): grpc query tally for failed proposal (backport cosmos#19725) (cosmos#19727)

Co-authored-by: David Tumcharoen <david@alleslabs.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore: prepare v0.50.5 (cosmos#19715)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Adam Tucker <adam@osmosis.team>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Devon Bear <itsdevbear@berachain.com>
Co-authored-by: Qt <golang.chen@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: khanh <50263489+catShaark@users.noreply.github.com>
Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Nikhil Vasan <97126437+nivasan1@users.noreply.github.com>
Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com>
Co-authored-by: David Tumcharoen <david@alleslabs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants