search

KomodoPlatform / coins

coin parameters and all files needed for GUI support
17 stars 124 forks source link

inconsistent naming scheme of assets types #614

Open gcharang opened 1 year ago

gcharang commented 1 year ago

all the asset types in the current coins file:

  'AVX-20',
  'Matic',
  'BEP-20',
  'ERC-20',
  'KRC-20',
  'FTM-20',
  'HecoChain',
  'UTXO',
  'ZHTLC',
  'SLP',
  'Smart Chain',
  'RSK Smart Bitcoin',
  'Moonriver',
  'Arbitrum',
  'QRC-20',
  'Ethereum Classic',
  'Moonbeam',
  'HRC-20',
  'SmartBCH',
  'Ubiq',
  'TENDERMINT',
  'TENDERMINTTOKEN'

observations + my opinions:

1) every name starts with an upper case letter (good) 2) format of ERC-20 type tokens xxx-20 is good as it is 3) acronyms are all uppercase like UTXO, SLP, ZHTLC (good) 4) single word full names like Matic, Ubiq, Moonriver are also good 5) multi word names: 'Ethereum Classic', 'RSK Smart Bitcoin', 'Smart Chain', are two words, but 'HecoChain', is one word in Pascal case. this is inconsistent. if there is existing code that depends on the current name 'HecoChain' (I assume there definitely is), we should make it an exception, and all future multi-word names should be two words or consider 'Ethereum Classic', 'RSK Smart Bitcoin', 'Smart Chain' as exceptions and make all future multiword names Pascal case. just have to pick one style and stick to it 6) 'TENDERMINT' should be 'Tendermint' 7) 'TENDERMINTTOKEN' should be 'TendermintToken' or 'Tendermint Token' based on the decision for multiword names from the 5th point

I'm making a webpage that displays all these names in a single spot, so found this inconsistency.

it is also ok to decide that changing any of the existing names will cause too much unnecessary work in the API/GUI codebases. then I will write some exceptions for the webpage I'm creating and normalize the naming scheme just over there

Screenshot 2023-01-11 165014

cc: @smk762 @cipig @tonymorony

smk762 commented 1 year ago

if there is existing code that depends on the current name 'HecoChain' (I assume there definitely is), we should make it an exception, and all future multi-word names should be two words

GUIs may need an update - I'm sure Desktop will, though its not a large update. Will schedule some testing this week in CLI to see how API responds to modification of these names.