@ledgerhq/live-common 25.2.0-next.0 → 25.2.0-next.1

package/src/families/cosmos/validators.ts

@@ -1,366 +1,8 @@
-import network from "../../network";
-import { log } from "@ledgerhq/logs";
-import { getEnv } from "../../env";
-import { makeLRUCache } from "../../cache";
-import type { CosmosValidatorItem, CosmosRewardsState } from "./types";
-import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { getCryptoCurrencyById } from "../../currencies";
+import { CosmosValidatorsManager } from "./CosmosValidatorsManager";
 
-const getBaseApiUrl = (currency: CryptoCurrency) => {
-  if (currency.id === "cosmos_testnet") {
-    return getEnv("API_COSMOS_TESTNET_BLOCKCHAIN_EXPLORER_API_ENDPOINT");
-  } else {
-    return getEnv("API_COSMOS_BLOCKCHAIN_EXPLORER_API_ENDPOINT");
-  }
-};
-
-const isStargate = (currency: CryptoCurrency) => {
-  if (currency.id === "cosmos_testnet") {
-    return getEnv("API_COSMOS_TESTNET_NODE") == "STARGATE_NODE";
-  } else {
-    return getEnv("API_COSMOS_NODE") == "STARGATE_NODE";
-  }
-};
-
-const namespace = "cosmos";
-const version = "v1beta1";
-const cacheValidators = makeLRUCache(
-  async (
-    rewardState: CosmosRewardsState,
-    currency: CryptoCurrency
-  ): Promise<CosmosValidatorItem[]> => {
-    if (isStargate(currency)) {
-      const url = `${getBaseApiUrl(
-        currency
-      )}/${namespace}/staking/${version}/validators?status=BOND_STATUS_BONDED&pagination.limit=175`;
-      const { data } = await network({
-        url,
-        method: "GET",
-      });
-      const validators = data.validators.map((validator) => {
-        const commission = parseFloat(
-          validator.commission.commission_rates.rate
-        );
-        return {
-          validatorAddress: validator.operator_address,
-          name: validator.description.moniker,
-          tokens: parseFloat(validator.tokens),
-          votingPower:
-            parseFloat(validator.tokens) /
-            (rewardState.actualBondedRatio * rewardState.totalSupply * 1000000),
-          commission,
-          estimatedYearlyRewardsRate: validatorEstimatedRate(
-            commission,
-            rewardState
-          ),
-        };
-      });
-      return validators;
-    } else {
-      const url = `${getBaseApiUrl(currency)}/staking/validators`;
-      const { data } = await network({
-        url,
-        method: "GET",
-      });
-      const validators = data.result.map((validator) => {
-        const commission = parseFloat(
-          validator.commission.commission_rates.rate
-        );
-        return {
-          validatorAddress: validator.operator_address,
-          name: validator.description.moniker,
-          tokens: parseFloat(validator.tokens),
-          votingPower:
-            parseFloat(validator.tokens) /
-            (rewardState.actualBondedRatio * rewardState.totalSupply * 1000000),
-          commission,
-          estimatedYearlyRewardsRate: validatorEstimatedRate(
-            commission,
-            rewardState
-          ),
-        };
-      });
-      return validators;
-    }
-  },
-  (_: CosmosRewardsState, currency: CryptoCurrency) => currency.id
-);
-export const getValidators = async (
-  currency: CryptoCurrency
-): Promise<CosmosValidatorItem[]> => {
-  if (isStargate(currency)) {
-    const rewardsState = await getStargateRewardsState(currency);
-    // validators need the rewardsState ONLY to compute voting power as
-    // percentage instead of raw uatoms amounts
-    return await cacheValidators(rewardsState, currency);
-  } else {
-    const rewardsState = await getRewardsState(currency);
-    // validators need the rewardsState ONLY to compute voting power as
-    // percentage instead of raw uatoms amounts
-    return await cacheValidators(rewardsState, currency);
-  }
-};
-
-const parseUatomStrAsAtomNumber = (uatoms: string) => {
-  return parseFloat(uatoms) / 1000000.0;
-};
-
-const getRewardsState = makeLRUCache(
-  async (currency: CryptoCurrency) => {
-    // All obtained values are strings ; so sometimes we will need to parse them as numbers
-    const inflationUrl = `${getBaseApiUrl(currency)}/minting/inflation`;
-    const { data: inflationData } = await network({
-      url: inflationUrl,
-      method: "GET",
-    });
-    const currentValueInflation = parseFloat(inflationData.result);
-    const inflationParametersUrl = `${getBaseApiUrl(
-      currency
-    )}/minting/parameters`;
-    const { data: inflationParametersData } = await network({
-      url: inflationParametersUrl,
-      method: "GET",
-    });
-    const inflationRateChange = parseFloat(
-      inflationParametersData.result.inflation_rate_change
-    );
-    const inflationMaxRate = parseFloat(
-      inflationParametersData.result.inflation_max
-    );
-    const inflationMinRate = parseFloat(
-      inflationParametersData.result.inflation_min
-    );
-    const targetBondedRatio = parseFloat(
-      inflationParametersData.result.goal_bonded
-    );
-    // Source for seconds per year : https://github.com/gavinly/CosmosParametersWiki/blob/master/Mint.md#notes-3
-    //  365.24 (days) * 24 (hours) * 60 (minutes) * 60 (seconds) = 31556736 seconds
-    const assumedTimePerBlock =
-      31556736.0 / parseFloat(inflationParametersData.result.blocks_per_year);
-    const communityTaxUrl = `${getBaseApiUrl(
-      currency
-    )}/distribution/parameters`;
-    const { data: communityTax } = await network({
-      url: communityTaxUrl,
-      method: "GET",
-    });
-    const communityPoolCommission = parseFloat(
-      communityTax.result.community_tax
-    );
-    const supplyUrl = `${getBaseApiUrl(currency)}/supply/total`;
-    const { data: totalSupplyData } = await network({
-      url: supplyUrl,
-      method: "GET",
-    });
-    const totalSupply = parseUatomStrAsAtomNumber(
-      totalSupplyData.result[0].amount
-    );
-    const ratioUrl = `${getBaseApiUrl(currency)}/staking/pool`;
-    const { data: ratioData } = await network({
-      url: ratioUrl,
-      method: "GET",
-    });
-    const actualBondedRatio =
-      parseUatomStrAsAtomNumber(ratioData.result.bonded_tokens) / totalSupply;
-    // Arbitrary value in ATOM.
-    const averageDailyFees = 20;
-    // Arbitrary value in seconds
-    const averageTimePerBlock = 7.5;
-    return {
-      targetBondedRatio,
-      communityPoolCommission,
-      assumedTimePerBlock,
-      inflationRateChange,
-      inflationMaxRate,
-      inflationMinRate,
-      actualBondedRatio,
-      averageTimePerBlock,
-      totalSupply,
-      averageDailyFees,
-      currentValueInflation,
-    };
-  },
-  (currency: CryptoCurrency) => currency.id
+const cosmosValidatorsManager = new CosmosValidatorsManager(
+  getCryptoCurrencyById("cosmos")
 );
 
-const getStargateRewardsState = makeLRUCache(
-  async (currency: CryptoCurrency) => {
-    /*
-    return {
-      targetBondedRatio: 0.01,
-      communityPoolCommission: 0.0,
-      assumedTimePerBlock: 7,
-      inflationRateChange: 0.01,
-      inflationMaxRate: 0.01,
-      inflationMinRate: 0.01,
-      actualBondedRatio: 0.01,
-      averageTimePerBlock: 7,
-      totalSupply: 0,
-      averageDailyFees: 0,
-      currentValueInflation: 0.01,
-    };
-    */
-
-    // All obtained values are strings ; so sometimes we will need to parse them as numbers
-    const inflationUrl = `${getBaseApiUrl(
-      currency
-    )}/cosmos/mint/v1beta1/inflation`;
-
-    const { data: inflationData } = await network({
-      url: inflationUrl,
-      method: "GET",
-    });
-
-    const currentValueInflation = parseFloat(inflationData.inflation);
-
-    const inflationParametersUrl = `${getBaseApiUrl(
-      currency
-    )}/cosmos/mint/v1beta1/params`;
-
-    const { data: inflationParametersData } = await network({
-      url: inflationParametersUrl,
-      method: "GET",
-    });
-
-    const inflationRateChange = parseFloat(
-      inflationParametersData.params.inflation_rate_change
-    );
-
-    const inflationMaxRate = parseFloat(
-      inflationParametersData.params.inflation_max
-    );
-
-    const inflationMinRate = parseFloat(
-      inflationParametersData.params.inflation_min
-    );
-
-    const targetBondedRatio = parseFloat(
-      inflationParametersData.params.goal_bonded
-    );
-
-    // Source for seconds per year : https://github.com/gavinly/CosmosParametersWiki/blob/master/Mint.md#notes-3
-    //  365.24 (days) * 24 (hours) * 60 (minutes) * 60 (seconds) = 31556736 seconds
-    const assumedTimePerBlock =
-      31556736.0 / parseFloat(inflationParametersData.params.blocks_per_year);
-
-    const communityTaxUrl = `${getBaseApiUrl(
-      currency
-    )}/cosmos/distribution/v1beta1/params`;
-
-    const { data: communityTax } = await network({
-      url: communityTaxUrl,
-      method: "GET",
-    });
-
-    const communityPoolCommission = parseFloat(
-      communityTax.params.community_tax
-    );
-
-    const supplyUrl = `${getBaseApiUrl(currency)}/cosmos/bank/v1beta1/supply/${
-      currency.id == "cosmos_testnet" ? "umuon" : "uatom"
-    }`;
-
-    const { data: totalSupplyData } = await network({
-      url: supplyUrl,
-      method: "GET",
-    });
-
-    const totalSupply = parseUatomStrAsAtomNumber(
-      totalSupplyData.amount.amount
-    );
-
-    const ratioUrl = `${getBaseApiUrl(currency)}/cosmos/staking/v1beta1/pool`;
-
-    const { data: ratioData } = await network({ url: ratioUrl, method: "GET" });
-
-    const actualBondedRatio =
-      parseUatomStrAsAtomNumber(ratioData.pool.bonded_tokens) / totalSupply;
-
-    // Arbitrary value in ATOM.
-    const averageDailyFees = 20;
-
-    // Arbitrary value in seconds
-    const averageTimePerBlock = 7.5;
-
-    return {
-      targetBondedRatio,
-      communityPoolCommission,
-      assumedTimePerBlock,
-      inflationRateChange,
-      inflationMaxRate,
-      inflationMinRate,
-      actualBondedRatio,
-      averageTimePerBlock,
-      totalSupply,
-      averageDailyFees,
-      currentValueInflation,
-    };
-  },
-  (currency: CryptoCurrency) => currency.id
-);
-
-const computeAvgYearlyInflation = (rewardsState: CosmosRewardsState) => {
-  // Return invalid rewardsState if
-  // rewardsState.currentValueInflation is not between inflationMinRate and inflationMaxRate
-  const inflationSlope =
-    (1 - rewardsState.actualBondedRatio / rewardsState.targetBondedRatio) *
-    rewardsState.inflationRateChange;
-  const unrestrictedEndOfYearInflation =
-    rewardsState.currentValueInflation * (1 + inflationSlope);
-
-  if (
-    unrestrictedEndOfYearInflation <= rewardsState.inflationMaxRate &&
-    unrestrictedEndOfYearInflation >= rewardsState.inflationMinRate
-  ) {
-    return (
-      (rewardsState.currentValueInflation + unrestrictedEndOfYearInflation) / 2
-    );
-  }
-
-  if (unrestrictedEndOfYearInflation > rewardsState.inflationMaxRate) {
-    const diffToMax =
-      rewardsState.inflationMaxRate - rewardsState.currentValueInflation;
-    const maxPoint = diffToMax / inflationSlope;
-    const averageInflation =
-      (1 - maxPoint / 2) * rewardsState.inflationMaxRate +
-      (maxPoint / 2) * rewardsState.currentValueInflation;
-    return averageInflation;
-  }
-
-  if (unrestrictedEndOfYearInflation < rewardsState.inflationMinRate) {
-    const diffToMin =
-      rewardsState.currentValueInflation - rewardsState.inflationMinRate;
-    const minPoint = diffToMin / inflationSlope;
-    const averageInflation =
-      (1 - minPoint / 2) * rewardsState.inflationMinRate +
-      (minPoint / 2) * rewardsState.currentValueInflation;
-    return averageInflation;
-  }
-
-  throw new Error("Unreachable code");
-};
-
-export const validatorEstimatedRate = (
-  validatorCommission: number,
-  rewardsState: CosmosRewardsState
-): number => {
-  // This correction changes how inflation is computed vs. the value the network advertises
-  const inexactBlockTimeCorrection =
-    rewardsState.assumedTimePerBlock / rewardsState.averageTimePerBlock;
-  // This correction assumes a constant bonded_ratio, this changes the yearly inflation
-  const yearlyInflation = computeAvgYearlyInflation(rewardsState);
-  // This correction adds the fees to the rate computation
-  const yearlyFeeRate =
-    (rewardsState.averageDailyFees * 365.24) / rewardsState.totalSupply;
-  return (
-    inexactBlockTimeCorrection *
-    (yearlyInflation + yearlyFeeRate) *
-    (1 / rewardsState.actualBondedRatio) *
-    (1 - rewardsState.communityPoolCommission) *
-    (1 - validatorCommission)
-  );
-};
-
-export const hydrateValidators = (validators: CosmosValidatorItem[]): void => {
-  log("cosmos/validators", "hydrate " + validators.length + " validators");
-  cacheValidators.hydrate("", validators);
-};
+export default cosmosValidatorsManager;

package/src/families/osmosis/OsmosisSupplyTypes.ts

@@ -0,0 +1,53 @@
+export type OsmosisMintParams = {
+  mint_denom: string;
+  genesis_epoch_provisions: string;
+  epoch_identifier: string;
+  reduction_period_in_epochs: string;
+  reduction_factor: string;
+  distribution_proportions: {
+    staking: string;
+    pool_incentives: string;
+    developer_rewards: string;
+    community_pool: string;
+  };
+  weighted_developer_rewards_receivers: string[];
+};
+
+export type OsmosisEpochs = {
+  epochs: [
+    {
+      identifier: string;
+      start_time: string;
+      duration: string;
+      current_epoch: string;
+      current_epoch_start_time: string;
+      epoch_counting_started: boolean;
+      current_epoch_ended: boolean;
+    }
+  ];
+};
+
+export type OsmosisEpochProvisions = {
+  epoch_provisions: string;
+};
+
+export type OsmosisTotalSupply = {
+  denom: string;
+  amount: string;
+};
+
+export type OsmosisMintingInflation = {
+  inflation: string;
+};
+
+export type OsmosisPool = {
+  not_bonded_tokens: string;
+  bonded_tokens: string;
+};
+
+export type OsmosisDistributionParams = {
+  community_tax: string;
+  base_proposer_reward: string;
+  bonus_proposer_reward: string;
+  withdraw_addr_enabled: boolean;
+};