getaddressutxos JSON-RPC method

[teor2345]

Motivation

lightwalletd uses the getaddressutxos JSON-RPC method in response to wallet queries, so this RPC needs to be fast.

Required Fields

The method is documented here: https://zcash.github.io/rpc/getaddressutxos.html

lightwalletd always uses the multi-address request, without chaininfo: https://github.com/zcash/lightwalletd/blob/master/frontend/service.go#L402

Request:

{
  "addresses":
    [
      "address"  (string) The base58check encoded address
      ,...
    ],
}

And only these fields are used by lightwalletd: https://github.com/zcash/lightwalletd/blob/master/common/common.go#L124

Response:

[
  {
    "address"  (string) The address base58check encoded
    "txid"  (string) The output txid
    "height"  (number) The block height
    "outputIndex"  (number) The output index
    "script"  (string) The script hex encoded
    "satoshis"  (number) The number of zatoshis of the output
  }, ...
]

Result Sorting

Returned UTXOs must be sorted by height:
https://github.com/zcash/lightwalletd/blob/68789356fb1a75f62735a529b38389ef08ea7582/walletrpc/service.proto#L120-L121

Tasks

Implementation:

• Implement the new ReadRequest for ReadState
  Use the non-finalized and finalized indexes if they are ready (or an empty list if these tickets are still open):
  • Modify utxo_by_outpoint to utxo_by_out_loc in the finalized state #3952
  • Add utxo_by_transparent_addr_loc index to the finalized state #3953 - FinalizedState::address_utxos()
  • feat(state): add transparent address indexes to the non-finalized state #4022
• Implement the RPC method

Testing:

• Add RPC unit tests
• Test that the RPC method works with lightwalletd

[ftm1000]

Hey team! Please add your planning poker estimate with ZenHub @conradoplg @dconnolly @gustavovalverde @jvff @oxarbitrage @teor2345 @upbqdn

[teor2345]

The state parts of this ticket aren't merged yet (#3999, #4022), but you could add a state request/response that returns an empty list of UTXOs.

[oxarbitrage]

@teor2345 if you didn't started on this one yet i can take it as it similar to #3147

let me know.

[teor2345]

@teor2345 if you didn't started on this one yet i can take it as it similar to #3147

let me know.

Sure, go for it!

[teor2345]

Returned UTXOs must be sorted by height:
https://github.com/zcash/lightwalletd/blob/68789356fb1a75f62735a529b38389ef08ea7582/walletrpc/service.proto#L120-L121

Zebra's state response already sorts in chain order. (Which is stricter than height sorting.)