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

refactor: update BridgeFeeOracle and BridgeFeeQuote contracts #895

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

zakir-code
Copy link
Contributor

@zakir-code zakir-code commented Jan 14, 2025

Summary by CodeRabbit

Based on the comprehensive changes across multiple contracts and files, here are the release notes:

  • New Features

    • Enhanced multi-chain support for bridge fee oracle and quote management
    • Added ability to manage oracle statuses per chain
    • Introduced more flexible quote and token registration mechanisms
  • Breaking Changes

    • Updated method signatures to use bytes32 for chain and token names
    • Modified quote and oracle management structures
    • Removed several legacy methods related to quote and chain management
  • Improvements

    • Implemented more granular control over oracle and quote configurations
    • Simplified quote creation and retrieval processes
    • Enhanced type safety and contract interaction methods

Copy link

coderabbitai bot commented Jan 14, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant modifications to the bridge fee oracle and quote contracts, focusing on enhancing chain-specific data management. The changes primarily involve transitioning from string-based to bytes32-based chain and token identifiers, restructuring oracle status tracking, and modifying quote handling mechanisms. The updates aim to provide more granular control over oracle statuses across different chains, improve quote management, and streamline the contract interfaces.

Changes

File Change Summary
contract/bridge_fee_oracle.sol.go Updated method signatures to use bytes32 for chain names, added Bytes32ToString method, modified oracle status and blacklisting functions
solidity/contracts/bridge/BridgeFeeOracle.sol Introduced nested mapping for oracle statuses, updated isOnline and getOracleList functions, added bytes32ToString utility function
solidity/contracts/bridge/BridgeFeeQuote.sol Restructured quote and token management, added chain and token registration methods, modified quote retrieval logic
solidity/contracts/bridge/IBridgeFee.sol Replaced string-based interfaces with bytes32, updated structs and function signatures, added NewQuote event
solidity/contracts/test/BridgeFeeQuoteTest.sol Modified oracleStatus mapping to support chain-specific oracle states
solidity/test/bridge_fee_quote.ts Updated test cases to reflect new contract method signatures and quote input structures

Sequence Diagram

sequenceDiagram
    participant User
    participant BridgeFeeQuote
    participant BridgeFeeOracle
    
    User->>BridgeFeeQuote: registerChain(chainName, tokens)
    BridgeFeeQuote-->>User: Confirm chain registration
    
    User->>BridgeFeeOracle: isOnline(chainName, oracleAddress)
    BridgeFeeOracle-->>User: Return online status
    
    User->>BridgeFeeQuote: quote(quoteInputs)
    BridgeFeeQuote->>BridgeFeeOracle: Verify oracle status
    BridgeFeeOracle-->>BridgeFeeQuote: Confirm oracle validity
    BridgeFeeQuote-->>User: Return quote IDs
Loading

Possibly related PRs

Poem

🐰 Bytes dancing, chains unfurled,
Oracle's wisdom now empowered!
From strings to bytes, we leap and bound,
Bridge fees tracked, new logic found.
Rabbit's code hops with glee! 🌉✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93c36e3 and aa73779.

📒 Files selected for processing (6)
  • contract/bridge_fee_oracle.sol.go (7 hunks)
  • solidity/contracts/bridge/BridgeFeeOracle.sol (3 hunks)
  • solidity/contracts/bridge/BridgeFeeQuote.sol (3 hunks)
  • solidity/contracts/bridge/IBridgeFee.sol (1 hunks)
  • solidity/contracts/test/BridgeFeeQuoteTest.sol (1 hunks)
  • solidity/test/bridge_fee_quote.ts (3 hunks)

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@zakir-code zakir-code merged commit fd27157 into main Jan 14, 2025
8 of 9 checks passed
@zakir-code zakir-code deleted the todd/quote-contract branch January 14, 2025 03:46
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