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

fix: more compact cli options #6526

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

Conversation

UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Jan 10, 2025

Issue being fixed or feature implemented

dash-cli --help shows an empty Debugging/Testing options: and just too many options in general. Let's fix it.

kudos to @thephez for noticing

What was done?

Pls see individual commits

How Has This Been Tested?

run dash-cli --help compiled with and without this PR and compare the output

Breaking Changes

n/a

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

@UdjinM6 UdjinM6 added this to the 22.1 milestone Jan 10, 2025
@UdjinM6 UdjinM6 changed the title fix: fix: more compact cli options Jan 10, 2025
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces changes to the chain parameter configuration across several source files. A new function, SetupChainParamsOptions, is added in src/chainparams.cpp to manage command-line arguments related to chain parameters, including options for budget, DIP3 activation, high subsidy blocks, and LLMQ types for testing environments. This change expands the configurability of blockchain parameters without altering existing functionality.

In src/chainparamsbase.cpp, multiple command-line arguments related to chain parameters have been removed, indicating a reduction in configuration options available through the base options. The SetupServerArgs function in src/init.cpp has been updated to call the new SetupChainParamsOptions function instead of the previous method. Additionally, new arguments related to masternode functionality have been added, enhancing the configuration options for masternode operations.


📜 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 18a947a and b237cf3.

📒 Files selected for processing (4)
  • src/chainparams.cpp (1 hunks)
  • src/chainparams.h (1 hunks)
  • src/chainparamsbase.cpp (1 hunks)
  • src/init.cpp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/chainparams.h
  • src/chainparams.cpp
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build Dependencies (arm-linux, arm-linux-gnueabihf)
🔇 Additional comments (3)
src/chainparamsbase.cpp (1)

21-21: LGTM! Clean and focused chain parameter options.

The changes successfully make the CLI options more compact by moving specialized chain parameter options to a dedicated function while keeping only the essential ones here.

src/init.cpp (2)

708-708: LGTM! Appropriate placement of chain parameter options setup.

The addition of SetupChainParamsOptions call is well-placed in the initialization sequence and aligns with the goal of making CLI options more compact.


708-708: Verify completeness of chain parameter options.

Let's verify that all chain parameter options are properly handled after the refactoring.

✅ Verification successful

Chain parameter options are properly handled after refactoring

The chain parameter options are correctly split between SetupChainParamsBaseOptions (basic chain selection) and SetupChainParamsOptions (chain-specific parameters). Runtime options like -assumevalid and -minimumchainwork are appropriately kept separate in init.cpp.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any chain parameter related options that might be missing
# in the new SetupChainParamsOptions function.

# Search for chain parameter related options in the old code
echo "Searching for chain parameter options in old code..."
rg -A 1 "AddArg.*chain" src/

# Search for their handling in the new code
echo "Searching for option handling in new code..."
rg -A 1 "SetupChainParamsOptions" src/

Length of output: 10054


Script:

#!/bin/bash
# Check the implementation of SetupChainParamsOptions
echo "Checking SetupChainParamsOptions implementation..."
rg -A 50 "^void SetupChainParamsOptions" src/chainparams.cpp

Length of output: 4198

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.

Copy link

This pull request has conflicts, please rebase.

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