refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651

mmsqe · 2024-03-05T15:49:54Z

Description

to avoid error like in #19094

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 the authentication mechanism to support transactions without public keys, improving flexibility and use cases.

coderabbitai · 2024-03-05T15:49:59Z

Walkthrough

The recent update introduces a significant enhancement in handling signing data without a public key within the x/auth module. Specifically, it modifies the GetSignBytesAdapter function to conditionally handle PubKey instances, ensuring the correct setting of PubKey in transaction signer data. Additionally, a new test case has been added to validate this functionality, ensuring robustness and reliability in scenarios where a public key might not be present.

Changes

Files	Change Summary
`x/auth/.../adapter.go`	Updated `GetSignBytesAdapter` to conditionally handle `PubKey`, ensuring correct assignment in `txSignerData`.
`x/auth/.../adapter_test.go`	Added `TestGetSignBytesAdapterNoPublicKey` to validate signing data processing without a public key.

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

CHANGELOG.md

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between e8c9cd2 and 93bae50.

Files selected for processing (3)

CHANGELOG.md (1 hunks)
x/auth/signing/adapter.go (1 hunks)
x/auth/signing/adapter_test.go (1 hunks)

Additional comments: 2

x/auth/signing/adapter.go (1)

44-61: The changes to GetSignBytesAdapter correctly implement the conditional handling of PubKey, ensuring that it accommodates scenarios with empty public keys. The error handling and conditional logic are well-implemented, aligning with the PR's objectives.

CHANGELOG.md (1)

83-83: The changelog entry is correctly formatted and provides a clear summary of the changes introduced by PR refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651, including the feature addition of allowing empty public keys in GetSignBytesAdapter. This entry follows the established pattern and correctly links to the PR for more details.

coderabbitai · 2024-03-05T16:06:47Z

x/auth/signing/adapter_test.go

+func TestGetSignBytesAdapterNoPublicKey(t *testing.T) {
+	encodingConfig := moduletestutil.MakeTestEncodingConfig()
+	txConfig := encodingConfig.TxConfig
+	_, _, addr := testdata.KeyTestPubAddr()
+	signerData := authsign.SignerData{
+		Address:       addr.String(),
+		ChainID:       "test-chain",
+		AccountNumber: 11,
+		Sequence:      15,
+	}
+	w := txConfig.NewTxBuilder()
+	_, err := authsign.GetSignBytesAdapter(
+		context.Background(),
+		txConfig.SignModeHandler(),
+		signing.SignMode_SIGN_MODE_DIRECT,
+		signerData,
+		w.GetTx())
+	require.NoError(t, err)


The test TestGetSignBytesAdapterNoPublicKey effectively checks for errors in the scenario with no public key. However, it could be enhanced by adding more detailed assertions to verify the behavior of GetSignBytesAdapter more thoroughly, such as ensuring the output is as expected when PubKey is nil.

…9651) (cherry picked from commit 06a3989) # Conflicts: # CHANGELOG.md

…ckport #19651) (#19675) Co-authored-by: mmsqe <[email protected]> Co-authored-by: Julien Robert <[email protected]>

…0.50.5 * fix: in-place-testnet edgecases (backport cosmos#19516) (cosmos#19526) Co-authored-by: Adam Tucker <[email protected]> * 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 <[email protected]> Co-authored-by: Qt <[email protected]> Co-authored-by: Julien Robert <[email protected]> * build(deps): Bump github.com/cosmos/cosmos-db from 1.0.0 to 1.0.2 (cosmos#19566) Signed-off-by: dependabot[bot] <[email protected]> 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 <[email protected]> * Merge pull request from GHSA-86h5-xcpx-cfqc * fix slashing hole with test * release notes + changelog * word * date * updates --------- Co-authored-by: Julien Robert <[email protected]> * 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 <[email protected]> * build(deps): Bump cosmossdk.io/x/tx from 0.13.0 to 0.13.1 (cosmos#19665) Signed-off-by: dependabot[bot] <[email protected]> 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 <[email protected]> Co-authored-by: Julien Robert <[email protected]> * fix(types): check for HasABCIGenesis in CoreAppModuleBasicAdaptor (cosmos#19709) * build(deps): Bump deps (backport cosmos#19655) (cosmos#19711) Co-authored-by: Julien Robert <[email protected]> * 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 <[email protected]> Co-authored-by: Marko Baricevic <[email protected]> * 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 <[email protected]> * fix(x/gov): grpc query tally for failed proposal (backport cosmos#19725) (cosmos#19727) Co-authored-by: David Tumcharoen <[email protected]> Co-authored-by: Julien Robert <[email protected]> * chore: prepare v0.50.5 (cosmos#19715) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Adam Tucker <[email protected]> Co-authored-by: yihuang <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Devon Bear <[email protected]> Co-authored-by: Qt <[email protected]> Co-authored-by: Julien Robert <[email protected]> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: khanh <[email protected]> Co-authored-by: Tom <[email protected]> Co-authored-by: Marko <[email protected]> Co-authored-by: mmsqe <[email protected]> Co-authored-by: Nikhil Vasan <[email protected]> Co-authored-by: Marko Baricevic <[email protected]> Co-authored-by: David Tumcharoen <[email protected]>

fix: allow empty public keys for auth

cf7d5b0

github-actions bot added the C:x/auth label Mar 5, 2024

mmsqe commented Mar 5, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

mmsqe and others added 2 commits March 5, 2024 23:50

Update CHANGELOG.md

8a82955

fix lint

93bae50

mmsqe marked this pull request as ready for review March 5, 2024 16:01

mmsqe requested a review from a team as a code owner March 5, 2024 16:01

coderabbitai bot reviewed Mar 5, 2024

View reviewed changes

sontrinh16 approved these changes Mar 5, 2024

View reviewed changes

julienrbrt approved these changes Mar 6, 2024

View reviewed changes

julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Mar 6, 2024

julienrbrt changed the title ~~fix: allow empty public keys for GetSignBytesAdapter~~ refactor(x/auth): allow empty public keys for GetSignBytesAdapter Mar 6, 2024

julienrbrt added this pull request to the merge queue Mar 6, 2024

Merged via the queue into cosmos:main with commit 06a3989 Mar 6, 2024
62 of 63 checks passed

mergify bot pushed a commit that referenced this pull request Mar 6, 2024

refactor(x/auth): allow empty public keys for GetSignBytesAdapter (#1…

83bbf80

…9651) (cherry picked from commit 06a3989) # Conflicts: # CHANGELOG.md

mergify bot mentioned this pull request Mar 6, 2024

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

Merged

julienrbrt added a commit that referenced this pull request Mar 7, 2024

refactor(x/auth): allow empty public keys for GetSignBytesAdapter (ba…

f9041cd

…ckport #19651) (#19675) Co-authored-by: mmsqe <[email protected]> Co-authored-by: Julien Robert <[email protected]>

faddat mentioned this pull request Nov 8, 2024

faddat/many times #22476

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651

refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651

mmsqe commented Mar 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 5, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot Mar 5, 2024

refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651

refactor(x/auth): allow empty public keys for GetSignBytesAdapter #19651

Conversation

mmsqe commented Mar 5, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Mar 5, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Mar 5, 2024

Choose a reason for hiding this comment

mmsqe commented Mar 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)