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

Update binance_provider.dart #2502

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

c4pt00
Copy link

@c4pt00 c4pt00 commented Jan 5, 2025

update to .us instead of .com restrictions for binance.com api usage

for international use worldwide

the .com api is restricted only to China mainland

.us should be open internationally (except for China mainland or something)

one API for all? sure why not

see changes please

Summary by CodeRabbit

  • New Features

    • Updated Binance API endpoint to use Binance.US URL
    • Enhanced error handling for API requests with specific status code (451)
  • Bug Fixes

    • Improved resilience of API data retrieval when encountering legal restrictions

Copy link

coderabbitai bot commented Jan 5, 2025

Walkthrough

The pull request modifies the BinanceProvider class in the market data package, focusing on two key changes: updating the default API URL from Binance's global endpoint to the US-specific endpoint, and enhancing error handling for the fetchExchangeInfoReduced method to manage a specific HTTP status code (451) by returning a default response object.

Changes

File Change Summary
packages/komodo_cex_market_data/lib/src/binance/data/binance_provider.dart - Updated default apiUrl from global Binance API to US-specific endpoint
- Enhanced fetchExchangeInfoReduced method to handle HTTP 451 status code

Poem

🐰 A Binance Bunny's Byte

From global to US, the endpoint shifts
A rabbit's code with subtle drifts
HTTP 451, a legal dance
Our market data takes its stance
With resilience, we hop along! 🚀


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.

Copy link

@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 (1)
packages/komodo_cex_market_data/lib/src/binance/data/binance_provider.dart (1)

Line range hint 59-65: Consider providing more context when returning an empty response for HTTP 451.

While returning an empty response object for status code 451 helps avoid throwing an exception, it may be beneficial to log or otherwise expose the reason (i.e., service restricted) so callers can react accordingly, rather than receiving a seemingly valid—but empty—response. This can prevent confusion for consumers of the API.

} else if (response.statusCode == 451) {
+  // Consider adding a log or debug message here, e.g.:
+  // debugPrint('Binance service unavailable due to legal reasons (451). Returning empty response');
   return BinanceExchangeInfoResponseReduced(
     timezone: '',
     serverTime: 0,
     symbols: List.empty(),
   );
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bfb1737 and 81c2d11.

📒 Files selected for processing (1)
  • packages/komodo_cex_market_data/lib/src/binance/data/binance_provider.dart (1 hunks)
🔇 Additional comments (1)
packages/komodo_cex_market_data/lib/src/binance/data/binance_provider.dart (1)

11-11: Change from .com to .us domain is aligned with PR objective.

Switching the default base URL to https://api.binance.us/api/v3 aligns well with the stated goal of enabling access for international users outside mainland China. This should simplify the flow for users who previously needed alternative endpoints.

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