doc: Fix incorrect sendmany RPC doc #25093

pull maflcko wants to merge 2 commits into bitcoin:master from maflcko:2205-doc-rpc-opt-🚈 changing 2 files +9 −6
  1. maflcko commented at 2:39 PM on May 9, 2022: member

    This enables the skipped type check for sendmany and fixes the resulting error.

    Also, there is an unrelated test-only commit.

  2. maflcko added the label RPC/REST/ZMQ on May 9, 2022
  3. maflcko cross-referenced this on May 9, 2022 from issue rpc: add getblockfrompeer RPCTypeCheck and invalid input test coverage by jonatack
  4. maflcko commented at 2:50 PM on May 9, 2022: member

    Rendered diff:

    diff --git a/sendmany b/sendmany
    index 67f8189..6698a7d 100644
    --- a/sendmany
    +++ b/sendmany
    @@ -1,10 +1,10 @@
    -sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode" fee_rate verbose )
    +sendmany ( "" ) {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode" fee_rate verbose )
     
     Send multiple times. Amounts are double-precision floating point numbers.
     Requires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.
     
     Arguments:
    -1. dummy                     (string, required) Must be set to "" for backwards compatibility.
    +1. dummy                     (string, optional, default="\"\"") Must be set to "" for backwards compatibility.
     2. amounts                   (json object, required) The addresses and amounts
          {
            "address": amount,    (numeric or string, required) The bitcoin address is the key, the numeric amount (can be string) in BTC is the value
    
  5. maflcko force-pushed on May 10, 2022
  6. maflcko renamed this:
    rpc: Fix incorrect sendmany doc and check all docs
    rpc: Check for omitted, but required parameters
    on May 10, 2022
  7. maflcko marked this as a draft on May 10, 2022
  8. DrahtBot commented at 7:59 PM on May 10, 2022: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK fanquake

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #26514 (Improve address decoding errors by aureleoules)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

  9. DrahtBot cross-referenced this on May 12, 2022 from issue rpc: Add RPCContext by promag
  10. luke-jr referenced this in commit 32cca184b7 on May 21, 2022
  11. DrahtBot cross-referenced this on Sep 8, 2022 from issue refactor: Run type check against RPCArgs (1/2) by maflcko
  12. DrahtBot cross-referenced this on Sep 14, 2022 from issue refactor: Set RPCArg options with designated initializers by maflcko
  13. DrahtBot added the label Needs rebase on Sep 30, 2022
  14. maflcko force-pushed on Dec 12, 2022
  15. DrahtBot removed the label Needs rebase on Dec 12, 2022
  16. DrahtBot cross-referenced this on Dec 12, 2022 from issue clang-tidy: Add more `performance-*` checks and related fixes by hebasto
  17. DrahtBot cross-referenced this on Dec 12, 2022 from issue Improve address decoding errors by aureleoules
  18. DrahtBot cross-referenced this on Dec 13, 2022 from issue rpc: Replace OMITTED_NAMED_ARG with OMITTED by maflcko
  19. DrahtBot cross-referenced this on Dec 16, 2022 from issue doc: Properly report optional RPC args by maflcko
  20. DrahtBot cross-referenced this on Dec 22, 2022 from issue refactor: Avoid UniValue copies by maflcko
  21. DrahtBot cross-referenced this on Dec 28, 2022 from issue refactor: Add `performance-no-automatic-move` clang-tidy check by hebasto
  22. DrahtBot added the label Needs rebase on Jan 11, 2023
  23. maflcko force-pushed on Jan 11, 2023
  24. DrahtBot removed the label Needs rebase on Jan 11, 2023
  25. DrahtBot added the label Needs rebase on Jan 17, 2023
  26. maflcko force-pushed on Jan 17, 2023
  27. maflcko force-pushed on Jan 17, 2023
  28. test: Add test for missing and omitted required arg fa96f93f05
  29. maflcko renamed this:
    rpc: Check for omitted, but required parameters
    doc: Fix incorrect sendmany RPC doc
    on Jan 17, 2023
  30. DrahtBot renamed this:
    doc: Fix incorrect sendmany RPC doc
    doc: Fix incorrect sendmany RPC doc
    on Jan 17, 2023
  31. doc: Fix incorrect sendmany RPC doc
    This enables the type check and fixes the wrong docs.
    
    Otherwise the enabled check would lead to test errors, such as:
    
    > "wallet_labels.py", line 96, in run_test
    >     node.sendmany(
    >
    > test_framework.authproxy.JSONRPCException:
    >  JSON value of type null is not of expected type string (-3)
    fa95f2033a
  32. maflcko force-pushed on Jan 17, 2023
  33. maflcko added the label Docs on Jan 17, 2023
  34. maflcko marked this as ready for review on Jan 17, 2023
  35. maflcko commented at 12:09 PM on January 17, 2023: member

    Completely reworked this, since the check has been merged, to only fixup the RPC doc

  36. DrahtBot removed the label Needs rebase on Jan 17, 2023
  37. maflcko added the label Wallet on Jan 17, 2023
  38. fanquake approved
  39. fanquake commented at 2:03 PM on January 17, 2023: member

    ACK fa95f2033a26fb18914c2aa5e5e18650d32e6e4b

  40. fanquake merged this on Jan 17, 2023
  41. fanquake closed this on Jan 17, 2023

  42. maflcko deleted the branch on Jan 17, 2023
  43. sidhujag referenced this in commit 33aaaf56f3 on Jan 17, 2023
  44. bitcoin locked this on Jan 17, 2024

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-05-20 06:53 UTC