doc: corrected lockunspent rpc quoting

[Talej]

bitcoin-cli help lockunspent RPC example shows:

As a JSON-RPC call
> 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:

curl --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

{"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:

curl --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

{"result":true,"error":null,"id":"curltest"}

[DrahtBot]

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
ACK	rkrux, achow101
Concept NACK	sipa
Stale ACK	luke-jr

If your review is incorrectly listed, please copy-paste <!--meta-tag:bot-skip--> into the comment that the bot should ignore.

Conflicts

Reviewers, this pull request conflicts with the following ones:

• #24539 (Add a "tx output spender" index by sstone)

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.

[fanquake]

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.

[Talej]

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

All relevant changes should be complete here

[luke-jr]

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

crACK 1f3f5c049b4080ecaf30604fd22d65aa0fc4af45

[fanquake]

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

[Talej]

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

Done!

[fanquake]

@Talej Can you rebase this?

[Talej]

@Talej Can you rebase this?

All done!

[achow101]

ACK 7e93e29

Edit: Retracting ack, agree with #31275 (comment)

[rkrux]

crACK 7e93e29

Can update the PR title now that more RPCs are updated.

[sipa]

I wanted to verify if all invocations of HelpExampleRpc produce valid JSON, so I tested by adding a UniValue::read inside the function. The following RPCs all fail it still (with this PR):

• getblockfrompeer
• importmempool
• getindexinfo
• addnode
• addconnection
• sendmsgtopeer
• createwalletdescriptor
• restorewallet
• listlabels
• loadwallet
• unloadwallet

I think this means we either need to:

• Get rid of the curl example codes in the RPC help texts entirely, or
• Add testing to actually enforce they're correct.

[sipa]

Weak Concept NACK.

Given how broken the examples are, I think we should fix them throughout and add testing to prevent regressions, or get rid of them entirely.

[DrahtBot]

🐙 This pull request conflicts with the target branch and needs rebase.