zcash/lightwalletd

GetTaddressTxids is misnamed

defuse opened this issue · 2 comments

The name GetTaddressTxids suggests that the RPC returns a list of txids, but it actually returns the raw transaction data for all of the transactions.

It doesn't seem possible to rename this method in a backward-compatible way. I found this article on the subject:

The following items are protocol and binary breaking changes:

  • Renaming a package, service or method

GetTAddressTxids is a method introduced in #149.

We could add a new method with a better name (I'd favor GetTAddressTransactions) that does exactly the same thing, and then remove the old name when we're sure that all gRPC clients have changed to using the new name, but it's hard to know when we've reached that point. So I'd say it probably isn't worth making any changes.

What do you think?

We should at least document that the method is misnamed, I just create #427 to do that.

Closing for now, let me know if you'd like this addressed.