Skip to content

Conversation

alexandre-abrioux
Copy link
Member

@alexandre-abrioux alexandre-abrioux commented Apr 4, 2025

Summary by CodeRabbit

  • Documentation
    • Updated command descriptions to reference the new API endpoints for retrieving currency lists and chain configurations, ensuring users see accurate and up-to-date information in the command help texts.

Copy link
Contributor

coderabbitai bot commented Apr 4, 2025

Walkthrough

This pull request uniformly updates several API endpoint URLs across the toolbox package. The changes replace instances of https://api.request.network with https://api.request.finance in command descriptions and in the getChainConfig API call. These modifications appear in the README and various Chainlink command files, as well as in the transaction utilities. There are no changes to the underlying logic, control flow, or the declarations of exported or public entities.

Changes

File(s) Change Summary
packages/toolbox/README.md
packages/toolbox/src/commands/chainlink/addAggregator.ts
packages/toolbox/src/commands/chainlink/addAggregators.ts
packages/toolbox/src/commands/chainlink/listMissingAggregators.ts
Updated the URL in command descriptions from https://api.request.network/currency/list/NAME to https://api.request.finance/currency/list/NAME for retrieving currency lists.
packages/toolbox/src/commands/transaction/utils.ts Updated the fetch URL in getChainConfig from https://api.request.network/currency/chains/${chainName} to https://api.request.finance/currency/chains/${chainName}.
✨ 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 plan to trigger planning for file edits and PR creation.
  • @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 (1)
packages/toolbox/README.md (1)

76-77: Markdown link contains an empty URL.

The link [https://api.request.finance/currency/list/name]() is missing a target URL. To ensure the documentation properly directs users, please update it to include the URL (for example: [https://api.request.finance/currency/list/name](https://api.request.finance/currency/list/name)).

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

76-76: No empty links
null

(MD042, no-empty-links)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d438b1 and 0f1ab9f.

📒 Files selected for processing (5)
  • packages/toolbox/README.md (1 hunks)
  • packages/toolbox/src/commands/chainlink/addAggregator.ts (1 hunks)
  • packages/toolbox/src/commands/chainlink/addAggregators.ts (1 hunks)
  • packages/toolbox/src/commands/chainlink/listMissingAggregators.ts (1 hunks)
  • packages/toolbox/src/commands/transaction/utils.ts (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
packages/toolbox/README.md

76-76: No empty links
null

(MD042, no-empty-links)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-and-test
  • GitHub Check: build-and-test
🔇 Additional comments (4)
packages/toolbox/src/commands/chainlink/listMissingAggregators.ts (1)

26-26: Updated API endpoint URL in option description.

The description now correctly references https://api.request.finance/currency/list/NAME instead of the previous request.network endpoint. This change is well aligned with similar updates elsewhere in the codebase.

packages/toolbox/src/commands/transaction/utils.ts (1)

44-45: Updated fetch URL to the new API endpoint.

The getChainConfig function now fetches data from https://api.request.finance/currency/chains/${chainName}, which aligns with the new endpoint. The error handling remains intact.

packages/toolbox/src/commands/chainlink/addAggregators.ts (1)

42-45: Updated API endpoint URL in the command builder description.

The list option description now instructs users to refer to https://api.request.finance/currency/list/NAME, ensuring consistency with the updated documentation across the project.

packages/toolbox/src/commands/chainlink/addAggregator.ts (1)

52-56: Updated list option description with the new API endpoint.

The description now correctly specifies that the list must be available at https://api.request.finance/currency/list/NAME. This update brings consistency across all command options dealing with currency lists.

@alexandre-abrioux alexandre-abrioux enabled auto-merge (squash) April 10, 2025 08:56
@alexandre-abrioux alexandre-abrioux merged commit 4597d37 into master Apr 10, 2025
15 checks passed
@alexandre-abrioux alexandre-abrioux deleted the broken-url branch April 10, 2025 09:13
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.

3 participants