mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-12-22 14:28:07 +00:00
429 lines
13 KiB
Python
Executable File
429 lines
13 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""Fetch information about coins and tokens supported by Trezor and update it in coins_details.json."""
|
|
import json
|
|
import logging
|
|
import os
|
|
import sys
|
|
import time
|
|
|
|
import click
|
|
import requests
|
|
|
|
import coin_info
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
OPTIONAL_KEYS = ("links", "notes", "wallet")
|
|
ALLOWED_SUPPORT_STATUS = ("yes", "no", "planned", "soon")
|
|
|
|
WALLETS = coin_info.load_json("wallets.json")
|
|
OVERRIDES = coin_info.load_json("coins_details.override.json")
|
|
VERSIONS = coin_info.latest_releases()
|
|
|
|
COINMAKETCAP_CACHE = os.path.join(os.path.dirname(__file__), "coinmarketcap.json")
|
|
COINMARKETCAP_API_BASE = "https://pro-api.coinmarketcap.com/v1/"
|
|
|
|
MARKET_CAPS = {}
|
|
|
|
# automatic wallet entries
|
|
WALLET_TREZOR = {"Trezor": "https://wallet.trezor.io"}
|
|
WALLET_TREZOR_NEXT = {"Trezor Beta": "https://beta-wallet.trezor.io/next/"}
|
|
WALLET_NEM = {"Nano Wallet": "https://nem.io/downloads/"}
|
|
|
|
WALLETS_ETH_3RDPARTY = {
|
|
"MyEtherWallet": "https://www.myetherwallet.com",
|
|
"MyCrypto": "https://mycrypto.com",
|
|
}
|
|
WALLETS_ETH_NATIVE = WALLETS_ETH_3RDPARTY.copy()
|
|
WALLETS_ETH_NATIVE.update(WALLET_TREZOR_NEXT)
|
|
|
|
|
|
TREZOR_KNOWN_URLS = (
|
|
"https://wallet.trezor.io",
|
|
"https://beta-wallet.trezor.io/next/",
|
|
"https://trezor.io/stellar/",
|
|
"https://omnitrezor.com/",
|
|
)
|
|
|
|
|
|
def coinmarketcap_call(endpoint, api_key, params=None):
|
|
url = COINMARKETCAP_API_BASE + endpoint
|
|
r = requests.get(url, params=params, headers={"X-CMC_PRO_API_KEY": api_key})
|
|
r.raise_for_status()
|
|
return r.json()
|
|
|
|
|
|
def coinmarketcap_init(api_key, refresh=None):
|
|
global MARKET_CAPS
|
|
|
|
force_refresh = refresh is True
|
|
disable_refresh = refresh is False
|
|
try:
|
|
try:
|
|
mtime = os.path.getmtime(COINMAKETCAP_CACHE)
|
|
except FileNotFoundError:
|
|
mtime = 0
|
|
cache_is_fresh = mtime > time.time() - 3600
|
|
if disable_refresh or (cache_is_fresh and not force_refresh):
|
|
print("Using cached market cap data")
|
|
with open(COINMAKETCAP_CACHE) as f:
|
|
coinmarketcap_data = json.load(f)
|
|
else:
|
|
print("Fetching market cap data")
|
|
coinmarketcap_data = coinmarketcap_call(
|
|
"cryptocurrency/listings/latest",
|
|
api_key,
|
|
params={"limit": 5000, "convert": "USD"},
|
|
)
|
|
by_id = {str(coin["id"]): coin for coin in coinmarketcap_data["data"]}
|
|
all_ids = list(by_id.keys())
|
|
while all_ids:
|
|
first_100 = all_ids[:100]
|
|
all_ids = all_ids[100:]
|
|
time.sleep(1)
|
|
print("Fetching metadata, {} coins remaining...".format(len(all_ids)))
|
|
metadata = coinmarketcap_call(
|
|
"cryptocurrency/info", api_key, params={"id": ",".join(first_100)}
|
|
)
|
|
for coin_id, meta in metadata["data"].items():
|
|
by_id[coin_id]["meta"] = meta
|
|
|
|
with open(COINMAKETCAP_CACHE, "w") as f:
|
|
json.dump(coinmarketcap_data, f)
|
|
except Exception as e:
|
|
raise RuntimeError("market cap data unavailable") from e
|
|
|
|
coin_data = {}
|
|
for coin in coinmarketcap_data["data"]:
|
|
slug = coin["slug"]
|
|
platform = coin["meta"]["platform"]
|
|
market_cap = coin["quote"]["USD"]["market_cap"]
|
|
if market_cap is not None:
|
|
coin_data[slug] = int(market_cap)
|
|
if platform is not None and platform["name"] == "Ethereum":
|
|
address = platform["token_address"].lower()
|
|
coin_data[address] = int(market_cap)
|
|
|
|
MARKET_CAPS = coin_data
|
|
|
|
return coin_data
|
|
|
|
|
|
def marketcap(coin):
|
|
cap = None
|
|
if coin["type"] == "erc20":
|
|
address = coin["address"].lower()
|
|
return MARKET_CAPS.get(address)
|
|
|
|
if "coinmarketcap_alias" in coin:
|
|
cap = MARKET_CAPS.get(coin["coinmarketcap_alias"])
|
|
if cap is None:
|
|
slug = coin["name"].replace(" ", "-").lower()
|
|
cap = MARKET_CAPS.get(slug)
|
|
if cap is None:
|
|
cap = MARKET_CAPS.get(coin["shortcut"].lower())
|
|
return cap
|
|
|
|
|
|
def update_marketcaps(coins):
|
|
for coin in coins.values():
|
|
coin["marketcap_usd"] = marketcap(coin) or 0
|
|
|
|
|
|
def summary(coins, api_key):
|
|
t1_coins = 0
|
|
t2_coins = 0
|
|
supported_marketcap = 0
|
|
for coin in coins.values():
|
|
if coin.get("hidden"):
|
|
continue
|
|
|
|
t1_enabled = coin["t1_enabled"] == "yes"
|
|
t2_enabled = coin["t2_enabled"] == "yes"
|
|
if t1_enabled:
|
|
t1_coins += 1
|
|
if t2_enabled:
|
|
t2_coins += 1
|
|
if t1_enabled or t2_enabled:
|
|
supported_marketcap += coin.get("marketcap_usd", 0)
|
|
|
|
total_marketcap = None
|
|
try:
|
|
ret = coinmarketcap_call("global-metrics/quotes/latest", api_key)
|
|
total_marketcap = int(ret["data"]["quote"]["USD"]["total_market_cap"])
|
|
except Exception:
|
|
pass
|
|
|
|
return dict(
|
|
updated_at=int(time.time()),
|
|
updated_at_readable=time.asctime(),
|
|
t1_coins=t1_coins,
|
|
t2_coins=t2_coins,
|
|
marketcap_usd=supported_marketcap,
|
|
total_marketcap_usd=total_marketcap,
|
|
marketcap_supported="{:.02f} %".format(
|
|
100 * supported_marketcap / total_marketcap
|
|
),
|
|
)
|
|
|
|
|
|
def _is_supported(support, trezor_version):
|
|
version = VERSIONS[trezor_version]
|
|
nominal = support.get(trezor_version)
|
|
if nominal is None:
|
|
return "no"
|
|
elif isinstance(nominal, bool):
|
|
return "yes" if nominal else "no"
|
|
|
|
try:
|
|
nominal_version = tuple(map(int, nominal.split(".")))
|
|
return "yes" if nominal_version <= version else "soon"
|
|
except ValueError:
|
|
return nominal
|
|
|
|
|
|
def _webwallet_support(coin, support):
|
|
"""Check the "webwallet" support property.
|
|
If set, check that at least one of the backends run on trezor.io.
|
|
If yes, assume we support the coin in our wallet.
|
|
Otherwise it's probably working with a custom backend, which means don't
|
|
link to our wallet.
|
|
"""
|
|
if not support.get("webwallet"):
|
|
return False
|
|
return any(".trezor.io" in url for url in coin["blockbook"] + coin["bitcore"])
|
|
|
|
|
|
def dict_merge(orig, new):
|
|
if isinstance(new, dict) and isinstance(orig, dict):
|
|
for k, v in new.items():
|
|
orig[k] = dict_merge(orig.get(k), v)
|
|
return orig
|
|
else:
|
|
return new
|
|
|
|
|
|
def update_simple(coins, support_info, type):
|
|
res = {}
|
|
for coin in coins:
|
|
key = coin["key"]
|
|
support = support_info[key]
|
|
|
|
details = dict(
|
|
name=coin["name"],
|
|
shortcut=coin["shortcut"],
|
|
type=type,
|
|
t1_enabled=_is_supported(support, "trezor1"),
|
|
t2_enabled=_is_supported(support, "trezor2"),
|
|
wallet={},
|
|
)
|
|
for k in OPTIONAL_KEYS:
|
|
if k in coin:
|
|
details[k] = coin[k]
|
|
|
|
details["wallet"].update(WALLETS.get(key, {}))
|
|
|
|
res[key] = details
|
|
|
|
return res
|
|
|
|
|
|
def update_bitcoin(coins, support_info):
|
|
res = update_simple(coins, support_info, "coin")
|
|
for coin in coins:
|
|
key = coin["key"]
|
|
support = support_info[key]
|
|
details = dict(
|
|
name=coin["coin_label"],
|
|
links=dict(Homepage=coin["website"], Github=coin["github"]),
|
|
wallet=WALLET_TREZOR if _webwallet_support(coin, support) else {},
|
|
)
|
|
dict_merge(res[key], details)
|
|
|
|
return res
|
|
|
|
|
|
def update_erc20(coins, networks, support_info):
|
|
# TODO skip disabled networks?
|
|
network_support = {n["chain"]: support_info.get(n["key"]) for n in networks}
|
|
network_testnets = {n["chain"] for n in networks if "Testnet" in n["name"]}
|
|
res = update_simple(coins, support_info, "erc20")
|
|
for coin in coins:
|
|
key = coin["key"]
|
|
chain = coin["chain"]
|
|
|
|
hidden = False
|
|
if chain in network_testnets:
|
|
hidden = True
|
|
if "deprecation" in coin:
|
|
hidden = True
|
|
|
|
if network_support.get(chain, {}).get("webwallet"):
|
|
wallets = WALLETS_ETH_NATIVE
|
|
else:
|
|
wallets = WALLETS_ETH_3RDPARTY
|
|
|
|
details = dict(
|
|
network=chain,
|
|
address=coin["address"],
|
|
shortcut=coin["shortcut"],
|
|
links={},
|
|
wallet=wallets,
|
|
)
|
|
if hidden:
|
|
details["hidden"] = True
|
|
if coin.get("website"):
|
|
details["links"]["Homepage"] = coin["website"]
|
|
if coin.get("social", {}).get("github"):
|
|
details["links"]["Github"] = coin["social"]["github"]
|
|
|
|
dict_merge(res[key], details)
|
|
|
|
return res
|
|
|
|
|
|
def update_ethereum_networks(coins, support_info):
|
|
res = update_simple(coins, support_info, "coin")
|
|
for coin in coins:
|
|
key = coin["key"]
|
|
if support_info[key].get("webwallet"):
|
|
wallets = WALLETS_ETH_NATIVE
|
|
else:
|
|
wallets = WALLETS_ETH_3RDPARTY
|
|
details = dict(links=dict(Homepage=coin.get("url")), wallet=wallets)
|
|
dict_merge(res[key], details)
|
|
|
|
return res
|
|
|
|
|
|
def update_nem_mosaics(coins, support_info):
|
|
res = update_simple(coins, support_info, "mosaic")
|
|
for coin in coins:
|
|
key = coin["key"]
|
|
details = dict(wallet=WALLET_NEM)
|
|
dict_merge(res[key], details)
|
|
|
|
return res
|
|
|
|
|
|
def check_missing_data(coins):
|
|
for k, coin in coins.items():
|
|
hide = False
|
|
|
|
if "Homepage" not in coin.get("links", {}):
|
|
level = logging.WARNING
|
|
if k.startswith("erc20:"):
|
|
level = logging.INFO
|
|
LOG.log(level, f"{k}: Missing homepage")
|
|
hide = True
|
|
if coin["t1_enabled"] not in ALLOWED_SUPPORT_STATUS:
|
|
LOG.warning(f"{k}: Unknown t1_enabled")
|
|
hide = True
|
|
if coin["t2_enabled"] not in ALLOWED_SUPPORT_STATUS:
|
|
LOG.warning(f"{k}: Unknown t2_enabled")
|
|
hide = True
|
|
|
|
# check wallets
|
|
for wallet in coin["wallet"]:
|
|
name = wallet.get("name")
|
|
url = wallet.get("url")
|
|
if not name or not url:
|
|
LOG.warning(f"{k}: Bad wallet entry")
|
|
hide = True
|
|
continue
|
|
if "trezor" in name.lower() and url not in TREZOR_KNOWN_URLS:
|
|
LOG.warning(f"{k}: Strange URL for Trezor Wallet")
|
|
|
|
if coin["t1_enabled"] == "no" and coin["t2_enabled"] == "no":
|
|
LOG.info(f"{k}: Coin not enabled on either device")
|
|
hide = True
|
|
|
|
if len(coin.get("wallet", [])) == 0:
|
|
LOG.debug(f"{k}: Missing wallet")
|
|
|
|
if "Testnet" in coin["name"] or "Regtest" in coin["name"]:
|
|
LOG.debug(f"{k}: Hiding testnet")
|
|
hide = True
|
|
|
|
if not hide and coin.get("hidden"):
|
|
LOG.info(f"{k}: Details are OK, but coin is still hidden")
|
|
|
|
if hide:
|
|
coin["hidden"] = 1
|
|
|
|
# summary of hidden coins
|
|
hidden_coins = [k for k, coin in coins.items() if coin.get("hidden")]
|
|
for key in hidden_coins:
|
|
del coins[key]
|
|
LOG.debug(f"{key}: Coin is hidden")
|
|
|
|
|
|
def apply_overrides(coins):
|
|
for key, override in OVERRIDES.items():
|
|
if key not in coins:
|
|
LOG.warning(f"override without coin: {key}")
|
|
continue
|
|
|
|
dict_merge(coins[key], override)
|
|
|
|
|
|
def finalize_wallets(coins):
|
|
def sort_key(w):
|
|
if "trezor.io" in w["url"]:
|
|
return 0, w["name"]
|
|
else:
|
|
return 1, w["name"]
|
|
|
|
for coin in coins.values():
|
|
wallets_list = [
|
|
dict(name=name, url=url) for name, url in coin["wallet"].items()
|
|
]
|
|
wallets_list.sort(key=sort_key)
|
|
coin["wallet"] = wallets_list
|
|
|
|
|
|
@click.command()
|
|
# fmt: off
|
|
@click.option("-r", "--refresh", "refresh", flag_value=True, default=None, help="Force refresh market cap info")
|
|
@click.option("-R", "--no-refresh", "refresh", flag_value=False, default=None, help="Force use cached market cap info")
|
|
@click.option("-A", "--api-key", required=True, envvar="COINMARKETCAP_API_KEY", help="Coinmarketcap API key")
|
|
@click.option("-v", "--verbose", is_flag=True, help="Display more info")
|
|
# fmt: on
|
|
def main(refresh, api_key, verbose):
|
|
# setup logging
|
|
log_level = logging.DEBUG if verbose else logging.WARNING
|
|
root = logging.getLogger()
|
|
root.setLevel(log_level)
|
|
handler = logging.StreamHandler(sys.stdout)
|
|
handler.setLevel(log_level)
|
|
root.addHandler(handler)
|
|
|
|
coinmarketcap_init(api_key, refresh=refresh)
|
|
|
|
defs = coin_info.coin_info()
|
|
support_info = coin_info.support_info(defs)
|
|
|
|
coins = {}
|
|
coins.update(update_bitcoin(defs.bitcoin, support_info))
|
|
coins.update(update_erc20(defs.erc20, defs.eth, support_info))
|
|
coins.update(update_ethereum_networks(defs.eth, support_info))
|
|
coins.update(update_nem_mosaics(defs.nem, support_info))
|
|
coins.update(update_simple(defs.misc, support_info, "coin"))
|
|
|
|
apply_overrides(coins)
|
|
finalize_wallets(coins)
|
|
update_marketcaps(coins)
|
|
|
|
check_missing_data(coins)
|
|
|
|
info = summary(coins, api_key)
|
|
details = dict(coins=coins, info=info)
|
|
|
|
print(json.dumps(info, sort_keys=True, indent=4))
|
|
with open(os.path.join(coin_info.DEFS_DIR, "coins_details.json"), "w") as f:
|
|
json.dump(details, f, sort_keys=True, indent=4)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|