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.

Sign up for GitHub

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

Jump to bottom

chore: bump protocol contracts #2944

Closed
wants to merge 1 commit into from
Closed

chore: bump protocol contracts #2944

wants to merge 1 commit into from

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Sep 30, 2024 •
edited by coderabbitai bot
Loading

Description

Bump protocol contracts to use latest main

How Has This Been Tested?

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • New Features

    • Introduced new libraries to enhance functionality, including tss-lib, go-mask, and tongo.

  • Bug Fixes

    • Updated dependency versions to ensure improved compatibility and performance.

@skosito skosito added no-changelog Skip changelog CI check V2_TESTS Run make start-v2-test labels Sep 30, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request includes updates to the go.mod file, focusing on version changes for dependencies and the addition of new libraries. The Go toolchain version has been updated from go1.22.2 to go1.22.5. Notable dependency updates include a new version for github.com/zeta-chain/protocol-contracts and the introduction of three new libraries: github.com/bnb-chain/tss-lib, github.com/showa-93/go-mask, and github.com/tonkeeper/tongo. Additionally, several replace directives have been modified to point to updated versions or forks.

Changes

File Change Summary
go.mod - Updated Go toolchain version from go1.22.2 to go1.22.5.
- Updated github.com/zeta-chain/protocol-contracts from v1.0.2-athens3.0.20240924201108-3a274ce7bad0 to v1.0.2-athens3.0.20240930110058-eda1e9957411.
- Added dependencies: github.com/bnb-chain/tss-lib v1.5.0, github.com/showa-93/go-mask v0.6.2, github.com/tonkeeper/tongo v1.9.3.
- Modified replace directives for several libraries.

Possibly related PRs

  • chore: bump ethermint #2854: This PR also involves updates to the go.mod file, specifically modifying the version of a dependency from the zeta-chain repository, which is directly related to the updates made in this PR regarding github.com/zeta-chain/protocol-contracts.

Suggested reviewers

  • fbac
  • swift1337
  • kingpinXD
  • ws4charlie
  • lumtis
  • brewmaster012
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ec64772 and 0ccae6e.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (1)
  • go.mod (1 hunks)
🔇 Additional comments (4)
go.mod (4)

Line range hint 3-5: Toolchain update approved.

The Go toolchain has been updated from 1.22.2 to 1.22.5. This minor version update is beneficial as it likely includes bug fixes and security improvements.

Line range hint 365-369: New dependencies added. Provide justification.

Three new dependencies have been introduced:

  1. github.com/bnb-chain/tss-lib v1.5.0
  2. github.com/showa-93/go-mask v0.6.2
  3. github.com/tonkeeper/tongo v1.9.3

Please provide justification for the addition of these dependencies and ensure they are utilized effectively in the codebase.

#!/bin/bash
# Check for usage of new dependencies in the codebase
echo "Checking usage of bnb-chain/tss-lib:"
rg --type go "github.com/bnb-chain/tss-lib" -A 5 -B 5

echo "Checking usage of showa-93/go-mask:"
rg --type go "github.com/showa-93/go-mask" -A 5 -B 5

echo "Checking usage of tonkeeper/tongo:"
rg --type go "github.com/tonkeeper/tongo" -A 5 -B 5

Line range hint 380-395: Justify the use of custom forks in replace directives.

Several replace directives have been added or modified, pointing to ZetaChain maintained forks:

  1. github.com/bnb-chain/tss-lib → github.com/zeta-chain/tss-lib
  2. github.com/ethereum/go-ethereum → github.com/zeta-chain/go-ethereum
  3. github.com/libp2p/go-libp2p → github.com/zeta-chain/go-libp2p
  4. gitlab.com/thorchain/tss/go-tss → github.com/zeta-chain/go-tss

While these forks may contain necessary customizations, using them instead of official repositories can lead to maintenance issues and potential security risks. Please provide justification for the use of these forks and ensure that a process is in place to keep them up-to-date with their upstream repositories.

#!/bin/bash
# Check for usage of forked dependencies in the codebase
echo "Checking usage of zeta-chain/tss-lib:"
rg --type go "github.com/zeta-chain/tss-lib" -A 5 -B 5

echo "Checking usage of zeta-chain/go-ethereum:"
rg --type go "github.com/zeta-chain/go-ethereum" -A 5 -B 5

echo "Checking usage of zeta-chain/go-libp2p:"
rg --type go "github.com/zeta-chain/go-libp2p" -A 5 -B 5

echo "Checking usage of zeta-chain/go-tss:"
rg --type go "github.com/zeta-chain/go-tss" -A 5 -B 5

62-62: Dependency update approved. Verify compatibility.

The github.com/zeta-chain/protocol-contracts dependency has been updated to a newer version. While this update is likely beneficial, it's crucial to ensure compatibility with the current codebase.

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

lumtis
lumtis reviewed Sep 30, 2024
View reviewed changes
Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

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

Are there benefits of bumping now instead of using a tag once the release is ready?

#2922

@skosito
Copy link
Contributor Author

skosito commented Sep 30, 2024

Are there benefits of bumping now instead of using a tag once the release is ready?

#2922

just to have latest changes in so we incrementally update, but we can wait for tag since probably there wont be more changes

@skosito
Copy link
Contributor Author

skosito commented Oct 1, 2024

closing until we have a release tag

@skosito skosito closed this Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lumtis lumtis lumtis left review comments

@swift1337 swift1337 swift1337 approved these changes

@brewmaster012 brewmaster012 Awaiting requested review from brewmaster012

@kingpinXD kingpinXD Awaiting requested review from kingpinXD

@ws4charlie ws4charlie Awaiting requested review from ws4charlie

@fbac fbac Awaiting requested review from fbac

Assignees
No one assigned
Labels
no-changelog Skip changelog CI check V2_TESTS Run make start-v2-test
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@skosito @lumtis @swift1337