doc: corrected lockunspent rpc quoting #31275

pull Talej wants to merge 1 commits into bitcoin:master from Talej:listunspentrpctypo changing 4 files +8 −8
  1. Talej commented at 2:44 am on November 12, 2024: none

    bitcoin-cli help lockunspent RPC example shows:

    0As a JSON-RPC call
    1> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "lockunspent", "params": [false, "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/
    

    Including quotes around the transactions argument. Using the RPC in this way fails:

    0curl --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "lockunspent", "params": [false, "[{\"txid\":\"6f244af8e2162138369fc736a673f85ead59ad88fb5a1edd6e03f81b33c537b0\",\"vout\":1}]"]}' -H 'content-type: text/plain;' http://127.0.0.1:18443/wallet/locktest
    1
    2{"result":null,"error":{"code":-3,"message":"Expected type array, got string"},"id":"curltest"}
    

    This change corrects the documentation to remove the additional quotes so the example works as intended:

    0curl --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "lockunspent", "params": [false, [{"txid":"6f244af8e2162138369fc736a673f85ead59ad88fb5a1edd6e03f81b33c537b0","vout":0}]]}' -H 'content-type: text/plain;' http://127.0.0.1:18443/wallet/locktest
    1
    2{"result":true,"error":null,"id":"curltest"}
    
  2. DrahtBot commented at 2:44 am on November 12, 2024: contributor

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

    Code Coverage & Benchmarks

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

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    Stale ACK luke-jr

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

    Conflicts

    No conflicts as of last run.

  3. DrahtBot added the label Docs on Nov 12, 2024
  4. Talej marked this as ready for review on Nov 12, 2024
  5. Talej renamed this:
    doc: corrected listunspent rpc quoting
    doc: corrected lockunspent rpc quoting
    on Nov 12, 2024
  6. Talej force-pushed on Nov 12, 2024
  7. Madxgame approved
  8. fanquake commented at 9:54 am on November 12, 2024: member
    The same kind of quoting is used in multiple places in this file, so if it is incorrect / needs updating, all instances should be changed at the same time.
  9. Talej commented at 3:58 am on November 13, 2024: none

    Corrected additional RPC examples for gettxspendingprevout, createrawtransaction, signrawtransactionwithkey, addmultisigaddress & listunspent

    All relevant changes should be complete here

  10. luke-jr approved
  11. luke-jr commented at 8:02 pm on January 8, 2025: member

    Commit messages leave a bit to be desired, but the code and output looks correct

    crACK 1f3f5c049b4080ecaf30604fd22d65aa0fc4af45

  12. fanquake commented at 5:35 pm on February 20, 2025: member
    Please squash your commits. You can improve the commit message at the same time. i.e “doc: ….”
  13. luke-jr referenced this in commit 599a0811ac on Feb 22, 2025
  14. luke-jr referenced this in commit 2f7f2fae63 on Feb 22, 2025
  15. doc: corrected lockunspent, gettxspendingprevout, createrawtransaction, signrawtransactionwithkey, addmultisigaddress & listunspent rpc quoting 49ffbc6077
  16. Talej force-pushed on Feb 27, 2025
  17. Talej commented at 7:09 am on February 27, 2025: none

    Please squash your commits. You can improve the commit message at the same time. i.e “doc: ….”

    Done!


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: 2025-03-31 09:12 UTC

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