Skip to content

fix: use payment-account-id param name consistently #7432

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 1 commit into
base: master
Choose a base branch
from

Conversation

thecockatiel
Copy link
Contributor

@thecockatiel thecockatiel commented Apr 7, 2025

makes usage of payment-account-id parameter name more consistent
the correct name is payment-account-id, but it was sometimes referred to as payment-account

public final static String OPT_PAYMENT_ACCOUNT_ID = "payment-account-id";

Summary by CodeRabbit

  • Documentation

    • Updated help texts and documentation to consistently use --payment-account-id instead of --payment-account for relevant CLI commands.
  • Chores

    • Updated scripts to use the new --payment-account-id parameter name in CLI commands for offer creation and trading.

Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Copy link

coderabbitai bot commented May 28, 2025

Walkthrough

The changes update the command-line parameter name from --payment-account to --payment-account-id across scripts, CLI help text, and documentation. These modifications ensure consistent usage of the new parameter name in both user-facing help and internal script command construction, without altering any logic, control flow, or function signatures.

Changes

Files/Paths Change Summary
apitest/scripts/limit-order-simulation.sh Changed CLI command argument from --payment-account to --payment-account-id when creating offers.
apitest/scripts/trade-simulation-utils.sh Updated CLI commands in functions to use --payment-account-id instead of --payment-account.
cli/src/main/java/bisq/cli/CliMain.java Updated help text to show --payment-account-id for relevant commands.
core/src/main/resources/help/createoffer-help.txt, core/src/main/resources/help/takeoffer-help.txt Renamed all references of --payment-account to --payment-account-id in documentation.

Poem

The scripts now speak with clearer cheer,
--payment-account-id is what you'll hear.
No more confusion, the docs align,
Commands and help now intertwine.
A hop, a skip, a tidy fix—
The rabbit’s proud of changes slick!
🐇✨

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

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 (2)
apitest/scripts/trade-simulation-utils.sh (2)

186-186: Correct rename of payment account parameter
The change to --payment-account-id=$ACCT_ID in gencreateoffercommand aligns with the PR objective to standardize the parameter name. Ensure $ACCT_ID is always set before calling this function and consider quoting it as --payment-account-id="${ACCT_ID}" to prevent potential word‐splitting issues. You may also opt to use a Bash array for safer command construction.


479-479: Consistent parameter rename in takeoffer command
Updating the takeoffer invocation to use --payment-account-id=$BOB_ACCT_ID is correct. For consistency and safety, quote variable expansions (e.g., --payment-account-id=\"${BOB_ACCT_ID}\") and consider the array‐based construction pattern to avoid concatenation pitfalls.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce2ffce and 5bf0699.

📒 Files selected for processing (5)
  • apitest/scripts/limit-order-simulation.sh (1 hunks)
  • apitest/scripts/trade-simulation-utils.sh (2 hunks)
  • cli/src/main/java/bisq/cli/CliMain.java (2 hunks)
  • core/src/main/resources/help/createoffer-help.txt (4 hunks)
  • core/src/main/resources/help/takeoffer-help.txt (4 hunks)
🔇 Additional comments (4)
core/src/main/resources/help/createoffer-help.txt (1)

15-15: LGTM! Parameter name standardization implemented correctly.

The documentation has been consistently updated to use --payment-account-id instead of --payment-account across the synopsis, options section, and examples. This aligns perfectly with the PR objective to standardize parameter naming throughout the codebase.

Also applies to: 62-62, 85-85, 98-98

apitest/scripts/limit-order-simulation.sh (1)

118-118: LGTM! Test script updated to use standardized parameter name.

The command construction correctly uses --payment-account-id instead of --payment-account, ensuring test scripts are consistent with the updated CLI parameter naming.

cli/src/main/java/bisq/cli/CliMain.java (1)

923-923: LGTM! CLI help text updated for parameter name consistency.

The help text format strings for both createoffer and takeoffer commands have been correctly updated to use --payment-account-id instead of --payment-account, ensuring consistency with the updated help documentation files.

Also applies to: 953-953

core/src/main/resources/help/takeoffer-help.txt (1)

11-11: LGTM! Parameter name standardization completed in takeoffer documentation.

The documentation has been comprehensively updated to use --payment-account-id instead of --payment-account across the synopsis, description, options section, and examples. The changes maintain accuracy and consistency throughout the help text.

Also applies to: 28-28, 42-42, 69-69

Copy link

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant