Teach CLI the get rates command

[mkysel]

Add get-rates command to CLI to retrieve current rates from rates manager

Implements a new CLI command get-rates with supporting infrastructure:

• Adds new GetRatesOptions struct in cliOptions.go
• Extends CLI struct and options parsing in main.go to support the new command
• Implements getRates function that creates and starts a contract rates fetcher to retrieve current rates
• Groups add-rates with other admin commands for better organization

📍Where to Start

Start with the getRates function implementation in main.go which contains the core logic for fetching rates using the contract rates fetcher.

---

Macroscope summarized a947cbd.

Summary by CodeRabbit

• New Features
  • Introduced a new "get-rates" command in the CLI to fetch and display current rates from the rates manager contract.

[coderabbitai]

Walkthrough

A new "get-rates" command has been introduced to the CLI application. This command enables users to fetch and display current rates from the rates manager contract. The implementation involves adding a GetRatesOptions struct in the configuration, updating the CLI struct to include this new option, and registering the command within the command parser. The main command switch is modified to handle the new command, and a dedicated function is implemented to perform the fetch operation, including error handling for cases where no rates are found.

Changes

File(s)	Change Summary
cmd/cli/main.go	Added "get-rates" command: updated CLI struct, command parser, and main switch; implemented getRates function for fetching and displaying rates; handled specific error cases.
pkg/config/cliOptions.go	Added new empty struct GetRatesOptions for use with the new CLI command.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant BlockchainClient
    participant ContractRatesFetcher

    User->>CLI: Execute "get-rates" command
    CLI->>BlockchainClient: Create client with 15s deadline
    CLI->>ContractRatesFetcher: Instantiate fetcher
    CLI->>ContractRatesFetcher: Start fetcher
    alt No rates found
        ContractRatesFetcher-->>CLI: Return "no rates found" error
        CLI->>CLI: Log info, exit early
    else Rates available
        ContractRatesFetcher-->>CLI: Return current rates
        CLI->>CLI: Log/display rates
    end

Loading

Possibly related PRs

• Add CLI tool for adding rates to the contract #586: Adds an "add-rates" CLI command and related code to submit new rates. Both PRs modify the CLI struct and main.go, implementing distinct but related commands for rate management.

Suggested reviewers

• fbac

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

---

📜 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 307a604 and a947cbd.

📒 Files selected for processing (2)

• cmd/cli/main.go (8 hunks)
• pkg/config/cliOptions.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Upgrade Tests

🔇 Additional comments (8)

pkg/config/cliOptions.go (1)

55-55: LGTM - New empty struct for get-rates command

The empty GetRatesOptions struct follows the established pattern in this file for CLI command options, maintaining consistency with other command option structs.

cmd/cli/main.go (7)

13-14: LGTM - Required import for rates functionality

The import of the fees package is necessary for the new get-rates functionality.

---

43-43: LGTM - CLI struct field for get-rates command

The addition of the GetRates field to the CLI struct properly integrates the new command options.

---

69-69: LGTM - Variable declaration for get-rates options

This line initializes the options variable for the get-rates command, following the pattern used for other commands.

---

119-121: LGTM - Command registration for get-rates

The new get-rates command is properly registered with the parser, following the pattern used for other getter commands.

---

154-154: LGTM - CLI struct initialization for get-rates

The getRatesOptions is correctly included in the CLI struct initialization.

---

431-459: LGTM - Implementation of getRates function

The implementation correctly:

1. Creates a blockchain client with a reasonable timeout
2. Instantiates a ContractRatesFetcher
3. Handles the "no rates found" error case gracefully
4. Logs the retrieved rates

The function follows the same patterns and error handling approach as other commands in the file.

---

670-672: LGTM - Command switch for get-rates

The get-rates command case is properly added to the command switch, calling the getRates function.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate sequence diagram to generate a sequence diagram of the changes in 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.