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

(DAL) Update proof related codes #1981

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

nick-bisonai
Copy link
Collaborator

Description

Potential fix for invalid signer error

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

Deployment

  • Should publish npm package
  • Should publish Docker image

@nick-bisonai nick-bisonai self-assigned this Aug 1, 2024
@nick-bisonai nick-bisonai requested a review from a team as a code owner August 1, 2024 07:05
Copy link
Contributor

coderabbitai bot commented Aug 1, 2024

Walkthrough

Walkthrough

The changes enhance the robustness and efficiency of the code by introducing conditional checks and optimizing memory usage. In RecoverSigner, a new condition prevents unnecessary modifications to the signature data, while in removeDuplicateProof, the allocation of the result slice is refined to better match actual needs. Together, these adjustments improve the functionality and performance without altering the core logic.

Changes

File Path Change Summary
node/pkg/chain/utils/utils.go Added a conditional check in RecoverSigner to modify signatureCopy based on specific values.
node/pkg/dal/collector/utils.go Reduced capacity of result slice in removeDuplicateProof for better memory efficiency.

Poem

In the code where bunnies play,
Tweaks were made to save the day.
With checks and slices, oh so bright,
Our functions dance in pure delight!
Memory saved, logic refined,
Hooray for changes, sweet and kind! 🐇✨


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 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 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 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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 862980f and 128745e.

Files selected for processing (2)
  • node/pkg/chain/utils/utils.go (1 hunks)
  • node/pkg/dal/collector/utils.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • node/pkg/dal/collector/utils.go
Additional comments not posted (1)
node/pkg/chain/utils/utils.go (1)

629-631: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to RecoverSigner are correctly handling the modified signature data.

Verification successful

The function usage of RecoverSigner is correctly handling the modified signature data.

The code changes are approved, and the function usage in the codebase is consistent with the new logic.

  • node/pkg/dal/collector/utils.go: The RecoverSigner function is used within the getSignerListFromProofs function, and the usage is correctly handling the modified signature data.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `RecoverSigner` are correctly handling the modified signature data.

# Test: Search for the function usage. Expect: Only occurrences of the new logic.
rg --type go -A 5 $'RecoverSigner'

Length of output: 1159


Script:

#!/bin/bash
# Description: Extract more lines around the function usage in node/pkg/dal/collector/utils.go to ensure correct handling of modified signature data.

# Extract 10 lines before and after the function call to get more context
rg --type go -B 10 -A 10 $'chainutils.RecoverSigner' node/pkg/dal/collector/utils.go

Length of output: 623

Copy link
Contributor

@Intizar-T Intizar-T left a comment

Choose a reason for hiding this comment

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

lgtm!

not sure what does 27 or 28 stand for RecoverSigner function but is it okay we are not doing anything if signatureCopy[64] is not 27 or 28?

@nick-bisonai
Copy link
Collaborator Author

lgtm!

not sure what does 27 or 28 stand for RecoverSigner function but is it okay we are not doing anything if signatureCopy[64] is not 27 or 28?

More exactly if signatureCopy[64] is 0 or 1, it means it has already been processed, ready to extract signer.
the process is called normalization. it can be more precise if the value is not 0,1,27, nor 28, return error

@nick-bisonai nick-bisonai merged commit 5554d96 into master Aug 1, 2024
2 checks passed
@nick-bisonai nick-bisonai deleted the fix/potential-fix-for-wrong-signers branch August 1, 2024 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants