refactor: inconsistent naming in the code and the API

citp / BlockSci

A high-performance tool for blockchain science and exploration

https://citp.github.io/BlockSci/

GNU General Public License v3.0

1.34k stars 259 forks source link

refactor: inconsistent naming in the code and the API #391

Open mplattner opened 4 years ago

mplattner commented 4 years ago

Some names are inconsistent in the (C++) API. Below is a (non exhaustive) list of some examples:

[ ] Input.age() vs. Output.getBlockHeight() vs. Block.height()
[ ] Some getters use the prefix "get", while others don't. (Eg. Output.txIndex() vs. Output.getValue())
[ ] Output.getType(): can be named to getAddressType
[ ] Everywhere: txNum vs. txIndex

maltemoeser commented 4 years ago

I think there was some intended convention, like to have "getX" when it involves a lookup of data outside of the current struct/class or some computation involved (e.g., Block knows its height but Output needs to get it based on the txNum), but clearly that's not in any way consistent right now.