Skip to content

Merge bitcoin/bitcoin#26558: doc: add tr() descriptor example to deriveaddresses #139

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: backport-0.25-batch-247
Choose a base branch
from
Open

Merge bitcoin/bitcoin#26558: doc: add tr() descriptor example to deriveaddresses #139

wants to merge 2 commits into from

Conversation

DashCoreAutoGuix
Copy link
Owner

Backports bitcoin#26558

Original commit: bc67215

Backported from Bitcoin Core v0.25

Note: Applied to src/rpc/misc.cpp instead of src/rpc/output_script.cpp as the deriveaddresses function is located in a different file in Dash.

Merge bitcoin#26558: doc: add tr() descriptor example to deriveaddresses
423c5d6 
92a4ed0 doc: add tr() descriptor example to deriveaddresses (FractalEncrypt)

Pull request description:

This simple PR adds a missing tr() descriptor example to the help deriveaddresses examples.

- The functionality added in bitcoin#24043 is a significant departure from legacy multisig address creation, yet there is no corresponding tr() descriptor example in the help.
- Having this example in combination with the examples in the descriptors documentation will be helpful to users.

Co-authored-by: FractalEncrypt <[email protected]>
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 19, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

@DashCoreAutoGuix
Copy link
Owner Author

✅ Backport Verification Successful

No issues found! This backport is complete and faithful to the original Bitcoin change.

Original Bitcoin commit: 92a4ed05d1036b45e8274d8bbadfd59b3d487365
Backport PR: #139

Verification Details:

  • File operations match Bitcoin's intent
  • No missing changes detected
  • No scope creep or dependency explosions
  • CI checks passing
  • Content correctly adapted to Dash file structure

Analysis:

Bitcoin modified src/rpc/output_script.cpp to add tr() descriptor example and reformat alignment. Dash correctly applied the same changes to src/rpc/misc.cpp where the deriveaddresses function is located in Dash's codebase.

The help text content is identical between Bitcoin and Dash versions, achieving the same documentation improvement goal.

Size comparison: Bitcoin: 9 changes, Dash: 8 changes (89% ratio - within acceptable range)

This PR is ready for merge. ✅

@DashCoreAutoGuix
Copy link
Owner Author

✅ Backport Verification Successful

No issues found! This backport is complete and faithful to the original Bitcoin change.

Original Bitcoin commit: bc67215
Backport PR: #139

Verification Details:

  • File operations match Bitcoin's intent
  • No missing changes detected
  • No scope creep or dependency explosions
  • CI checks passing
  • Proper adaptation: Applied to src/rpc/misc.cpp instead of src/rpc/output_script.cpp (deriveaddresses function location differs in Dash)

What Bitcoin Changed:

Bitcoin added two new descriptor examples to the deriveaddresses help:

  1. wpkh() example for Native segwit P2PKH outputs
  2. tr(,multi_a(...)) example for P2TR-multisig outputs
  3. Reformatted alignment for better readability

What Dash Implemented:

✅ All Bitcoin changes correctly applied to src/rpc/misc.cpp
✅ Same descriptor examples added with identical formatting
✅ Proper Dash file location adaptation as noted in PR description

This PR is ready for merge. ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@DashCoreAutoGuix