RPC: fix sendall docs #26010

pull ajtowns wants to merge 1 commits into bitcoin:master from ajtowns:202209-sendalldoc changing 1 files +8 −4

ajtowns commented at 8:45 AM on September 5, 2022: contributor

Updates the documentation for the "inputs" entry in the "options" parameter of the sendall RPC to match the documentation for createrawtransaction.
ajtowns commented at 8:45 AM on September 5, 2022: contributor

cc @Xekyo @Sjors perhaps

in src/wallet/rpc/spend.cpp:1267 in 3b3409c838 outdated

1265 | @@ -1266,9 +1266,13 @@ RPCHelpMan sendall()
1266 |                                                "e.g. with 'importpubkey' or 'importmulti' with the 'pubkeys' or 'desc' field."},
1267 |                          {"inputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with send_max. A JSON array of JSON objects",

MarcoFalke commented at 9:17 AM on September 5, 2022:

                        {"inputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with send_max.",

ajtowns commented at 1:25 PM on September 5, 2022:

Done

MarcoFalke added this to the milestone 24.0 on Sep 5, 2022
DrahtBot added the label RPC/REST/ZMQ on Sep 5, 2022
glozow requested review from murchandamus on Sep 5, 2022

RPC: fix sendall docs

Updates the documentation for the "inputs" entry in the "options"
parameter of the sendall RPC to match the documentation for
createrawtransaction.

5182940996

ajtowns force-pushed on Sep 5, 2022

ajtowns commented at 1:27 PM on September 5, 2022: contributor

Current help text:

       "inputs": [                  (json array, optional, default=[]) Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with send_max. A JSON array of JSON objects
         "txid",                    (string, required) The transaction id
         vout,                      (numeric, required) The output number
         sequence,                  (numeric, required) The sequence number
         ...
       ],

New help text:

       "inputs": [                  (json array, optional, default=[]) Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with send_max.
         {                          (json object)
           "txid": "hex",           (string, required) The transaction id
           "vout": n,               (numeric, required) The output number
           "sequence": n,           (numeric, optional, default=depends on the value of the 'replaceable' and 'locktime' arguments) The sequence number
         },

achow101 commented at 9:40 PM on September 6, 2022: member

ACK 51829409967dcfd039249506ecd2c58fb9a74b2f
murchandamus commented at 9:53 PM on September 6, 2022: contributor

ACK 51829409967dcfd039249506ecd2c58fb9a74b2f
achow101 merged this on Sep 6, 2022
achow101 closed this on Sep 6, 2022
sidhujag referenced this in commit 931b849c32 on Sep 7, 2022
MarcoFalke cross-referenced this on Sep 12, 2022 from issue refactor: Run type check against RPCArgs (1/2) by MarcoFalke
bitcoin locked this on Sep 7, 2023

Contributors

Review Requested
murchandamus

Labels

RPC/REST/ZMQ

Milestone
24.0

Linked (view graph)

#26039 refactor: Run type check against RPCArgs (1/2)