doc: update CWallet::SignTransaction doc to mention SIGHASH_DEFAULT #32411

pull rkrux wants to merge 1 commits into bitcoin:master from rkrux:sighash-default-doc changing 1 files +1 −1
  1. rkrux commented at 8:21 AM on May 3, 2025: contributor

    While SIGHASH_DEFAULT & SIGHASH_ALL are effectively the same, it's helpful to mention in the function doc exactly what's present in the code.

    It can be seen in the function implementation that SIGHASH_DEFAULT is passed to the overloaded SignTransaction function.

    Ref: https://github.com/bitcoin/bitcoin/blob/f490f5562d4b20857ef8d042c050763795fd43da/src/wallet/wallet.cpp#L2177-L2194

    <!-- *** Please remove the following help text before submitting: *** Pull requests without a rationale and clear improvement may be closed immediately. GUI-related pull requests should be opened against https://github.com/bitcoin-core/gui first. See CONTRIBUTING.md -->

    <!-- Please provide clear motivation for your patch and explain how it improves Bitcoin Core user experience or Bitcoin Core developer experience significantly: * Any test improvements or new tests that improve coverage are always welcome. * All other changes should have accompanying unit tests (see `src/test/`) or functional tests (see `test/`). Contributors should note which tests cover modified code. If no tests exist for a region of modified code, new tests should accompany the change. * Bug fixes are most welcome when they come with steps to reproduce or an explanation of the potential issue as well as reasoning for the way the bug was fixed. * Features are welcome, but might be rejected due to design or scope issues. If a feature is based on a lot of dependencies, contributors should first consider building the system outside of Bitcoin Core, if possible. * Refactoring changes are only accepted if they are required for a feature or bug fix or otherwise improve developer experience significantly. For example, most "code style" refactoring changes require a thorough explanation why they are useful, what downsides they have and why they *significantly* improve developer experience or avoid serious programming bugs. Note that code style is often a subjective matter. Unless they are explicitly mentioned to be preferred in the [developer notes](/doc/developer-notes.md), stylistic code changes are usually rejected. -->

    <!-- Bitcoin Core has a thorough review process and even the most trivial change needs to pass a lot of eyes and requires non-zero or even substantial time effort to review. There is a huge lack of active reviewers on the project, so patches often sit for a long time. -->

  2. doc: update CWallet::SignTransaction doc to mention SIGHASH_DEFAULT
    While `SIGHASH_DEFAULT` & `SIGHASH_ALL` are effectively the same,
    it's helpful to mention in the function doc exactly what's present
    in the code.
    
    It can be seen in the function implementation that `SIGHASH_DEFAULT`
    is passed to the overloaded `SignTransaction` function.
    
    Ref: https://github.com/bitcoin/bitcoin/blob/f490f5562d4b20857ef8d042c050763795fd43da/src/wallet/wallet.cpp#L2177-L2194
    11ff4c9641
  3. DrahtBot commented at 8:21 AM on May 3, 2025: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32411.

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

  4. DrahtBot added the label Docs on May 3, 2025
  5. fanquake requested review from Sjors on May 13, 2025
  6. Sjors commented at 11:49 AM on May 13, 2025: member

    They're only the same for Taproot inputs.

    cc @achow101

  7. achow101 commented at 5:34 PM on May 13, 2025: member

    DEFAULT and ALL are effectively the same for Taproot inputs, and DEFAULT is an alias for ALL for non-taproot inputs. I don't think that this change is meaningfully useful as ALL and DEFAULT are essentially aliases for each other, and mean basically the same thing.

  8. rkrux commented at 5:49 PM on May 13, 2025: contributor

    True. The main reason for this change was that I didn't see any benefit in leaving ALL around in the function documentation when the implementation uses DEFAULT.

    I am open to closing this PR later if this doesn't seem like a strong enough reason.

  9. rkrux closed this on May 26, 2025


Sjors

Labels

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-30 06:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me