def print_support(coin): def support_value(where, key, missing_means_no=False): if "supported" in where and key in where["supported"]: val = where["supported"][key] if val is True: return "YES" elif val == "soon": return "SOON" elif VERSION_RE.match(val): return f"YES since {val}" else: return f"BAD VALUE {val}" elif "unsupported" in where and key in where["unsupported"]: val = where["unsupported"][key] return f"NO (reason: {val})" elif missing_means_no: return "NO" else: return "support info missing" key, name, shortcut = coin["key"], coin["name"], coin["shortcut"] print(f"{key} - {name} ({shortcut})") if coin.get("duplicate"): if coin_info.is_token(coin): print(" * DUPLICATE SYMBOL (no support)") return else: print(" * DUPLICATE SYMBOL") for dev, where in SUPPORT_INFO.items(): missing_means_no = dev in coin_info.MISSING_SUPPORT_MEANS_NO print(" *", dev, ":", support_value(where, key, missing_means_no))
def supported_on(device, coins): for coin in coins: supp = support_info[coin.key].get(device) if not supp: continue if coin_info.is_token(coin) or supp != "soon": yield coin
def clear_erc20_mixed_buckets(buckets): for bucket in buckets.values(): tokens = [coin for coin in bucket if coin_info.is_token(coin)] if tokens == bucket: continue if len(tokens) == 1: tokens[0]["duplicate"] = False
def set_support_value(key, entries, reason): """Set a support info variable. Examples: support.py set coin:BTC trezor1=soon trezor2=2.0.7 webwallet=yes connect=no support.py set coin:LTC trezor1=yes connect= Setting a variable to "yes", "true" or "1" sets support to true. Setting a variable to "no", "false" or "0" sets support to false. (or null, in case of trezor1/2) Setting variable to empty ("trezor1=") will set to null, or clear the entry. Setting to "soon", "planned", "2.1.1" etc. will set the literal string. Entries that are always present: trezor1 trezor2 webwallet connect Entries with other names will be inserted into "others". This is a good place to store links to 3rd party software, such as Electrum forks or claim tools. """ defs, _ = coin_info.coin_info_with_duplicates() coins = defs.as_dict() if key not in coins: click.echo(f"Failed to find key {key}") click.echo("Use 'support.py show' to search for the right one.") sys.exit(1) if coins[key].get("duplicate") and coin_info.is_token(coins[key]): shortcut = coins[key]["shortcut"] click.echo(f"Note: shortcut {shortcut} is a duplicate.") click.echo(f"Coin will NOT be listed regardless of support.json status.") for entry in entries: try: device, value = entry.split("=", maxsplit=1) except ValueError: click.echo(f"Invalid entry: {entry}") sys.exit(2) if device not in SUPPORT_INFO: raise click.ClickException(f"unknown device: {device}") if value in ("yes", "true", "1"): set_supported(device, key, True) elif value in ("no", "false", "0"): if device in coin_info.MISSING_SUPPORT_MEANS_NO: click.echo("Setting explicitly unsupported for {device}.") click.echo("Perhaps you meant removing support, i.e., '{device}=' ?") if not reason: reason = click.prompt(f"Enter reason for not supporting on {device}:") set_unsupported(device, key, reason) elif value == "": clear_support(device, key) else: # arbitrary string set_supported(device, key, value) print_support(coins[key]) write_support_info()
def check_dups(buckets, print_at_level=logging.ERROR): """Analyze and pretty-print results of `coin_info.mark_duplicate_shortcuts`. `print_at_level` can be one of logging levels. The results are buckets of colliding symbols. If the collision is only between ERC20 tokens, it's DEBUG. If the collision includes one non-token, it's INFO. If the collision includes more than one non-token, it's ERROR and printed always. """ def coin_str(coin): """Colorize coins. Tokens are cyan, nontokens are red. Coins that are NOT marked duplicate get a green asterisk. """ if coin_info.is_token(coin): color = "cyan" else: color = "red" highlighted = highlight_key(coin, color) if not coin.get("duplicate"): prefix = crayon("green", "*", bold=True) else: prefix = "" return "{}{}".format(prefix, highlighted) check_passed = True for symbol in sorted(buckets.keys()): bucket = buckets[symbol] if not bucket: continue nontokens = [coin for coin in bucket if not coin_info.is_token(coin)] # string generation dup_str = ", ".join(coin_str(coin) for coin in bucket) if not nontokens: level = logging.DEBUG elif len(nontokens) == 1: level = logging.INFO else: level = logging.ERROR check_passed = False # deciding whether to print if level < print_at_level: continue if symbol == "_override": print_log(level, "force-set duplicates:", dup_str) else: print_log(level, "duplicate symbol {}:".format(symbol), dup_str) return check_passed
def check_dups(buckets, print_at_level=logging.ERROR): """Analyze and pretty-print results of `coin_info.mark_duplicate_shortcuts`. `print_at_level` can be one of logging levels. The results are buckets of colliding symbols. If the collision is only between ERC20 tokens, it's DEBUG. If the collision includes one non-token, it's INFO. If the collision includes more than one non-token, it's ERROR and printed always. """ def coin_str(coin): """Colorize coins. Tokens are cyan, nontokens are red. Coins that are NOT marked duplicate get a green asterisk. """ if coin_info.is_token(coin): color = "cyan" else: color = "red" highlighted = highlight_key(coin, color) if not coin.get("duplicate"): prefix = crayon("green", "*", bold=True) else: prefix = "" return f"{prefix}{highlighted}" check_passed = True for symbol in sorted(buckets.keys()): bucket = buckets[symbol] if not bucket: continue nontokens = [coin for coin in bucket if not coin_info.is_token(coin)] # string generation dup_str = ", ".join(coin_str(coin) for coin in bucket) if not nontokens: level = logging.DEBUG elif len(nontokens) == 1: level = logging.INFO else: level = logging.ERROR check_passed = False # deciding whether to print if level < print_at_level: continue if symbol == "_override": print_log(level, "force-set duplicates:", dup_str) else: print_log(level, f"duplicate symbol {symbol}:", dup_str) return check_passed
def set_support_value(key, entries, reason): """Set a support info variable. Examples: support.py set coin:BTC trezor1=1.10.5 trezor2=2.4.7 suite=yes connect=no support.py set coin:LTC trezor1=yes connect= Setting a variable to "yes", "true" or "1" sets support to true. Setting a variable to "no", "false" or "0" sets support to false. (or null, in case of trezor1/2) Setting variable to empty ("trezor1=") will set to null, or clear the entry. Setting a variable to a particular version string (e.g., "2.4.7") will set that particular version. """ defs, _ = coin_info.coin_info_with_duplicates() coins = defs.as_dict() if key not in coins: click.echo(f"Failed to find key {key}") click.echo("Use 'support.py show' to search for the right one.") sys.exit(1) if coins[key].get("duplicate") and coin_info.is_token(coins[key]): shortcut = coins[key]["shortcut"] click.echo(f"Note: shortcut {shortcut} is a duplicate.") for entry in entries: try: device, value = entry.split("=", maxsplit=1) except ValueError: click.echo(f"Invalid entry: {entry}") sys.exit(2) if device not in SUPPORT_INFO: raise click.ClickException(f"unknown device: {device}") if value in ("yes", "true", "1"): set_supported(device, key, True) elif value in ("no", "false", "0"): if device in coin_info.MISSING_SUPPORT_MEANS_NO: click.echo(f"Setting explicitly unsupported for {device}.") click.echo(f"Perhaps you meant removing support, i.e., '{device}=' ?") if not reason: reason = click.prompt(f"Enter reason for not supporting on {device}:") set_unsupported(device, key, reason) elif value == "": clear_support(device, key) else: # arbitrary string set_supported(device, key, value) print_support(coins[key]) write_support_info()
def check(check_tokens, ignore_missing): """Check validity of support information. Ensures that `support.json` data is well formed, there are no keys without corresponding coins, and there are no coins without corresponding keys. If `--check-tokens` is specified, the check will also take into account ERC20 tokens without support info. This is disabled by default, because support info for ERC20 tokens is not strictly required. If `--ignore-missing` is specified, the check will display coins with missing support info, but will not fail when missing coins are found. This is useful in Travis. """ all_coins, buckets = coin_info.coin_info_with_duplicates() clear_erc20_mixed_buckets(buckets) coins_dict = all_coins.as_dict() checks_ok = True errors = check_support_values() if errors: for error in errors: print(error) checks_ok = False orphaned = find_orphaned_support_keys(coins_dict) for orphan in orphaned: print(f"orphaned key {orphan}") checks_ok = False missing = find_unsupported_coins(coins_dict) for device, values in missing.items(): if not check_tokens: values = [coin for coin in values if not coin_info.is_token(coin)] if values: if not ignore_missing: checks_ok = False print(f"Device {device} has missing support infos:") for coin in values: print(f"{coin['key']} - {coin['name']}") supported_dups = find_supported_duplicate_tokens(coins_dict) for key in supported_dups: coin = coins_dict[key] checks_ok = False print( f"Token {coin['key']} ({coin['name']}) is duplicate but supported") if not checks_ok: print("Some checks have failed") sys.exit(1)
def coin_str(coin): """Colorize coins. Tokens are cyan, nontokens are red. Coins that are NOT marked duplicate get a green asterisk. """ if coin_info.is_token(coin): color = "cyan" else: color = "red" highlighted = highlight_key(coin, color) if not coin.get("duplicate"): prefix = crayon("green", "*", bold=True) else: prefix = "" return "{}{}".format(prefix, highlighted)
def check(check_tokens, ignore_missing): """Check validity of support information. Ensures that `support.json` data is well formed, there are no keys without corresponding coins, and there are no coins without corresponding keys. If `--check-tokens` is specified, the check will also take into account ERC20 tokens without support info. This is disabled by default, because support info for ERC20 tokens is not strictly required. If `--ignore-missing` is specified, the check will display coins with missing support info, but will not fail when missing coins are found. This is useful in Travis. """ all_coins, _ = coin_info.coin_info_with_duplicates() coins_dict = all_coins.as_dict() checks_ok = True errors = check_support_values() if errors: for error in errors: print(error) checks_ok = False orphaned = find_orphaned_support_keys(coins_dict) for orphan in orphaned: print(f"orphaned key {orphan}") checks_ok = False missing = find_unsupported_coins(coins_dict) for device, values in missing.items(): if not check_tokens: values = [coin for coin in values if not coin_info.is_token(coin)] if values: if not ignore_missing: checks_ok = False print(f"Device {device} has missing support infos:") for coin in values: print(f"{coin['key']} - {coin['name']}") supported_dups = find_supported_duplicate_tokens(coins_dict) for key in supported_dups: coin = coins_dict[key] checks_ok = False print(f"Token {coin['key']} ({coin['name']}) is duplicate but supported") if not checks_ok: print("Some checks have failed") sys.exit(1)
def find_unsupported_coins(coins_dict): result = {} for device in coin_info.VERSIONED_SUPPORT_INFO: supported, unsupported = support_dicts(device) support_set = set(supported.keys()) support_set.update(unsupported.keys()) result[device] = [] for key, coin in coins_dict.items(): if coin.get("duplicate") and coin_info.is_token(coin): continue if key not in support_set: result[device].append(coin) return result
def coin_str(coin: Coin) -> str: """Colorize coins. Tokens are cyan, nontokens are red. Coins that are NOT marked duplicate get a green asterisk. """ prefix = "" if coin["unsupported"]: color = "grey" prefix = crayon("blue", "(X)", bold=True) elif coin_info.is_token(coin): color = "cyan" else: color = "red" if not coin.get("duplicate"): prefix = crayon("green", "*", bold=True) + prefix highlighted = highlight_key(coin, color) return f"{prefix}{highlighted}"
def process_erc20(coins_dict): """Make sure that: * orphaned ERC20 support info is cleared out * duplicate ERC20 tokens are not listed as supported * non-duplicate ERC20 tokens are cleared out from the unsupported list """ erc20_dict = { key: coin.get("duplicate", False) for key, coin in coins_dict.items() if coin_info.is_token(coin) } for device, supported, unsupported in all_support_dicts(): nondups = set() dups = set(key for key, value in erc20_dict.items() if value) for key in supported: if key not in erc20_dict: continue if not erc20_dict[key]: dups.discard(key) for key in unsupported: if key not in erc20_dict: continue # ignore dups that are unsupported now dups.discard(key) if not erc20_dict[key] and unsupported[key] == ERC20_DUPLICATE_KEY: # remove duplicate status nondups.add(key) for key in dups: if device in coin_info.MISSING_SUPPORT_MEANS_NO: clear_support(device, key) else: print(f"ERC20 on {device}: adding duplicate {key}") set_unsupported(device, key, ERC20_DUPLICATE_KEY) for key in nondups: print(f"ERC20 on {device}: clearing non-duplicate {key}") clear_support(device, key)
def release( ctx, v1, v2, dry_run, force, verbose, skip_testnets, ): """Release a new Trezor firmware. Update support infos so that all coins have a clear support status. By default, marks duplicate tokens and testnets as unsupported, and all coins that don't have support info are set to the released firmware version. The tool will ask you to confirm each added coin. ERC20 tokens are added automatically. Use `--verbose` to see them. """ latest_releases = coin_info.latest_releases() def bump_version(version_tuple): version_list = list(version_tuple) version_list[-1] += 1 return ".".join(str(n) for n in version_list) # guess `version` if not given if not v1: v1 = bump_version(latest_releases["trezor1"]) if not v2: v2 = bump_version(latest_releases["trezor2"]) versions = {"trezor1": v1, "trezor2": v2} for number in "1", "2": device = f"trezor{number}" version = versions[device] if not force and not version.startswith(number + "."): raise click.ClickException( f"Device trezor{device} should not be version {version}. " "Use --force to proceed anyway." ) print(f"Releasing {device} firmware version {version}") defs, _ = coin_info.coin_info_with_duplicates() coins_dict = defs.as_dict() # Invoke data fixup as dry-run. That will modify data internally but won't write # changes. We will write changes at the end based on our own `dry_run` value. print("Fixing up data...") ctx.invoke(fix, dry_run=True) def maybe_add(coin): add = click.confirm( f"Add missing coin {coin['key']} ({coin['name']})?", default=True ) if not add: unsupport_reason = click.prompt( "Enter reason for not supporting (blank to skip)", default="", show_default=False, ) if not unsupport_reason: return for device, version in versions.items(): if add: support_setdefault(device, coin["key"], version) else: support_setdefault(device, coin["key"], False, unsupport_reason) # process missing (not listed) supportinfos missing_list = [] unsupported = find_unsupported_coins(coins_dict) for val in unsupported.values(): for coin in val: if coin not in missing_list: missing_list.append(coin) tokens = [coin for coin in missing_list if coin_info.is_token(coin)] nontokens = [coin for coin in missing_list if not coin_info.is_token(coin)] for coin in tokens: key = coin["key"] # assert not coin.get("duplicate"), key if verbose: print(f"Adding missing {key} ({coin['name']})") for device, version in versions.items(): support_setdefault(device, key, version) for coin in nontokens: if skip_testnets and "testnet" in coin["name"].lower(): for device, version in versions.items(): support_setdefault(device, coin["key"], False, "(AUTO) exclude testnet") else: maybe_add(coin) if not dry_run: write_support_info() else: print("No changes written")
def check_dups(buckets, print_at_level=logging.WARNING): """Analyze and pretty-print results of `coin_info.mark_duplicate_shortcuts`. `print_at_level` can be one of logging levels. The results are buckets of colliding symbols. If the collision is only between ERC20 tokens, it's DEBUG. If the collision includes one non-token, it's INFO. If the collision includes more than one non-token, it's ERROR and printed always. """ def coin_str(coin): """Colorize coins. Tokens are cyan, nontokens are red. Coins that are NOT marked duplicate get a green asterisk. """ prefix = "" if coin["unsupported"]: color = "grey" prefix = crayon("blue", "(X)", bold=True) elif coin_info.is_token(coin): color = "cyan" else: color = "red" if not coin.get("duplicate"): prefix = crayon("green", "*", bold=True) + prefix highlighted = highlight_key(coin, color) return "{}{}".format(prefix, highlighted) check_passed = True for symbol in sorted(buckets.keys()): bucket = buckets[symbol] if not bucket: continue supported = [coin for coin in bucket if not coin["unsupported"]] nontokens = [ coin for coin in bucket if not coin["unsupported"] and coin.get("duplicate") and not coin_info.is_token(coin) ] # we do not count override-marked coins as duplicates here cleared = not any(coin.get("duplicate") for coin in bucket) # string generation dup_str = ", ".join(coin_str(coin) for coin in bucket) if len(nontokens) > 1: # Two or more colliding nontokens. This is always fatal. # XXX consider allowing two nontokens as long as only one is supported? level = logging.ERROR check_passed = False elif len(supported) > 1: # more than one supported coin in bucket if cleared: # some previous step has explicitly marked them as non-duplicate level = logging.INFO else: # at most 1 non-token - we tentatively allow token collisions # when explicitly marked as supported level = logging.WARNING else: # At most 1 supported coin, at most 1 non-token. This is informational only. level = logging.DEBUG # deciding whether to print if level < print_at_level: continue if symbol == "_override": print_log(level, "force-set duplicates:", dup_str) else: print_log(level, "duplicate symbol {}:".format(symbol.upper()), dup_str) return check_passed
def release( ctx, device: str, version, git_tag, release_missing, dry_run, soon, force, add_all, verbose, ): """Release a new Trezor firmware. Update support infos so that all coins have a clear support status. By default, marks duplicate tokens as unsupported, and all coins that either don't have support info, or they are supported "soon", are set to the released firmware version. Optionally tags the repository with the given version. `device` can be "1", "2", or a string matching `support.json` key. Version is autodetected by downloading a list of latest releases and incrementing micro version by one, or you can specify `--version` explicitly. Unless `--add-all` is specified, the tool will ask you to confirm each added coin. ERC20 tokens are added automatically. Use `--verbose` to see them. """ # check condition(s) if soon and git_tag: raise click.ClickException("Cannot git-tag a 'soon' revision") # process `device` if device.isnumeric(): device = f"trezor{device}" if not force and device not in coin_info.VERSIONED_SUPPORT_INFO: raise click.ClickException( f"Non-releasable device {device} (support info is not versioned). " "Use --force to proceed anyway.") if not soon: # guess `version` if not given if not version: versions = coin_info.latest_releases() latest_version = versions.get(device) if latest_version is None: raise click.ClickException( "Failed to guess version. " "Please use --version to specify it explicitly.") else: latest_version = list(latest_version) latest_version[-1] += 1 version = ".".join(str(n) for n in latest_version) # process `version` try: version_numbers = list(map(int, version.split("."))) expected_device = f"trezor{version_numbers[0]}" if not force and device != expected_device: raise click.ClickException( f"Device {device} should not be version {version}. " "Use --force to proceed anyway.") except ValueError as e: if not force: raise click.ClickException( f"Failed to parse '{version}' as a version. " "Use --force to proceed anyway.") from e if soon: version = "soon" print(f"Moving {device} missing infos to 'soon'") else: print(f"Releasing {device} firmware version {version}") defs, _ = coin_info.coin_info_with_duplicates() coins_dict = defs.as_dict() # Invoke data fixup as dry-run. That will modify data internally but won't write # changes. We will write changes at the end based on our own `dry_run` value. print("Fixing up data...") ctx.invoke(fix, dry_run=True) def maybe_add(coin, label): add = False if add_all: add = True else: text = f"Add {label} coin {coin['key']} ({coin['name']})?" add = click.confirm(text, default=True) if add: set_supported(device, coin["key"], version) # if we're releasing, process coins marked "soon" if not soon: supported, _ = support_dicts(device) soon_list = [ coins_dict[key] for key, val in supported.items() if val == "soon" and key in coins_dict ] for coin in soon_list: key = coin["key"] maybe_add(coin, "soon") # process missing (not listed) supportinfos if release_missing: missing_list = find_unsupported_coins(coins_dict)[device] tokens = [coin for coin in missing_list if coin_info.is_token(coin)] nontokens = [ coin for coin in missing_list if not coin_info.is_token(coin) ] for coin in tokens: key = coin["key"] # assert not coin.get("duplicate"), key if verbose: print(f"Adding missing {key} ({coin['name']})") set_supported(device, key, version) for coin in nontokens: maybe_add(coin, "missing") tagname = f"{device}-{version}" if git_tag: if dry_run: print(f"Would tag current commit with {tagname}") else: print(f"Tagging current commit with {tagname}") subprocess.check_call(["git", "tag", tagname]) if not dry_run: write_support_info() else: print("No changes written")
def release( ctx, device: str, version, git_tag, release_missing, dry_run, soon, force, add_all, verbose, ): """Release a new Trezor firmware. Update support infos so that all coins have a clear support status. By default, marks duplicate tokens as unsupported, and all coins that either don't have support info, or they are supported "soon", are set to the released firmware version. Optionally tags the repository with the given version. `device` can be "1", "2", or a string matching `support.json` key. Version is autodetected by downloading a list of latest releases and incrementing micro version by one, or you can specify `--version` explicitly. Unless `--add-all` is specified, the tool will ask you to confirm each added coin. ERC20 tokens are added automatically. Use `--verbose` to see them. """ # check condition(s) if soon and git_tag: raise click.ClickException("Cannot git-tag a 'soon' revision") # process `device` if device.isnumeric(): device = f"trezor{device}" if not force and device not in coin_info.VERSIONED_SUPPORT_INFO: raise click.ClickException( f"Non-releasable device {device} (support info is not versioned). " "Use --force to proceed anyway." ) if not soon: # guess `version` if not given if not version: versions = coin_info.latest_releases() latest_version = versions.get(device) if latest_version is None: raise click.ClickException( "Failed to guess version. " "Please use --version to specify it explicitly." ) else: latest_version = list(latest_version) latest_version[-1] += 1 version = ".".join(str(n) for n in latest_version) # process `version` try: version_numbers = list(map(int, version.split("."))) expected_device = f"trezor{version_numbers[0]}" if not force and device != expected_device: raise click.ClickException( f"Device {device} should not be version {version}. " "Use --force to proceed anyway." ) except ValueError as e: if not force: raise click.ClickException( f"Failed to parse '{version}' as a version. " "Use --force to proceed anyway." ) from e if soon: version = "soon" print(f"Moving {device} missing infos to 'soon'") else: print(f"Releasing {device} firmware version {version}") defs, _ = coin_info.coin_info_with_duplicates() coins_dict = defs.as_dict() # Invoke data fixup as dry-run. That will modify data internally but won't write # changes. We will write changes at the end based on our own `dry_run` value. print("Fixing up data...") ctx.invoke(fix, dry_run=True) def maybe_add(coin, label): add = False if add_all: add = True else: text = f"Add {label} coin {coin['key']} ({coin['name']})?" add = click.confirm(text, default=True) if add: set_supported(device, coin["key"], version) # if we're releasing, process coins marked "soon" if not soon: supported, _ = support_dicts(device) soon_list = [ coins_dict[key] for key, val in supported.items() if val == "soon" and key in coins_dict ] for coin in soon_list: key = coin["key"] maybe_add(coin, "soon") # process missing (not listed) supportinfos if release_missing: missing_list = find_unsupported_coins(coins_dict)[device] tokens = [coin for coin in missing_list if coin_info.is_token(coin)] nontokens = [coin for coin in missing_list if not coin_info.is_token(coin)] for coin in tokens: key = coin["key"] assert not coin.get("duplicate") if verbose: print(f"Adding missing {key} ({coin['name']})") set_supported(device, key, version) for coin in nontokens: maybe_add(coin, "missing") tagname = f"{device}-{version}" if git_tag: if dry_run: print(f"Would tag current commit with {tagname}") else: print(f"Tagging current commit with {tagname}") subprocess.check_call(["git", "tag", tagname]) if not dry_run: write_support_info() else: print("No changes written")