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

chore: use btcsuite/btcd/btcec/v2 in x/crosschain/types #2804

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Aug 30, 2024

Part of #2798, Related to #2750

Should resolve:

go: zetacored-rpc imports
	github.com/zeta-chain/node/pkg/rpc imports
	github.com/zeta-chain/node/x/crosschain/types imports
	github.com/btcsuite/btcd/btcec: module github.com/btcsuite/btcd@latest found (v0.24.2), but does not contain package github.com/btcsuite/btcd/btcec

Summary by CodeRabbit

  • New Features
    • Upgraded the cryptographic library for enhanced transaction verification.
    • Improved public key parsing logic, potentially increasing the reliability of SegWit transaction validation.

Copy link
Contributor

coderabbitai bot commented Aug 30, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The changes involve an update to the import path for the btcec package, reflecting a version upgrade to github.com/btcsuite/btcd/btcec/v2. Additionally, the verifyOutboundBodyBTC function has been modified to change the public key parsing logic, specifically by omitting the btcec.S256() argument in the ParsePubKey function, which may alter how public keys are processed during transaction verification.

Changes

Files Change Summary
x/crosschain/types/tx_body_verification.go Updated import path for btcec package to version 2 and modified public key parsing in verifyOutboundBodyBTC.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Transaction
    participant BTCVerification

    User->>Transaction: Initiate transaction
    Transaction->>BTCVerification: Send transaction data
    BTCVerification->>BTCVerification: Parse public key (new logic)
    BTCVerification-->>Transaction: Return verification result
    Transaction-->>User: Notify transaction status
Loading

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

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@gartnera gartnera enabled auto-merge August 30, 2024 16:36
Copy link

codecov bot commented Aug 30, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 66.62%. Comparing base (b516a46) to head (c651f5d).
Report is 3 commits behind head on develop.

Files with missing lines Patch % Lines
x/crosschain/types/tx_body_verification.go 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #2804   +/-   ##
========================================
  Coverage    66.62%   66.62%           
========================================
  Files          370      370           
  Lines        20735    20735           
========================================
  Hits         13814    13814           
  Misses        6283     6283           
  Partials       638      638           
Files with missing lines Coverage Δ
x/crosschain/types/tx_body_verification.go 64.28% <0.00%> (ø)

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: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b516a46 and c651f5d.

Files selected for processing (1)
  • x/crosschain/types/tx_body_verification.go (2 hunks)
Additional context used
Path-based instructions (1)
x/crosschain/types/tx_body_verification.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

GitHub Check: codecov/patch
x/crosschain/types/tx_body_verification.go

[warning] 139-139: x/crosschain/types/tx_body_verification.go#L139
Added line #L139 was not covered by tests

Additional comments not posted (1)
x/crosschain/types/tx_body_verification.go (1)

7-7: Updated import path for btcec library.

The import path for the btcec package has been updated to github.com/btcsuite/btcd/btcec/v2. This change is crucial as it reflects a version upgrade which might include breaking changes or enhancements. Ensure that all functionalities relying on this library are tested to confirm compatibility with the new version.

x/crosschain/types/tx_body_verification.go Show resolved Hide resolved
@gartnera gartnera added this pull request to the merge queue Sep 3, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 3, 2024
@gartnera gartnera added this pull request to the merge queue Sep 3, 2024
Merged via the queue into develop with commit 74f1ab5 Sep 3, 2024
32 of 33 checks passed
@gartnera gartnera deleted the btcd-btcec-v2 branch September 3, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants