[Chore] Backport GetBlockVerbosity Fixes & Add getbalances RPC client command

[JettScythe]

• Refactor GetBlockVerboseTx to reflect correct getblock RPC call parameters
  btcsuite/btcd#1529

• Change getblock default verbosity to 1
  btcsuite/btcd#1560

• rpcclient: send legacy GetBlock request for backwards compatibility
  btcsuite/btcd#1577

[zquestz]

It is important to note we had a previous PR that had this functionality but it never landed in btcd. This is the latest and greatest code and includes a bunch of small fixes. =)

[JettScythe]

Added commit for

• Add getbalances RPC client command

btcsuite/btcd#1595

[zquestz]

Added commit for

• Add getbalances RPC client command

btcsuite/btcd#1595

I don't think that ABC or BCHN have actually picked up the getbalances call...

[zquestz]

Actually, I stand corrected, BCHN doesn't have it, but ABC does as of 0.21.9!

[JettScythe]

ABC enabled getbalances as of 0.21.9 :)

[cculianu]

Guys please keep the getblock call (and any other calls) consistent with BCHN, ABC, BU and core. All 3 expect bool for the verbosity flag.

Changing the verbosity flag to int and throwing an error if it’s bool introduces a needless bchd specific quirk and/or a special case code path in codebases (such as mine) that try to support multiple bitcoin node implementations... for bchd now I have to add more code and spend time dealing with quirks of new bchd vs old bchd vs whatever .. this is a problem for all existing systems.

It also risks introducing a possible regression for all the code out there sending bools.

Please make verbosity remain bool to avoid this.

[cculianu]

Also I want to point out that for getblock — ABC accepts both int and bool there.

[zquestz]

Actually ABC/BCHN can accept an int or a bool, and if you use a bool it can't actually use the highest verbosity level. It accepts 0, 1, 2 as ints, or a bool.

We can make sure a bool still works before this PR lands.

Technically any consumer still sending a bool is sending the deprecated format, and can't even take full advantage of the different output modes.

[zquestz]

Here are the current docs for ABC and BCHN.

root@bitcoin-555854b677-xsnvk:/# bitcoin-cli -rpcuser=$BITCOIN_RPC_USER -rpcpassword=$BITCOIN_RPC_PASSWORD help getblock
getblock "blockhash" ( verbosity )

If verbosity is 0 or false, returns a string that is serialized, hex-encoded data for block 'hash'.
If verbosity is 1 or true, returns an Object with information about block <hash>.
If verbosity is 2, returns an Object with information about block <hash> and information about each transaction.

[zquestz]

@JettScythe want to try and make sure we can also support a boolean value? That would make sure we were completely compatible before this lands.

[cculianu]

@zquestz thanks for clarifying everything. Yeah well the docs make no claim that boolean is deprecated (EDIT: Oh I see -- you consider that deprecated; got it).

There is the matter of existing code that is using bchd (that is now sending bool because int is rejected) that will insta-break if you take only int now.. and then they have the problem of having to probe bchd version to figure out which bchd they are talking to. (I'm talking about myself here and my own pain :D ).

Thanks man I don't see the harm in supporting both. I'm super glad you are doing that. 👍

Technically any consumer still sending a bool is sending the deprecated format, and can't even take full advantage of the different output modes.

Hmm. As Obi Wan Kenobi famously said: "That is true... from a certain point of view"

[zquestz]

@cculianu the latest commits should make sure boolean values continue to work as expected in the API.

• bchctl allows for getblock <hash> <int/bool/string>. Where string is a valid boolean value like "false", "true".
• The API server will accept raw requests with (0,1,2,true,false) and should be fully backward compatible.

Please test and make sure things work as you expect. =)

Example working bchctl commands.

bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6"
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" 0
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" 1
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" 2
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" true
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" false
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" "true"
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" "false"

Invalid bchctl commands.

bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" 3
bchctl getblock "00000000000000000003c9b8bcf48b943f9b9174143419665f7b9d35146c42d6" "bad"

Working curl commands.

curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e"] }' -k
curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e", 0] }' -k
curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e", 1] }' -k
curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e", 2] }' -k
curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e", true] }' -k
curl --header "Content-Type: application/json" https://127.0.0.1:8334/ -d '{ "jsonrpc": "2.0", "id":   1, "method": "getblock", "params": ["0000000000000000024f31fa48016e8462fbd338e64e2a61930f2dd253ee3c1e", false] }' -k