Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coin naming standards and delisting process #498

Open
smk762 opened this issue Sep 30, 2022 · 7 comments
Open

Coin naming standards and delisting process #498

smk762 opened this issue Sep 30, 2022 · 7 comments

Comments

@smk762
Copy link
Collaborator

smk762 commented Sep 30, 2022

Going through the coins file, there are a few inconsistencies which could be fixed to help with future maintenance.
e.g.

  • BEP-20 (and other platform/protocols) tokens should have a -BEP20 suffix (or *-ERC20; *-SLP etc)
  • There is no consistent tagging of testnet coins. Suggest using a (test) suffix in fname.
  • Not all coins have an fname value, and there might be other entries missing standard values.
  • Due to the way the price service operates, any chars after the first - in the coin value will return the same price. For this reason, no coin should use a - in their name except to indicate it's platform/protocol. Instead, use an _. For example, a test coin named NAME on the BNB testnet would be NAME_TEST-BEP20

Changing the coin name value will be a breaking change for DEX apps which use a supplementary coins file for activation, so this update needs to be done in a carefully coordinated manner at a time where it wont impact any imminent deadlines for releases / demonstrations etc.

We're also lacking a clear delisting process / cycle. Something similar to KomodoPlatform/komodo-wallet-desktop#1993 should also be applied here.

cc: @ologunB @yurii-khi @artemii235

@smk762 smk762 changed the title Coin naming standards Coin naming standards and delisting process Sep 30, 2022
@smk762
Copy link
Collaborator Author

smk762 commented Oct 1, 2022

Coins with non-responsive electrums to be added to delisting schedule:

@michelvankessel
Copy link

USDI can be delisted. The project seems to be dead

@alamshafil
Copy link

CHUNG can be removed; development and support has been stagnant.

@smk762
Copy link
Collaborator Author

smk762 commented Feb 6, 2024

There are a few considerations which should inform the standard:

  • external API/services ticker recognition
  • Internal price service parsing
  • stats parsing
  • apps filtering
  • effects on api (if any)

Currently we use _ to deliniate the coins in a pair ('KMD_LTC'), and - o deliniate the coin ticker and its protocol `KMD-BEP20).

There are a couple of exceptions:

  • USDC-PLG20_OLD
  • DGB-segwit
  • ATOM-IBC_IRIS

Each of these adds an additional challenge to parsing a pair into its constituent coins/platforms, and ideally should be changed and similar cases avoided.

For test coins, we also have a variety of formats: MATICTEST, tBCH, AVAXT, DOC. Though less critical, it would be nice to use a consistent standard here too. The convention appears to be a t prefix, so the above would be tMATIC, tBCH, tAVAX, tDOC. This way a user knows something is a testcoin on sight.

@cipig
Copy link
Member

cipig commented Feb 7, 2024

we could also use TEST and OLD in the ticker itself... thing is that this would prevent price fetching, so if we would have done that with USDC, like USDCOLD-PLG20, this coin would not have a price... normally it's fine since OLD means "not used any more", but in this case it is not true... idk though how important this aspect is
trades with those coins would also not show up on paprika and gecko, USDC-PLG20_OLD does show up as USDC
anyway, some examples:

  • USDCOLD-PLG20
  • BTCTEST

or we put OLD and TEST in front... depends how apps sort all this coins and tokens in the "enable coin" thing
if they sort by ticker alphabetically, all TEST and OLD coins would be in one place... for TEST it would be perfect, for OLD not so

@cipig
Copy link
Member

cipig commented Mar 18, 2024

https://www.coingecko.com/en/coins/tbtc would use ticker TBTC, same as BTC testnet
i propose to rename all testnet coins to BTCTEST or TESTBTC, i prefer TESTBTC

@smk762
Copy link
Collaborator Author

smk762 commented Mar 18, 2024

a TEST prefix is preferable for simplicity of extraction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants