@ledgerhq/live-common/src/apps/support.ts

Common ground for the Ledger Live apps

import semver from "semver";
import { shouldUseTrustedInputForSegwit } from "@ledgerhq/hw-app-btc/shouldUseTrustedInputForSegwit";
import { getDependencies } from "./polyfill";
import { getEnv } from "@ledgerhq/live-env";
import { LiveConfig } from "@ledgerhq/live-config/LiveConfig";
import { DeviceModelId } from "@ledgerhq/device-management-kit";

export function shouldUpgrade(appName: string, appVersion: string): boolean {
  if (getEnv("DISABLE_APP_VERSION_REQUIREMENTS")) return false;
  const deps = getDependencies(appName);

  if (
    (deps.includes("Bitcoin") &&
      shouldUseTrustedInputForSegwit({
        name: appName,
        version: "1.4.0",
      })) ||
    appName === "Bitcoin"
  ) {
    // https://donjon.ledger.com/lsb/010/
    // the `-0` is here to allow for pre-release tags of the 1.4.0
    return !semver.satisfies(appVersion || "", ">= 1.4.0-0", {
      includePrerelease: true, // this will allow pre-release tags for higher versions (> 1.4.0)
    });
  }

  return false;
}

export function mustUpgrade(appName: string, appVersion: string): boolean {
  if (getEnv("DISABLE_APP_VERSION_REQUIREMENTS")) return false;
  // we should convert the app name to camel case and replace spaces with underscores to match the config convention in firebase
  const minVersion = LiveConfig.getValueByKey(
    `config_nanoapp_${appName.toLowerCase().replace(/ /g, "_")}`,
  )?.minVersion;
  if (minVersion) {
    // necessary when using test versions on other providers that often end up on -dev
    const appVersionCoerced = semver.coerce(appVersion);
    return !semver.gte(appVersionCoerced || "", minVersion, {
      includePrerelease: true, // this will allow pre-release tags for higher versions than the minimum one
    });
  }
  return false;
}

export function getMinVersion(appName: string, model?: DeviceModelId): string | undefined {
  if (getEnv("DISABLE_APP_VERSION_REQUIREMENTS")) {
    return undefined;
  }
  // we should convert the app name to camel case and replace spaces with underscores to match the config convention in firebase
  const config = LiveConfig.getValueByKey(
    `config_nanoapp_${appName.toLowerCase().replace(/ /g, "_")}`,
  );
  const minVersion = config?.[`${model?.toLowerCase()}MinVersion`] ?? config?.minVersion;
  return minVersion ? semver.coerce(minVersion)?.version : undefined;
}

export function getDeprecationConfig(appName: string, dependencies?: string[]) {
  const config =
    appName === "Exchange" && dependencies && dependencies.length > 0
      ? LiveConfig.getValueByKey(
          `config_nanoapp_${dependencies[0].toLowerCase().replace(/ /g, "_")}`,
        )
      : LiveConfig.getValueByKey(`config_nanoapp_${appName.toLowerCase().replace(/ /g, "_")}`);
  return config?.deviceDeprecated;
}