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

feat: Add signer extraction adapter to prio-nonce mempool #18991

Merged

Conversation

Eric-Warehime
Copy link
Contributor

Description

This adds the SignerExtractionAdapter, an interface which allows for modular behavior when determining tx signing in mempools. Specifically, it adds

  • SignerExtractionAdapter interface
  • DefaultSignerExtractionAdapter
  • An entry to the PriorityNonceMempoolConfig to introduce variable signer extraction

This should be functionally equivalent to the current behavior of the priority nonce mempool. However, it will allow users to introduce custom behavior if they want to. This is particularly useful in EVM appchains which derive signer information in a different way.

I've attempted to introduce this in a backwards compatible manner--injecting the default constructor where necessary.


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

@Eric-Warehime Eric-Warehime requested a review from a team as a code owner January 9, 2024 17:55
Copy link
Contributor

coderabbitai bot commented Jan 9, 2024

Walkthrough

The recent changes involve integrating a SignerExtractor into the PriorityNonceMempool configuration and its associated mempool. This addition affects the initialization of default configurations, the creation of new mempool instances, and the insertion method for transactions. Additionally, a new interface, SignerExtractionAdapter, along with a default implementation and tests, has been added to facilitate signer extraction from transactions within the Cosmos SDK.

Changes

File(s) Change Summary
types/mempool/priority_nonce.go, types/mempool/priority_nonce_test.go Added SignerExtractor to PriorityNonceMempoolConfig, updated DefaultPriorityNonceMempoolConfig and NewPriorityMempool function, and utilized SignerExtractor in Insert method. Also, included SignerExtractor in PriorityNonceMempoolConfig within test cases.
types/mempool/signer_extraction_adapter.go Introduced SignerData struct, SignerExtractionAdapter interface, and DefaultSignerExtractionAdapter implementation.
types/mempool/signer_extraction_adapater_test.go Added tests for default signer extraction adapter, covering valid, invalid, and non-verifiable transactions, and error scenarios.

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.

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

Changes LGTM! I just have one doubt in SignerData.Signer type.

types/mempool/signer_extraction_adapter.go Show resolved Hide resolved
@alexanderbez alexanderbez added backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C: mempool labels Jan 9, 2024
@julienrbrt julienrbrt mentioned this pull request Jan 10, 2024
12 tasks
@alexanderbez
Copy link
Contributor

@Eric-Warehime if you could kindly resolve the merge conflict, this will be merged right away. Thanks!

auto-merge was automatically disabled January 12, 2024 17:51

Head branch was pushed to by a user without write access

@alexanderbez alexanderbez added this pull request to the merge queue Jan 12, 2024
Merged via the queue into cosmos:main with commit 5452586 Jan 12, 2024
51 of 55 checks passed
mergify bot pushed a commit that referenced this pull request Jan 12, 2024
(cherry picked from commit 5452586)

# Conflicts:
#	CHANGELOG.md
julienrbrt added a commit that referenced this pull request Jan 15, 2024
…18991) (#19042)

Co-authored-by: Eric Warehime <eric.warehime@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
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: mempool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants