@talismn/token-rates 3.0.15 → 3.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/token-rates",
-  "version": "3.0.15",
+  "version": "3.0.17",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -10,37 +10,41 @@
   "repository": {
     "directory": "packages/token-rates",
     "type": "git",
-    "url": "https://github.com/talismansociety/talisman.git"
+    "url": "https://github.com/TalismanSociety/talisman.git"
   },
-  "main": "dist/talismn-token-rates.cjs.js",
-  "module": "dist/talismn-token-rates.esm.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "files": [
-    "/dist"
+    "dist"
   ],
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
-    "@talismn/chaindata-provider": "1.3.4"
+    "@talismn/chaindata-provider": "1.3.6"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "eslint": "^8.57.1",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.3",
-    "@talismn/tsconfig": "0.0.3"
+    "@talismn/tsconfig": "0.0.4"
   },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@talismn/eslint-config/base"
-    ]
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "@talismn/source": "./src/index.ts",
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
   },
   "scripts": {
-    "test": "jest",
-    "lint": "eslint src --max-warnings 0",
-    "clean": "rm -rf dist .turbo node_modules"
+    "test": "vitest run",
+    "clean": "rm -rf dist .turbo node_modules",
+    "build": "tsup --silent",
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/declarations/src/TalismanTokenRatesDatabase.d.ts

@@ -1 +0,0 @@
-export declare const tryToDeleteOldTokenRatesDb: () => void;

package/dist/declarations/src/TokenRates.d.ts

@@ -1,12 +0,0 @@
-import { Token, TokenId } from "@talismn/chaindata-provider";
-import { TokenRateCurrency, TokenRatesList } from "./types";
-export declare class TokenRatesError extends Error {
-    response?: Response;
-    constructor(message: string, response?: Response);
-}
-export declare const ALL_CURRENCY_IDS: TokenRateCurrency[];
-export type CoinsApiConfig = {
-    apiUrl: string;
-};
-export declare const DEFAULT_COINSAPI_CONFIG: CoinsApiConfig;
-export declare function fetchTokenRates(tokens: Record<TokenId, Token>, currencyIds?: TokenRateCurrency[], config?: CoinsApiConfig): Promise<TokenRatesList>;

package/dist/declarations/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./TalismanTokenRatesDatabase";
-export * from "./TokenRates";
-export * from "./types";

package/dist/talismn-token-rates.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./declarations/src/index";

package/dist/talismn-token-rates.cjs.dev.js

@@ -1,259 +0,0 @@
-'use strict';
-
-var chaindataProvider = require('@talismn/chaindata-provider');
-
-const tryToDeleteOldTokenRatesDb = () => {
-  try {
-    // try and delete it if it's still there
-    indexedDB.deleteDatabase("TalismanTokenRates");
-  } catch {
-    // dont care if it fails
-  }
-};
-
-const SUPPORTED_CURRENCIES = {
-  btc: {
-    name: "Bitcoin",
-    symbol: "₿"
-  },
-  eth: {
-    name: "Ethereum",
-    symbol: "Ξ"
-  },
-  dot: {
-    name: "Polkadot",
-    symbol: "D"
-  },
-  tao: {
-    name: "Bittensor",
-    symbol: "τ"
-  },
-  usd: {
-    name: "US Dollar",
-    symbol: "$"
-  },
-  cny: {
-    name: "Chinese Yuan",
-    symbol: "¥"
-  },
-  eur: {
-    name: "Euro",
-    symbol: "€"
-  },
-  gbp: {
-    name: "British Pound",
-    symbol: "£"
-  },
-  cad: {
-    name: "Canadian Dollar",
-    symbol: "C$"
-  },
-  aud: {
-    name: "Australian Dollar",
-    symbol: "A$"
-  },
-  nzd: {
-    name: "New Zealand Dollar",
-    symbol: "NZ$"
-  },
-  jpy: {
-    name: "Japanese Yen",
-    symbol: "¥"
-  },
-  rub: {
-    name: "Russian Ruble",
-    symbol: "₽"
-  },
-  krw: {
-    name: "South Korean Won",
-    symbol: "₩"
-  },
-  idr: {
-    name: "Indonesian Rupiah",
-    symbol: "Rp"
-  },
-  php: {
-    name: "Philippine Peso",
-    symbol: "₱"
-  },
-  thb: {
-    name: "Thai Baht",
-    symbol: "฿"
-  },
-  vnd: {
-    name: "Vietnamese Dong",
-    symbol: "₫"
-  },
-  inr: {
-    name: "Indian Rupee",
-    symbol: "₹"
-  },
-  try: {
-    name: "Turkish Lira",
-    symbol: "₺"
-  },
-  // hkd: { name: "Hong Kong Dollar", symbol: "HK$" },
-  sgd: {
-    name: "Singapore Dollar",
-    symbol: "S$"
-  }
-  // twd: { name: "Taiwanese Dollar", symbol: "NT$" },
-};
-const newTokenRates = () => ({
-  btc: null,
-  eth: null,
-  dot: null,
-  tao: null,
-  usd: null,
-  cny: null,
-  eur: null,
-  gbp: null,
-  cad: null,
-  aud: null,
-  nzd: null,
-  jpy: null,
-  rub: null,
-  krw: null,
-  idr: null,
-  php: null,
-  thb: null,
-  vnd: null,
-  inr: null,
-  try: null,
-  // hkd: null,
-  sgd: null
-  // twd: null,
-});
-
-class TokenRatesError extends Error {
-  constructor(message, response) {
-    super(message);
-    this.response = response;
-  }
-}
-const ALL_CURRENCY_IDS = Object.keys(SUPPORTED_CURRENCIES);
-const DEFAULT_COINSAPI_CONFIG = {
-  apiUrl: "https://coins.talisman.xyz"
-};
-async function fetchTokenRates(tokens, currencyIds = ALL_CURRENCY_IDS, config = DEFAULT_COINSAPI_CONFIG) {
-  // create a map from `coingeckoId` -> `tokenId` for each token
-  const coingeckoIdToTokenIds = Object.values(tokens).flatMap(token => {
-    // BEGIN: LP tokens have a rate which is calculated later on, using the rates of two other tokens.
-    //
-    // This section contains the logic such that: if token is an LP token, then fetch the rates for the two underlying tokens.
-    if (token.type === "evm-uniswapv2") {
-      if (token.platform !== "ethereum") return [];
-      const getToken = (evmNetworkId, tokenAddress, coingeckoId) => ({
-        id: chaindataProvider.evmErc20TokenId(evmNetworkId, tokenAddress),
-        coingeckoId
-      });
-      const token0 = token.coingeckoId0 ? [getToken(token.networkId, token.tokenAddress0, token.coingeckoId0)] : [];
-      const token1 = token.coingeckoId1 ? [getToken(token.networkId, token.tokenAddress1, token.coingeckoId1)] : [];
-      return [...token0, ...token1];
-    }
-    // END: LP tokens have a rate which is calculated later on, using the rates of two other tokens.
-
-    // ignore tokens which don't have a coingeckoId
-    if (!token.coingeckoId) return [];
-    return [{
-      id: token.id,
-      coingeckoId: token.coingeckoId
-    }];
-  })
-
-  // get each token's coingeckoId
-  .reduce((coingeckoIdToTokenIds, {
-    id,
-    coingeckoId
-  }) => {
-    if (!coingeckoIdToTokenIds[coingeckoId]) coingeckoIdToTokenIds[coingeckoId] = [];
-    coingeckoIdToTokenIds[coingeckoId].push(id);
-    return coingeckoIdToTokenIds;
-  }, {});
-
-  // create a list of coingeckoIds we want to fetch
-  const coingeckoIds = Object.keys(coingeckoIdToTokenIds).sort();
-
-  // skip network request if there is nothing for us to fetch
-  if (coingeckoIds.length < 1) return {};
-
-  // If `currencyIds` includes `tao`, we need to always fetch the `bittensor` coingeckoId and the `usd` currency,
-  // we can use these to calculate the currency rate for TAO relative to all other tokens.
-  //
-  // We support showing balances in TAO just like we support BTC/ETH/DOT, but coingecko doesn't support TAO as a vs currency rate.
-  // We can macgyver our own TOKEN<>TAO rate by combining the TOKEN<>USD data with the TAO<>USD data.
-  const hasVsTao = currencyIds.includes("tao");
-  const [effectiveCoingeckoIds, effectiveCurrencyIds] = hasVsTao ? [[...new Set(coingeckoIds).add("bittensor")], [...new Set(
-  // don't request `tao` from coingecko (we calculate it from `usd`)
-  currencyIds.filter(c => c !== "tao"))
-  // always include `usd` (so we can calculate `tao`)
-  .add("usd")]] : [coingeckoIds, currencyIds];
-  const response = await fetch(`${config.apiUrl}/token-rates`, {
-    method: "POST",
-    body: JSON.stringify({
-      coingeckoIds: effectiveCoingeckoIds,
-      currencyIds: effectiveCurrencyIds
-    })
-  });
-  const rawTokenRates = await response.json();
-  if (hasVsTao) {
-    // calculate the TAO<>USD rate
-    const effectiveTaoIndex = effectiveCoingeckoIds.indexOf("bittensor");
-    const effectiveUsdIndex = effectiveCurrencyIds.indexOf("usd");
-    const taoUsdRate = rawTokenRates[effectiveTaoIndex]?.[effectiveUsdIndex]?.[0];
-    const taoUsdChange24h = rawTokenRates[effectiveTaoIndex]?.[effectiveUsdIndex]?.[2];
-
-    // insert TOKEN<>TAO rate (calculated based on TAO<>USD rate and TOKEN<>USD rate) into each TOKEN
-    const taoIndex = currencyIds.indexOf("tao");
-    rawTokenRates.forEach((rates, i) => {
-      // hardcoded rate for TAO<>TAO
-      if (i === effectiveTaoIndex) {
-        rates?.splice(taoIndex, 0, [1, null, null]);
-        return;
-      }
-
-      // get TOKEN<>USD rate
-      const tokenUsdRate = rates?.[effectiveUsdIndex]?.[0];
-      // calculate TOKEN<>TAO rate
-      const tokenTaoRate = typeof tokenUsdRate === "number" && typeof taoUsdRate === "number" && taoUsdRate !== 0 ? tokenUsdRate / taoUsdRate : null;
-      const tokenUsdChange24h = rates?.[effectiveUsdIndex]?.[2];
-      const tokenTaoChange24h = typeof taoUsdChange24h === "number" && typeof tokenUsdChange24h === "number" ? (1 + tokenUsdChange24h) / (1 + taoUsdChange24h) - 1 : null;
-
-      // insert at the correct location (based on the index of `tao` in `currencyIds`)
-      rates?.splice(taoIndex, 0, [tokenTaoRate, null, tokenTaoChange24h]);
-    });
-  }
-  const tokenRates = parseTokenRatesFromApi(rawTokenRates, coingeckoIds, currencyIds);
-
-  // build a TokenRatesList from the token prices result
-  const ratesList = Object.fromEntries(Object.entries(tokens).map(([tokenId, token]) => [tokenId, token.coingeckoId ? tokenRates[token.coingeckoId] ?? null : null]));
-  return ratesList;
-}
-
-// To save on bandwidth and work around response size limits, values are returned without json property names
-// (e.g. [[[12, 12332, 0.5]]] instead of { dot : {usd: { value: 12, marketCap: 12332, change24h: 0.5 }} })
-
-const parseTokenRatesFromApi = (rawTokenRates, coingeckoIds, currencyIds) => {
-  return Object.fromEntries(coingeckoIds.map((coingeckoId, idx) => {
-    const rates = rawTokenRates[idx];
-    if (!rates) return [coingeckoId, null];
-    return [coingeckoId, Object.fromEntries(currencyIds.map((currencyId, idx) => {
-      const curRate = rates[idx];
-      if (!curRate) return [currencyId, null];
-      const [price, marketCap, change24h] = rates[idx];
-      return [currencyId, {
-        price,
-        marketCap,
-        change24h
-      }];
-    }))];
-  }));
-};
-
-exports.ALL_CURRENCY_IDS = ALL_CURRENCY_IDS;
-exports.DEFAULT_COINSAPI_CONFIG = DEFAULT_COINSAPI_CONFIG;
-exports.SUPPORTED_CURRENCIES = SUPPORTED_CURRENCIES;
-exports.TokenRatesError = TokenRatesError;
-exports.fetchTokenRates = fetchTokenRates;
-exports.newTokenRates = newTokenRates;
-exports.tryToDeleteOldTokenRatesDb = tryToDeleteOldTokenRatesDb;

package/dist/talismn-token-rates.cjs.js

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === "production") {
-  module.exports = require("./talismn-token-rates.cjs.prod.js");
-} else {
-  module.exports = require("./talismn-token-rates.cjs.dev.js");
-}

package/dist/talismn-token-rates.cjs.prod.js

@@ -1,259 +0,0 @@
-'use strict';
-
-var chaindataProvider = require('@talismn/chaindata-provider');
-
-const tryToDeleteOldTokenRatesDb = () => {
-  try {
-    // try and delete it if it's still there
-    indexedDB.deleteDatabase("TalismanTokenRates");
-  } catch {
-    // dont care if it fails
-  }
-};
-
-const SUPPORTED_CURRENCIES = {
-  btc: {
-    name: "Bitcoin",
-    symbol: "₿"
-  },
-  eth: {
-    name: "Ethereum",
-    symbol: "Ξ"
-  },
-  dot: {
-    name: "Polkadot",
-    symbol: "D"
-  },
-  tao: {
-    name: "Bittensor",
-    symbol: "τ"
-  },
-  usd: {
-    name: "US Dollar",
-    symbol: "$"
-  },
-  cny: {
-    name: "Chinese Yuan",
-    symbol: "¥"
-  },
-  eur: {
-    name: "Euro",
-    symbol: "€"
-  },
-  gbp: {
-    name: "British Pound",
-    symbol: "£"
-  },
-  cad: {
-    name: "Canadian Dollar",
-    symbol: "C$"
-  },
-  aud: {
-    name: "Australian Dollar",
-    symbol: "A$"
-  },
-  nzd: {
-    name: "New Zealand Dollar",
-    symbol: "NZ$"
-  },
-  jpy: {
-    name: "Japanese Yen",
-    symbol: "¥"
-  },
-  rub: {
-    name: "Russian Ruble",
-    symbol: "₽"
-  },
-  krw: {
-    name: "South Korean Won",
-    symbol: "₩"
-  },
-  idr: {
-    name: "Indonesian Rupiah",
-    symbol: "Rp"
-  },
-  php: {
-    name: "Philippine Peso",
-    symbol: "₱"
-  },
-  thb: {
-    name: "Thai Baht",
-    symbol: "฿"
-  },
-  vnd: {
-    name: "Vietnamese Dong",
-    symbol: "₫"
-  },
-  inr: {
-    name: "Indian Rupee",
-    symbol: "₹"
-  },
-  try: {
-    name: "Turkish Lira",
-    symbol: "₺"
-  },
-  // hkd: { name: "Hong Kong Dollar", symbol: "HK$" },
-  sgd: {
-    name: "Singapore Dollar",
-    symbol: "S$"
-  }
-  // twd: { name: "Taiwanese Dollar", symbol: "NT$" },
-};
-const newTokenRates = () => ({
-  btc: null,
-  eth: null,
-  dot: null,
-  tao: null,
-  usd: null,
-  cny: null,
-  eur: null,
-  gbp: null,
-  cad: null,
-  aud: null,
-  nzd: null,
-  jpy: null,
-  rub: null,
-  krw: null,
-  idr: null,
-  php: null,
-  thb: null,
-  vnd: null,
-  inr: null,
-  try: null,
-  // hkd: null,
-  sgd: null
-  // twd: null,
-});
-
-class TokenRatesError extends Error {
-  constructor(message, response) {
-    super(message);
-    this.response = response;
-  }
-}
-const ALL_CURRENCY_IDS = Object.keys(SUPPORTED_CURRENCIES);
-const DEFAULT_COINSAPI_CONFIG = {
-  apiUrl: "https://coins.talisman.xyz"
-};
-async function fetchTokenRates(tokens, currencyIds = ALL_CURRENCY_IDS, config = DEFAULT_COINSAPI_CONFIG) {
-  // create a map from `coingeckoId` -> `tokenId` for each token
-  const coingeckoIdToTokenIds = Object.values(tokens).flatMap(token => {
-    // BEGIN: LP tokens have a rate which is calculated later on, using the rates of two other tokens.
-    //
-    // This section contains the logic such that: if token is an LP token, then fetch the rates for the two underlying tokens.
-    if (token.type === "evm-uniswapv2") {
-      if (token.platform !== "ethereum") return [];
-      const getToken = (evmNetworkId, tokenAddress, coingeckoId) => ({
-        id: chaindataProvider.evmErc20TokenId(evmNetworkId, tokenAddress),
-        coingeckoId
-      });
-      const token0 = token.coingeckoId0 ? [getToken(token.networkId, token.tokenAddress0, token.coingeckoId0)] : [];
-      const token1 = token.coingeckoId1 ? [getToken(token.networkId, token.tokenAddress1, token.coingeckoId1)] : [];
-      return [...token0, ...token1];
-    }
-    // END: LP tokens have a rate which is calculated later on, using the rates of two other tokens.
-
-    // ignore tokens which don't have a coingeckoId
-    if (!token.coingeckoId) return [];
-    return [{
-      id: token.id,
-      coingeckoId: token.coingeckoId
-    }];
-  })
-
-  // get each token's coingeckoId
-  .reduce((coingeckoIdToTokenIds, {
-    id,
-    coingeckoId
-  }) => {
-    if (!coingeckoIdToTokenIds[coingeckoId]) coingeckoIdToTokenIds[coingeckoId] = [];
-    coingeckoIdToTokenIds[coingeckoId].push(id);
-    return coingeckoIdToTokenIds;
-  }, {});
-
-  // create a list of coingeckoIds we want to fetch
-  const coingeckoIds = Object.keys(coingeckoIdToTokenIds).sort();
-
-  // skip network request if there is nothing for us to fetch
-  if (coingeckoIds.length < 1) return {};
-
-  // If `currencyIds` includes `tao`, we need to always fetch the `bittensor` coingeckoId and the `usd` currency,
-  // we can use these to calculate the currency rate for TAO relative to all other tokens.
-  //
-  // We support showing balances in TAO just like we support BTC/ETH/DOT, but coingecko doesn't support TAO as a vs currency rate.
-  // We can macgyver our own TOKEN<>TAO rate by combining the TOKEN<>USD data with the TAO<>USD data.
-  const hasVsTao = currencyIds.includes("tao");
-  const [effectiveCoingeckoIds, effectiveCurrencyIds] = hasVsTao ? [[...new Set(coingeckoIds).add("bittensor")], [...new Set(
-  // don't request `tao` from coingecko (we calculate it from `usd`)
-  currencyIds.filter(c => c !== "tao"))
-  // always include `usd` (so we can calculate `tao`)
-  .add("usd")]] : [coingeckoIds, currencyIds];
-  const response = await fetch(`${config.apiUrl}/token-rates`, {
-    method: "POST",
-    body: JSON.stringify({
-      coingeckoIds: effectiveCoingeckoIds,
-      currencyIds: effectiveCurrencyIds
-    })
-  });
-  const rawTokenRates = await response.json();
-  if (hasVsTao) {
-    // calculate the TAO<>USD rate
-    const effectiveTaoIndex = effectiveCoingeckoIds.indexOf("bittensor");
-    const effectiveUsdIndex = effectiveCurrencyIds.indexOf("usd");
-    const taoUsdRate = rawTokenRates[effectiveTaoIndex]?.[effectiveUsdIndex]?.[0];
-    const taoUsdChange24h = rawTokenRates[effectiveTaoIndex]?.[effectiveUsdIndex]?.[2];
-
-    // insert TOKEN<>TAO rate (calculated based on TAO<>USD rate and TOKEN<>USD rate) into each TOKEN
-    const taoIndex = currencyIds.indexOf("tao");
-    rawTokenRates.forEach((rates, i) => {
-      // hardcoded rate for TAO<>TAO
-      if (i === effectiveTaoIndex) {
-        rates?.splice(taoIndex, 0, [1, null, null]);
-        return;
-      }
-
-      // get TOKEN<>USD rate
-      const tokenUsdRate = rates?.[effectiveUsdIndex]?.[0];
-      // calculate TOKEN<>TAO rate
-      const tokenTaoRate = typeof tokenUsdRate === "number" && typeof taoUsdRate === "number" && taoUsdRate !== 0 ? tokenUsdRate / taoUsdRate : null;
-      const tokenUsdChange24h = rates?.[effectiveUsdIndex]?.[2];
-      const tokenTaoChange24h = typeof taoUsdChange24h === "number" && typeof tokenUsdChange24h === "number" ? (1 + tokenUsdChange24h) / (1 + taoUsdChange24h) - 1 : null;
-
-      // insert at the correct location (based on the index of `tao` in `currencyIds`)
-      rates?.splice(taoIndex, 0, [tokenTaoRate, null, tokenTaoChange24h]);
-    });
-  }
-  const tokenRates = parseTokenRatesFromApi(rawTokenRates, coingeckoIds, currencyIds);
-
-  // build a TokenRatesList from the token prices result
-  const ratesList = Object.fromEntries(Object.entries(tokens).map(([tokenId, token]) => [tokenId, token.coingeckoId ? tokenRates[token.coingeckoId] ?? null : null]));
-  return ratesList;
-}
-
-// To save on bandwidth and work around response size limits, values are returned without json property names
-// (e.g. [[[12, 12332, 0.5]]] instead of { dot : {usd: { value: 12, marketCap: 12332, change24h: 0.5 }} })
-
-const parseTokenRatesFromApi = (rawTokenRates, coingeckoIds, currencyIds) => {
-  return Object.fromEntries(coingeckoIds.map((coingeckoId, idx) => {
-    const rates = rawTokenRates[idx];
-    if (!rates) return [coingeckoId, null];
-    return [coingeckoId, Object.fromEntries(currencyIds.map((currencyId, idx) => {
-      const curRate = rates[idx];
-      if (!curRate) return [currencyId, null];
-      const [price, marketCap, change24h] = rates[idx];
-      return [currencyId, {
-        price,
-        marketCap,
-        change24h
-      }];
-    }))];
-  }));
-};
-
-exports.ALL_CURRENCY_IDS = ALL_CURRENCY_IDS;
-exports.DEFAULT_COINSAPI_CONFIG = DEFAULT_COINSAPI_CONFIG;
-exports.SUPPORTED_CURRENCIES = SUPPORTED_CURRENCIES;
-exports.TokenRatesError = TokenRatesError;
-exports.fetchTokenRates = fetchTokenRates;
-exports.newTokenRates = newTokenRates;
-exports.tryToDeleteOldTokenRatesDb = tryToDeleteOldTokenRatesDb;