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

refactor(auth): incorporate set pub key decorator into sig verification decorator #19093

Merged
merged 12 commits into from Jan 22, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Jan 17, 2024

Description

SetPubKeyDecorator was merged into SigVerification, gas consumption is almost halved for a simple tx.


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

@@ -166,25 +166,6 @@ func TestAnteHandlerSigErrors(t *testing.T) {
false,
sdkerrors.ErrUnknownAddress,
},
{
"save the first account, but second is still unrecognized",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this test is not valid anymore after the change in behaviours, since the pubkey checking step is done separately during sig verification

@@ -1121,62 +1102,6 @@ func TestAnteHandlerSetPubKey(t *testing.T) {
false,
sdkerrors.ErrWrongSequence,
},
{
"make sure previous public key has been set after wrong signature",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this test is not valid anymore because each account has it's own set pub key step

require.Equal(t, []byte("ok"), okValue)
}
// check block gas is always consumed
baseGas := uint64(54436) // baseGas is the gas consumed before tx msg
baseGas := uint64(38798) // baseGas is the gas consumed before tx msg
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we have almost halved the execution costs since we're not redundantly getting and decoding from state, also the account is saved in state only once instead of twice

@testinginprod testinginprod marked this pull request as ready for review January 18, 2024 16:50
@testinginprod testinginprod requested a review from a team as a code owner January 18, 2024 16:50
Copy link
Contributor

coderabbitai bot commented Jan 18, 2024

Walkthrough

The recent updates involve a significant overhaul of the transaction processing, particularly in how public keys are managed and how gas consumption is calculated. The SetPubKeyDecorator has been eliminated, merging its functionality with the SigVerificationDecorator. This consolidation has led to a reduction in gas usage for transactions. Error messages have been made more descriptive, and certain test cases that are no longer relevant due to these changes have been removed. The changes suggest a streamlined approach to transaction validation and signature verification in the codebase.

Changes

File Path Change Summary
baseapp/block_gas_test.go Adjusted baseGas value and added detailed error messages in assertions.
simapp/ante.go
x/auth/ante/ante.go
Removed NewSetPubKeyDecorator call; updated comments about decorator order.
tests/integration/bank/.../app_test.go Updated error message strings and accSeqs slice; removed certain error references.
x/auth/CHANGELOG.md Documented the merge of decorators and the reduction in gas consumption.
x/auth/ante/ante_test.go Removed tests related to public key setting and signature verification.
x/auth/ante/sigverify.go
x/auth/ante/sigverify_internal_test.go
Removed SetPubKeyDecorator, updated SigVerificationDecorator, and added new internal tests.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

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

@testinginprod testinginprod mentioned this pull request Jan 18, 2024
44 tasks
Comment on lines +163 to +166
// NOTE: the tx_wrapper implementation returns nil, in case the pubkey is not populated.
// so we can always expect the pubkey of the signer to be at the same index as the signer
// itself. If this does not work, it's a failure in the implementation of the interface.
// we're erroring, but most likely we should be panicking.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why would we panic? Especially in an ante-handler?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a breach of the sdk.Tx interface implementation

Copy link
Contributor

Choose a reason for hiding this comment

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

a panic would be caught and treated as an error anyway, so a panic would be futile.

x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
@tac0turtle tac0turtle added this pull request to the merge queue Jan 22, 2024
Merged via the queue into main with commit 582bba3 Jan 22, 2024
56 of 59 checks passed
@tac0turtle tac0turtle deleted the tip/auth/refactor_set_pub_key branch January 22, 2024 14:50
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
…on decorator (cosmos#19093)

Co-authored-by: unknown unknown <unknown@unknown>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants