rpc: Fix help text for signtransactionwithXXX #15669

1. 
   torkelrogstad commented at 4:48 PM on March 26, 2019: contributor

   This PR fixes the help text for the signrawtransactionwithwallet and signrawtransactionwithkey RPC calls. They both marked the amount field in the UTXO dependencies as required. This field is omitted in the rpc_rawtransaction.py test and successful_signing_test in rpc_signrawtransaction.py.

2. in src/rpc/rawtransaction.cpp:967 in 62e7f39a36 outdated

    963 | @@ -964,7 +964,7 @@ static UniValue signrawtransactionwithkey(const JSONRPCRequest& request)
    964 |                                      {"scriptPubKey", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "script key"},
    965 |                                      {"redeemScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2SH) redeem script"},
    966 |                                      {"witnessScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2WSH or P2SH-P2WSH) witness script"},
    967 | -                                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The amount spent"},
    968 | +                                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::OMITTED_NAMED_ARG, "The amount spent"},
   

   ---

   ---

   

   MarcoFalke commented at 5:44 PM on March 26, 2019:

   It should be explained when it is not required instead of just stating that it is not required.

   ---

   

   torkelrogstad commented at 5:35 PM on March 27, 2019:

   Would it be sufficient to say it's only required for segwit inputs?

   ---

   

   sipa commented at 5:50 PM on March 27, 2019:

   Indeed (it's required for segwit inputs, and useless for non-segwit inputs).

   ---

   

   torkelrogstad commented at 9:14 PM on March 27, 2019:

   Pushed fix

3. fanquake added the label RPC/REST/ZMQ on Mar 26, 2019
4. torkelrogstad force-pushed on Mar 27, 2019
5. in src/wallet/rpcwallet.cpp:3153 in 9e7a1345c7 outdated

   3149 | @@ -3150,7 +3150,7 @@ UniValue signrawtransactionwithwallet(const JSONRPCRequest& request)
   3150 |                                      {"scriptPubKey", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "script key"},
   3151 |                                      {"redeemScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2SH) redeem script"},
   3152 |                                      {"witnessScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2WSH or P2SH-P2WSH) witness script"},
   3153 | -                                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The amount spent"},
   3154 | +                                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::OMITTED, "(required for non-P2PKH) the amount spent"},
   

   ---

   ---

   

   MarcoFalke commented at 9:32 PM on March 27, 2019:

   This isn't wrong, but it would be nice to use the same help string as above

   ---

   

   torkelrogstad commented at 7:55 AM on March 28, 2019:

   Pushed changes

6. 
   MarcoFalke commented at 9:32 PM on March 27, 2019: member

   ACK

7. rpc: Fix help text for signtransactionwithXXX afc06fc868
8. torkelrogstad force-pushed on Mar 28, 2019
9. MarcoFalke approved
10. 
    MarcoFalke commented at 1:29 PM on March 28, 2019: member

    utACK afc06fc8687e394e93d568e59808bb2660a75e06

11. MarcoFalke added this to the milestone 0.19.0 on Mar 28, 2019
12. 
    promag commented at 9:38 PM on March 29, 2019: member

    utACK afc06fc.

13. MarcoFalke added the label Docs on Mar 29, 2019
14. MarcoFalke referenced this in commit 79c345a011 on Mar 29, 2019
15. MarcoFalke merged this on Mar 29, 2019
16. MarcoFalke closed this on Mar 29, 2019

    ---

17. torkelrogstad deleted the branch on Apr 1, 2019
18. DrahtBot locked this on Dec 16, 2021

Contributors

torkelrogstadMarcoFalkesipapromag

Milestone
0.19.0