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 commented at 2:50 pm on May 9, 2022: member

    Rendered diff:

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

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

    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.

    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.

  8. luke-jr referenced this in commit 32cca184b7 on May 21, 2022
  9. DrahtBot added the label Needs rebase on Sep 30, 2022
  10. maflcko force-pushed on Dec 12, 2022
  11. DrahtBot removed the label Needs rebase on Dec 12, 2022
  12. DrahtBot added the label Needs rebase on Jan 11, 2023
  13. maflcko force-pushed on Jan 11, 2023
  14. DrahtBot removed the label Needs rebase on Jan 11, 2023
  15. DrahtBot added the label Needs rebase on Jan 17, 2023
  16. maflcko force-pushed on Jan 17, 2023
  17. maflcko force-pushed on Jan 17, 2023
  18. test: Add test for missing and omitted required arg fa96f93f05
  19. maflcko renamed this:
    rpc: Check for omitted, but required parameters
    doc: Fix incorrect sendmany RPC doc
    on Jan 17, 2023
  20. DrahtBot renamed this:
    doc: Fix incorrect sendmany RPC doc
    doc: Fix incorrect sendmany RPC doc
    on Jan 17, 2023
  21. 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
  22. maflcko force-pushed on Jan 17, 2023
  23. maflcko added the label Docs on Jan 17, 2023
  24. maflcko marked this as ready for review on Jan 17, 2023
  25. 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
  26. DrahtBot removed the label Needs rebase on Jan 17, 2023
  27. maflcko added the label Wallet on Jan 17, 2023
  28. fanquake approved
  29. fanquake commented at 2:03 pm on January 17, 2023: member
    ACK fa95f2033a26fb18914c2aa5e5e18650d32e6e4b
  30. fanquake merged this on Jan 17, 2023
  31. fanquake closed this on Jan 17, 2023

  32. maflcko deleted the branch on Jan 17, 2023
  33. sidhujag referenced this in commit 33aaaf56f3 on Jan 17, 2023
  34. 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: 2024-07-05 22:12 UTC

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