@talismn/token-rates 1.0.4 → 2.0.1

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

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

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

@@ -135,19 +135,11 @@ class TokenRatesError extends Error {
     this.response = response;
   }
 }
-
-// every currency in this list will be fetched from coingecko
-// comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = Object.keys(SUPPORTED_CURRENCIES);
-// api returns a 414 error if the url is too long, max length is about 8100 characters
-// so use 7900 to be safe
-const MAX_COINGECKO_URL_LENGTH = 7900;
-const DEFAULT_COINGECKO_CONFIG = {
-  apiUrl: "https://api.coingecko.com"
+const ALL_CURRENCY_IDS = Object.keys(SUPPORTED_CURRENCIES);
+const DEFAULT_COINSAPI_CONFIG = {
+  apiUrl: "https://coins.talisman.xyz"
 };
-
-// export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
+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)
   // ignore testnet tokens
@@ -192,56 +184,18 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
-
-  // construct a coingecko request, sort args to help proxies with caching
-
-  const currenciesSerialized = coingeckoCurrencies.sort().join(",");
-  const safelyGetCoingeckoUrls = coingeckoIds => {
-    const idsSerialized = coingeckoIds.join(",");
-    const queryUrl = `${config.apiUrl}/api/v3/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}&include_market_cap=true&include_24hr_change=true`;
-    if (queryUrl.length > MAX_COINGECKO_URL_LENGTH) {
-      const half = Math.floor(coingeckoIds.length / 2);
-      return [...safelyGetCoingeckoUrls(coingeckoIds.slice(0, half)), ...safelyGetCoingeckoUrls(coingeckoIds.slice(half))];
-    }
-    return [queryUrl];
-  };
-
-  // fetch the token prices from coingecko
-  // the response should be in the format:
-  // {
-  //   [coingeckoId]: {
-  //     [currency]: rate
-  //     [currency_24h_change]: percent
-  //     [currency_market_cap]: value
-  //   }
-  // }
-
-  const coingeckoHeaders = new Headers();
-  if (config.apiKeyName && config.apiKeyValue) {
-    coingeckoHeaders.set(config.apiKeyName, config.apiKeyValue);
-  }
-  const coingeckoPrices = await Promise.all(safelyGetCoingeckoUrls(coingeckoIds).map(async queryUrl => await fetch(queryUrl, {
-    headers: coingeckoHeaders
-  }).then(response => {
-    if (response.status !== 200) throw new TokenRatesError(`Failed to fetch token rates`, response);
-    return response.json();
-  }))).then(responses => Object.assign({}, ...responses));
+  const response = await fetch(`${config.apiUrl}/token-rates`, {
+    method: "POST",
+    body: JSON.stringify({
+      coingeckoIds,
+      currencyIds
+    })
+  });
+  const rawTokenRates = await response.json();
+  const tokenRates = parseTokenRatesFromApi(rawTokenRates, coingeckoIds, currencyIds);
 
   // build a TokenRatesList from the token prices result
-  const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
-    const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = newTokenRates();
-    for (const currency of coingeckoCurrencies) {
-      if (coingeckoPrices[coingeckoId]?.[currency]) rates[currency] = {
-        price: coingeckoPrices[coingeckoId][currency],
-        marketCap: coingeckoPrices[coingeckoId][`${currency}_market_cap`],
-        change24h: coingeckoPrices[coingeckoId][`${currency}_24h_change`]
-      };
-    }
-    return tokenIds.map(tokenId => [tokenId, rates]);
-  }));
-
-  // return the TokenRatesList
+  const ratesList = Object.fromEntries(Object.entries(tokens).map(([tokenId, token]) => [tokenId, token.coingeckoId ? tokenRates[token.coingeckoId] ?? null : null]));
   return ratesList;
 }
 
@@ -249,7 +203,28 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 // We can't import this directly from EvmErc20Module because this package doesn't depend on `@talismn/balances`
 const evmErc20TokenId = (chainId, tokenContractAddress) => `${chainId}-evm-erc20-${tokenContractAddress}`.toLowerCase();
 
-exports.DEFAULT_COINGECKO_CONFIG = DEFAULT_COINGECKO_CONFIG;
+// 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.TalismanTokenRatesDatabase = TalismanTokenRatesDatabase;
 exports.TokenRatesError = TokenRatesError;

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

@@ -135,19 +135,11 @@ class TokenRatesError extends Error {
     this.response = response;
   }
 }
-
-// every currency in this list will be fetched from coingecko
-// comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = Object.keys(SUPPORTED_CURRENCIES);
-// api returns a 414 error if the url is too long, max length is about 8100 characters
-// so use 7900 to be safe
-const MAX_COINGECKO_URL_LENGTH = 7900;
-const DEFAULT_COINGECKO_CONFIG = {
-  apiUrl: "https://api.coingecko.com"
+const ALL_CURRENCY_IDS = Object.keys(SUPPORTED_CURRENCIES);
+const DEFAULT_COINSAPI_CONFIG = {
+  apiUrl: "https://coins.talisman.xyz"
 };
-
-// export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
+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)
   // ignore testnet tokens
@@ -192,56 +184,18 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
-
-  // construct a coingecko request, sort args to help proxies with caching
-
-  const currenciesSerialized = coingeckoCurrencies.sort().join(",");
-  const safelyGetCoingeckoUrls = coingeckoIds => {
-    const idsSerialized = coingeckoIds.join(",");
-    const queryUrl = `${config.apiUrl}/api/v3/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}&include_market_cap=true&include_24hr_change=true`;
-    if (queryUrl.length > MAX_COINGECKO_URL_LENGTH) {
-      const half = Math.floor(coingeckoIds.length / 2);
-      return [...safelyGetCoingeckoUrls(coingeckoIds.slice(0, half)), ...safelyGetCoingeckoUrls(coingeckoIds.slice(half))];
-    }
-    return [queryUrl];
-  };
-
-  // fetch the token prices from coingecko
-  // the response should be in the format:
-  // {
-  //   [coingeckoId]: {
-  //     [currency]: rate
-  //     [currency_24h_change]: percent
-  //     [currency_market_cap]: value
-  //   }
-  // }
-
-  const coingeckoHeaders = new Headers();
-  if (config.apiKeyName && config.apiKeyValue) {
-    coingeckoHeaders.set(config.apiKeyName, config.apiKeyValue);
-  }
-  const coingeckoPrices = await Promise.all(safelyGetCoingeckoUrls(coingeckoIds).map(async queryUrl => await fetch(queryUrl, {
-    headers: coingeckoHeaders
-  }).then(response => {
-    if (response.status !== 200) throw new TokenRatesError(`Failed to fetch token rates`, response);
-    return response.json();
-  }))).then(responses => Object.assign({}, ...responses));
+  const response = await fetch(`${config.apiUrl}/token-rates`, {
+    method: "POST",
+    body: JSON.stringify({
+      coingeckoIds,
+      currencyIds
+    })
+  });
+  const rawTokenRates = await response.json();
+  const tokenRates = parseTokenRatesFromApi(rawTokenRates, coingeckoIds, currencyIds);
 
   // build a TokenRatesList from the token prices result
-  const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
-    const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = newTokenRates();
-    for (const currency of coingeckoCurrencies) {
-      if (coingeckoPrices[coingeckoId]?.[currency]) rates[currency] = {
-        price: coingeckoPrices[coingeckoId][currency],
-        marketCap: coingeckoPrices[coingeckoId][`${currency}_market_cap`],
-        change24h: coingeckoPrices[coingeckoId][`${currency}_24h_change`]
-      };
-    }
-    return tokenIds.map(tokenId => [tokenId, rates]);
-  }));
-
-  // return the TokenRatesList
+  const ratesList = Object.fromEntries(Object.entries(tokens).map(([tokenId, token]) => [tokenId, token.coingeckoId ? tokenRates[token.coingeckoId] ?? null : null]));
   return ratesList;
 }
 
@@ -249,7 +203,28 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 // We can't import this directly from EvmErc20Module because this package doesn't depend on `@talismn/balances`
 const evmErc20TokenId = (chainId, tokenContractAddress) => `${chainId}-evm-erc20-${tokenContractAddress}`.toLowerCase();
 
-exports.DEFAULT_COINGECKO_CONFIG = DEFAULT_COINGECKO_CONFIG;
+// 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.TalismanTokenRatesDatabase = TalismanTokenRatesDatabase;
 exports.TokenRatesError = TokenRatesError;

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

@@ -133,19 +133,11 @@ class TokenRatesError extends Error {
     this.response = response;
   }
 }
-
-// every currency in this list will be fetched from coingecko
-// comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = Object.keys(SUPPORTED_CURRENCIES);
-// api returns a 414 error if the url is too long, max length is about 8100 characters
-// so use 7900 to be safe
-const MAX_COINGECKO_URL_LENGTH = 7900;
-const DEFAULT_COINGECKO_CONFIG = {
-  apiUrl: "https://api.coingecko.com"
+const ALL_CURRENCY_IDS = Object.keys(SUPPORTED_CURRENCIES);
+const DEFAULT_COINSAPI_CONFIG = {
+  apiUrl: "https://coins.talisman.xyz"
 };
-
-// export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
+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)
   // ignore testnet tokens
@@ -190,56 +182,18 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
-
-  // construct a coingecko request, sort args to help proxies with caching
-
-  const currenciesSerialized = coingeckoCurrencies.sort().join(",");
-  const safelyGetCoingeckoUrls = coingeckoIds => {
-    const idsSerialized = coingeckoIds.join(",");
-    const queryUrl = `${config.apiUrl}/api/v3/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}&include_market_cap=true&include_24hr_change=true`;
-    if (queryUrl.length > MAX_COINGECKO_URL_LENGTH) {
-      const half = Math.floor(coingeckoIds.length / 2);
-      return [...safelyGetCoingeckoUrls(coingeckoIds.slice(0, half)), ...safelyGetCoingeckoUrls(coingeckoIds.slice(half))];
-    }
-    return [queryUrl];
-  };
-
-  // fetch the token prices from coingecko
-  // the response should be in the format:
-  // {
-  //   [coingeckoId]: {
-  //     [currency]: rate
-  //     [currency_24h_change]: percent
-  //     [currency_market_cap]: value
-  //   }
-  // }
-
-  const coingeckoHeaders = new Headers();
-  if (config.apiKeyName && config.apiKeyValue) {
-    coingeckoHeaders.set(config.apiKeyName, config.apiKeyValue);
-  }
-  const coingeckoPrices = await Promise.all(safelyGetCoingeckoUrls(coingeckoIds).map(async queryUrl => await fetch(queryUrl, {
-    headers: coingeckoHeaders
-  }).then(response => {
-    if (response.status !== 200) throw new TokenRatesError(`Failed to fetch token rates`, response);
-    return response.json();
-  }))).then(responses => Object.assign({}, ...responses));
+  const response = await fetch(`${config.apiUrl}/token-rates`, {
+    method: "POST",
+    body: JSON.stringify({
+      coingeckoIds,
+      currencyIds
+    })
+  });
+  const rawTokenRates = await response.json();
+  const tokenRates = parseTokenRatesFromApi(rawTokenRates, coingeckoIds, currencyIds);
 
   // build a TokenRatesList from the token prices result
-  const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
-    const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = newTokenRates();
-    for (const currency of coingeckoCurrencies) {
-      if (coingeckoPrices[coingeckoId]?.[currency]) rates[currency] = {
-        price: coingeckoPrices[coingeckoId][currency],
-        marketCap: coingeckoPrices[coingeckoId][`${currency}_market_cap`],
-        change24h: coingeckoPrices[coingeckoId][`${currency}_24h_change`]
-      };
-    }
-    return tokenIds.map(tokenId => [tokenId, rates]);
-  }));
-
-  // return the TokenRatesList
+  const ratesList = Object.fromEntries(Object.entries(tokens).map(([tokenId, token]) => [tokenId, token.coingeckoId ? tokenRates[token.coingeckoId] ?? null : null]));
   return ratesList;
 }
 
@@ -247,4 +201,24 @@ async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
 // We can't import this directly from EvmErc20Module because this package doesn't depend on `@talismn/balances`
 const evmErc20TokenId = (chainId, tokenContractAddress) => `${chainId}-evm-erc20-${tokenContractAddress}`.toLowerCase();
 
-export { DEFAULT_COINGECKO_CONFIG, SUPPORTED_CURRENCIES, TalismanTokenRatesDatabase, TokenRatesError, db, fetchTokenRates, newTokenRates };
+// 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
+      }];
+    }))];
+  }));
+};
+
+export { ALL_CURRENCY_IDS, DEFAULT_COINSAPI_CONFIG, SUPPORTED_CURRENCIES, TalismanTokenRatesDatabase, TokenRatesError, db, fetchTokenRates, newTokenRates };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/token-rates",
-  "version": "1.0.4",
+  "version": "2.0.1",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "dexie": "^4.0.9",
-    "@talismn/chaindata-provider": "0.8.4"
+    "@talismn/chaindata-provider": "0.10.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
@@ -30,8 +30,8 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.3",
-    "@talismn/tsconfig": "0.0.2"
+    "@talismn/tsconfig": "0.0.2",
+    "@talismn/eslint-config": "0.0.3"
   },
   "eslintConfig": {
     "root": true,