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

Problem: precompile with hermes is not tested #1326

Merged
merged 1 commit into from
Feb 21, 2024

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Feb 21, 2024

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features
    • Added a new json_rpc_address configuration for enhanced relayer connectivity.
  • Bug Fixes
    • Adjusted timeout settings for more reliable channel readiness checks.
    • Transitioned to hermes_transfer for improved IBC relay testing.
  • Refactor
    • Updated dependency specifications for the hermes package to ensure compatibility and performance.
  • Chores
    • Introduced a new Nix expression for building the "hermes" package with specific dependencies and configurations.

Copy link
Contributor

coderabbitai bot commented Feb 21, 2024

Walkthrough

The updates span across configuration and integration tests, introducing a new JSON RPC address for the relayer, tweaking timeout settings, transitioning from rly to hermes transfer mechanisms, and refining the Nix build process for the hermes package. These changes aim to enhance the reliability and specificity of the inter-blockchain communication (IBC) relay setup, particularly focusing on the integration of a more precise hermes configuration and improving test robustness.

Changes

Files Change Summary
.../configs/ibc_rly_evm.jsonnet Added json_rpc_address field to the relayer config.
.../ibc_utils.py Modified wait_for_fn to include timeout=30 in check_channel_ready.
.../test_ibc_rly.py Replaced rly_transfer with hermes_transfer in integration test.
nix/default.nix Modified hermes package call to include sources.ibc-rs.
nix/hermes.nix Introduced a Nix expression for building the "hermes" package with specific configurations.

🐇✨
In the realm of code, where the bits do hop,
Changes abound, improvements non-stop.
From rly to hermes, across the block sea,
A rabbit's work, as nimble as can be.
With Nix and Python, the craft does refine,
In the digital burrow, where the bytes align.
🌟🐾

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-tests for this file.
  • 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.

@mmsqe mmsqe marked this pull request as ready for review February 21, 2024 01:54
@mmsqe mmsqe requested a review from a team as a code owner February 21, 2024 01:54
@mmsqe mmsqe requested review from yihuang and calvinaco and removed request for a team February 21, 2024 01:54
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e16b913 and 1656006.
Files ignored due to path filters (1)
  • nix/sources.json is excluded by: !**/*.json
Files selected for processing (5)
  • integration_tests/configs/ibc_rly_evm.jsonnet (1 hunks)
  • integration_tests/ibc_utils.py (1 hunks)
  • integration_tests/test_ibc_rly.py (3 hunks)
  • nix/default.nix (1 hunks)
  • nix/hermes.nix (1 hunks)
Additional comments: 5
integration_tests/configs/ibc_rly_evm.jsonnet (1)
  • 7-7: The addition of the json_rpc_address field with the value 'http://127.0.0.1:26701' to the relayer configuration is correctly implemented. This change enhances the setup for relayer communication by specifying the JSON RPC address for a blockchain node, which is crucial for integration testing scenarios.
nix/hermes.nix (1)
  • 1-35: The hermes.nix file is correctly implemented, providing a comprehensive Nix expression for building the Hermes Rust package. It includes appropriate dependencies, build flags, and configurations, ensuring a secure and optimized build process. The attention to cross-platform compatibility, reproducible builds, and specific OpenSSL version configurations are commendable practices that enhance the security and reliability of the build.
nix/default.nix (1)
  • 43-43: The modification of the hermes package call to include the src = sources.ibc-rs; parameter is correctly implemented. This change refines the package setup by specifying a more precise source for the Hermes package, which is crucial for ensuring the build process uses the preferred and potentially updated source.
integration_tests/test_ibc_rly.py (1)
  • 232-232: The replacement of the rly_transfer function with hermes_transfer within the test_ibc function is correctly implemented. This change aligns with the PR's focus on enhancing the testing infrastructure for the IBC relay functionality with Hermes. It's important to ensure that the hermes_transfer function is implemented correctly and that its usage here accurately reflects the intended testing scenarios.

Ensure the implementation and usage of the hermes_transfer function meet the testing requirements for the IBC relay functionality with Hermes.

integration_tests/ibc_utils.py (1)
  • 630-630: The addition of timeout=30 to the wait_for_fn call in the wait_for_check_channel_ready function is a positive change, as it introduces a specific timeout for waiting on the channel to be ready. This can help prevent indefinite waiting periods in tests, leading to more predictable and manageable test execution times. However, it's important to ensure that the chosen timeout value of 30 seconds is appropriate for the expected operation time in all testing environments and scenarios. If the operation might take longer under certain conditions, consider adjusting the timeout or making it configurable.

@mmsqe mmsqe added this pull request to the merge queue Feb 21, 2024
Merged via the queue into crypto-org-chain:main with commit 0ef7528 Feb 21, 2024
34 checks passed
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