Skip to content

Update websocketChainReader #2383

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nick-bisonai
Copy link
Collaborator

Description

preparation for binance dex pool price subscription

Fixes # (issue)

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 Mar 14, 2025
@nick-bisonai nick-bisonai requested a review from a team as a code owner March 14, 2025 07:15
Copy link
Contributor

coderabbitai bot commented Mar 14, 2025

📝 Walkthrough

Walkthrough

This PR extends the blockchain support in the ChainReader by adding Binance as a new blockchain type. It updates the enumeration with a new value, augments the configuration to include a Binance websocket URL, and modifies the client initialization logic to establish and store a Binance client connection. The changes ensure that the ChainReader can now handle Binance, alongside Ethereum and Kaia.

Changes

File(s) Summary
node/pkg/chain/websocketchainreader/type.go Added a new constant Binance to BlockchainType, updated ChainReaderConfig with BinanceWebsocketUrl, added WithBinanceWebsocketUrl function, and introduced BinanceClient in the ChainReader struct.
node/pkg/chain/websocketchainreader/websocketreader.go Modified the New function to establish a Binance websocket connection when configured, added variables binanceClient and binanceChainId, updated the client method with a switch to handle Binance, and stored the Binance client within the ChainReader struct.

Sequence Diagram(s)

sequenceDiagram
    participant CR as ChainReader
    participant Cfg as ChainReaderConfig
    participant Dial as Dial (WebSocket)
    participant ChainMap as chainIdToChainType Map

    Cfg->>CR: Provide configuration (BinanceWebsocketUrl included)
    CR->>Dial: Check if BinanceWebsocketUrl is not empty
    Dial-->>CR: Return connection/client and chain ID
    CR->>ChainMap: Add Binance chain ID and type mapping
    CR->>CR: Store BinanceClient in ChainReader
Loading

Possibly related PRs

Suggested reviewers

  • Intizar-T
  • martinkersner

Poem

In a den of code I happily dwell,
Adding Binance with a magical spell.
With webs and chains that twirl in sync,
I leap through logic in a blink.
Code flows like a sparkling stream—
As I hop and nibble in the digital dream!
🐇✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

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

🧹 Nitpick comments (2)
node/pkg/chain/websocketchainreader/websocketreader.go (2)

50-64: Initialize Binance client

This block closely parallels the setup for Ethereum, including proper error checks and chain ID retrieval. Consider adding a log statement confirming a successful Binance WebSocket connection to aid in debugging and operational visibility.

+ log.Info().Str("BinanceUrl", config.BinanceWebsocketUrl).Msg("Connected to Binance Websocket")

168-178: Avoid panic in production code

The default case currently calls panic("invalid chainType"), which can abruptly terminate your application. Consider returning a nil client or structuring the function to return an error instead, so callers can gracefully handle unexpected chain types.

default:
-	panic("invalid chainType")
+	log.Error().Msgf("invalid chainType: %v", chainType)
+	return nil
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2170006 and 8ad1e87.

⛔ Files ignored due to path filters (1)
  • .github/workflows/node.test.yaml is excluded by !**/*.yaml
📒 Files selected for processing (2)
  • node/pkg/chain/websocketchainreader/type.go (3 hunks)
  • node/pkg/chain/websocketchainreader/websocketreader.go (3 hunks)
🔇 Additional comments (5)
node/pkg/chain/websocketchainreader/type.go (4)

16-16: Add enumerated chain type

Introducing Binance in the BlockchainType enum is consistent with existing naming patterns and helps maintain clarity for the new blockchain support.


20-23: Expand the config

Adding separate fields for each chain’s WebSocket URL maintains clarity and a straightforward configuration approach. If the user ever sets these fields to empty strings, consider whether a default or fallback behavior is necessary.

Could you confirm if there's any fallback logic or environment variable that might populate these fields when left blank?


40-44: Consistent option constructor

This new WithBinanceWebsocketUrl function matches the existing pattern for specifying WebSocket URLs in other chains, ensuring a uniform and predictable API.


55-55: Add new client field

The BinanceClient field aligns well with the existing client fields for Kaia and Ethereum. Ensure you have corresponding test cases or integration tests that verify BinanceClient is initialized and used correctly.

Please verify whether the existing or new tests adequately cover the Binance client usage in ChainReader.

node/pkg/chain/websocketchainreader/websocketreader.go (1)

85-85: Store new client

Assigning binanceClient to the ChainReader struct improves clarity and maintainability. Ensure that an empty BinanceWebsocketUrl does not inadvertently trigger unnecessary client usage.

Do you plan to guard against accidentally using BinanceClient if BinanceWebsocketUrl is empty?

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.

1 participant