@talismn/token-rates 0.2.0 → 1.0.0

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

@@ -1,7 +1,13 @@
-import { IToken, TokenId } from "@talismn/chaindata-provider";
+import { Token, TokenId } from "@talismn/chaindata-provider";
 import { TokenRatesList } from "./types";
-export declare function fetchTokenRates(tokens: Record<TokenId, IToken>): Promise<TokenRatesList>;
-export interface WithCoingeckoId {
-    coingeckoId: string;
+export declare class TokenRatesError extends Error {
+    response?: Response;
+    constructor(message: string, response?: Response);
 }
-export declare function hasCoingeckoId(token: IToken): token is IToken & WithCoingeckoId;
+export type CoingeckoConfig = {
+    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>;

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

@@ -1,36 +1,96 @@
 import { TokenId } from "@talismn/chaindata-provider";
+export declare const SUPPORTED_CURRENCIES: {
+    readonly btc: {
+        readonly name: "Bitcoin";
+        readonly symbol: "₿";
+    };
+    readonly eth: {
+        readonly name: "Ethereum";
+        readonly symbol: "Ξ";
+    };
+    readonly dot: {
+        readonly name: "Polkadot";
+        readonly symbol: "D";
+    };
+    readonly usd: {
+        readonly name: "US Dollar";
+        readonly symbol: "$";
+    };
+    readonly cny: {
+        readonly name: "Chinese Yuan";
+        readonly symbol: "¥";
+    };
+    readonly eur: {
+        readonly name: "Euro";
+        readonly symbol: "€";
+    };
+    readonly gbp: {
+        readonly name: "British Pound";
+        readonly symbol: "£";
+    };
+    readonly cad: {
+        readonly name: "Canadian Dollar";
+        readonly symbol: "C$";
+    };
+    readonly aud: {
+        readonly name: "Australian Dollar";
+        readonly symbol: "A$";
+    };
+    readonly nzd: {
+        readonly name: "New Zealand Dollar";
+        readonly symbol: "NZ$";
+    };
+    readonly jpy: {
+        readonly name: "Japanese Yen";
+        readonly symbol: "¥";
+    };
+    readonly rub: {
+        readonly name: "Russian Ruble";
+        readonly symbol: "₽";
+    };
+    readonly krw: {
+        readonly name: "South Korean Won";
+        readonly symbol: "₩";
+    };
+    readonly idr: {
+        readonly name: "Indonesian Rupiah";
+        readonly symbol: "Rp";
+    };
+    readonly php: {
+        readonly name: "Philippine Peso";
+        readonly symbol: "₱";
+    };
+    readonly thb: {
+        readonly name: "Thai Baht";
+        readonly symbol: "฿";
+    };
+    readonly vnd: {
+        readonly name: "Vietnamese Dong";
+        readonly symbol: "₫";
+    };
+    readonly inr: {
+        readonly name: "Indian Rupee";
+        readonly symbol: "₹";
+    };
+    readonly try: {
+        readonly name: "Turkish Lira";
+        readonly symbol: "₺";
+    };
+    readonly sgd: {
+        readonly name: "Singapore Dollar";
+        readonly symbol: "S$";
+    };
+};
+export type TokenRateCurrency = keyof typeof SUPPORTED_CURRENCIES;
+export type TokenRateData = {
+    price: number;
+    marketCap?: number;
+    change24h?: number;
+};
+export type TokenRates = Record<TokenRateCurrency, TokenRateData | null>;
 export type TokenRatesList = Record<TokenId, TokenRates>;
-export type TokenRateCurrency = keyof TokenRates;
 export type DbTokenRates = {
     tokenId: TokenId;
     rates: TokenRates;
 };
-export type TokenRates = {
-    /** us dollar rate */
-    usd: number | null;
-    /** australian dollar rate */
-    aud: number | null;
-    /** new zealand dollar rate */
-    nzd: number | null;
-    /** canadian dollar rate */
-    cud: number | null;
-    /** hong kong dollar rate */
-    hkd: number | null;
-    /** euro rate */
-    eur: number | null;
-    /** british pound sterling rate */
-    gbp: number | null;
-    /** japanese yen rate */
-    jpy: number | null;
-    /** south korean won rate */
-    krw: number | null;
-    /** chinese yuan rate */
-    cny: number | null;
-    /** btc rate */
-    btc: number | null;
-    /** eth rate */
-    eth: number | null;
-    /** dot rate */
-    dot: number | null;
-};
-export declare const NewTokenRates: () => TokenRates;
+export declare const newTokenRates: () => TokenRates;

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

@@ -1,13 +1,6 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var dexie = require('dexie');
-var axios = require('axios');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
-
-var axios__default = /*#__PURE__*/_interopDefault(axios);
 
 class TalismanTokenRatesDatabase extends dexie.Dexie {
   constructor() {
@@ -23,60 +16,166 @@ class TalismanTokenRatesDatabase extends dexie.Dexie {
       // https://dexie.org/docs/Version/Version.stores()#warning
       tokenRates: "tokenId"
     });
-
-    // this.on("ready", async () => {})
   }
 }
-
 const db = new TalismanTokenRatesDatabase();
 
-const NewTokenRates = () => ({
+const SUPPORTED_CURRENCIES = {
+  btc: {
+    name: "Bitcoin",
+    symbol: "₿"
+  },
+  eth: {
+    name: "Ethereum",
+    symbol: "Ξ"
+  },
+  dot: {
+    name: "Polkadot",
+    symbol: "D"
+  },
+  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,
   usd: null,
-  aud: null,
-  nzd: null,
-  cud: null,
-  hkd: null,
+  cny: null,
   eur: null,
   gbp: null,
+  cad: null,
+  aud: null,
+  nzd: null,
   jpy: null,
+  rub: null,
   krw: null,
-  cny: null,
-  btc: null,
-  eth: null,
-  dot: null
+  idr: null,
+  php: null,
+  thb: null,
+  vnd: null,
+  inr: null,
+  try: null,
+  // hkd: null,
+  sgd: null
+  // twd: null,
 });
 
-// the base url of the v3 coingecko api
-const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+class TokenRatesError extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+  }
+}
 
 // every currency in this list will be fetched from coingecko
 // comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = ["usd",
-// 'aud',
-// 'nzd',
-// 'cud',
-// 'hkd',
-"eur"
-// 'gbp',
-// 'jpy',
-// 'krw',
-// 'cny',
-// 'btc',
-// 'eth',
-// 'dot',
-];
+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"
+};
 
 // export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens) {
+async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
   // create a map from `coingeckoId` -> `tokenId` for each token
   const coingeckoIdToTokenIds = Object.values(tokens)
   // ignore testnet tokens
   .filter(({
     isTestnet
-  }) => !isTestnet)
+  }) => !isTestnet).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.evmNetwork) return [];
+      const getToken = (evmNetworkId, tokenAddress, coingeckoId) => ({
+        id: evmErc20TokenId(evmNetworkId, tokenAddress),
+        coingeckoId
+      });
+      const token0 = token.coingeckoId0 ? [getToken(token.evmNetwork.id, token.tokenAddress0, token.coingeckoId0)] : [];
+      const token1 = token.coingeckoId1 ? [getToken(token.evmNetwork.id, 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
-  .filter(hasCoingeckoId)
+    // 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, {
@@ -89,31 +188,55 @@ async function fetchTokenRates(tokens) {
   }, {});
 
   // create a list of coingeckoIds we want to fetch
-  const coingeckoIds = Object.keys(coingeckoIdToTokenIds);
+  const coingeckoIds = Object.keys(coingeckoIdToTokenIds).sort();
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
 
-  // construct a coingecko request
-  const idsSerialized = coingeckoIds.join(",");
-  const currenciesSerialized = coingeckoCurrencies.join(",");
-  const queryUrl = `${coingeckoApiUrl}/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}`;
+  // 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 coingeckoPrices = await axios__default["default"].get(queryUrl).then(response => response.data);
+
+  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));
 
   // build a TokenRatesList from the token prices result
   const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
     const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = NewTokenRates();
+    const rates = newTokenRates();
     for (const currency of coingeckoCurrencies) {
-      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+      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]);
   }));
@@ -121,12 +244,15 @@ async function fetchTokenRates(tokens) {
   // return the TokenRatesList
   return ratesList;
 }
-function hasCoingeckoId(token) {
-  return "coingeckoId" in token && typeof token.coingeckoId === "string";
-}
 
-exports.NewTokenRates = NewTokenRates;
+// TODO: Move this into a common module which can then be imported both here and into EvmErc20Module
+// 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;
+exports.SUPPORTED_CURRENCIES = SUPPORTED_CURRENCIES;
 exports.TalismanTokenRatesDatabase = TalismanTokenRatesDatabase;
+exports.TokenRatesError = TokenRatesError;
 exports.db = db;
 exports.fetchTokenRates = fetchTokenRates;
-exports.hasCoingeckoId = hasCoingeckoId;
+exports.newTokenRates = newTokenRates;

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

@@ -1,13 +1,6 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var dexie = require('dexie');
-var axios = require('axios');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
-
-var axios__default = /*#__PURE__*/_interopDefault(axios);
 
 class TalismanTokenRatesDatabase extends dexie.Dexie {
   constructor() {
@@ -23,60 +16,166 @@ class TalismanTokenRatesDatabase extends dexie.Dexie {
       // https://dexie.org/docs/Version/Version.stores()#warning
       tokenRates: "tokenId"
     });
-
-    // this.on("ready", async () => {})
   }
 }
-
 const db = new TalismanTokenRatesDatabase();
 
-const NewTokenRates = () => ({
+const SUPPORTED_CURRENCIES = {
+  btc: {
+    name: "Bitcoin",
+    symbol: "₿"
+  },
+  eth: {
+    name: "Ethereum",
+    symbol: "Ξ"
+  },
+  dot: {
+    name: "Polkadot",
+    symbol: "D"
+  },
+  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,
   usd: null,
-  aud: null,
-  nzd: null,
-  cud: null,
-  hkd: null,
+  cny: null,
   eur: null,
   gbp: null,
+  cad: null,
+  aud: null,
+  nzd: null,
   jpy: null,
+  rub: null,
   krw: null,
-  cny: null,
-  btc: null,
-  eth: null,
-  dot: null
+  idr: null,
+  php: null,
+  thb: null,
+  vnd: null,
+  inr: null,
+  try: null,
+  // hkd: null,
+  sgd: null
+  // twd: null,
 });
 
-// the base url of the v3 coingecko api
-const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+class TokenRatesError extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+  }
+}
 
 // every currency in this list will be fetched from coingecko
 // comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = ["usd",
-// 'aud',
-// 'nzd',
-// 'cud',
-// 'hkd',
-"eur"
-// 'gbp',
-// 'jpy',
-// 'krw',
-// 'cny',
-// 'btc',
-// 'eth',
-// 'dot',
-];
+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"
+};
 
 // export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens) {
+async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
   // create a map from `coingeckoId` -> `tokenId` for each token
   const coingeckoIdToTokenIds = Object.values(tokens)
   // ignore testnet tokens
   .filter(({
     isTestnet
-  }) => !isTestnet)
+  }) => !isTestnet).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.evmNetwork) return [];
+      const getToken = (evmNetworkId, tokenAddress, coingeckoId) => ({
+        id: evmErc20TokenId(evmNetworkId, tokenAddress),
+        coingeckoId
+      });
+      const token0 = token.coingeckoId0 ? [getToken(token.evmNetwork.id, token.tokenAddress0, token.coingeckoId0)] : [];
+      const token1 = token.coingeckoId1 ? [getToken(token.evmNetwork.id, 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
-  .filter(hasCoingeckoId)
+    // 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, {
@@ -89,31 +188,55 @@ async function fetchTokenRates(tokens) {
   }, {});
 
   // create a list of coingeckoIds we want to fetch
-  const coingeckoIds = Object.keys(coingeckoIdToTokenIds);
+  const coingeckoIds = Object.keys(coingeckoIdToTokenIds).sort();
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
 
-  // construct a coingecko request
-  const idsSerialized = coingeckoIds.join(",");
-  const currenciesSerialized = coingeckoCurrencies.join(",");
-  const queryUrl = `${coingeckoApiUrl}/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}`;
+  // 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 coingeckoPrices = await axios__default["default"].get(queryUrl).then(response => response.data);
+
+  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));
 
   // build a TokenRatesList from the token prices result
   const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
     const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = NewTokenRates();
+    const rates = newTokenRates();
     for (const currency of coingeckoCurrencies) {
-      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+      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]);
   }));
@@ -121,12 +244,15 @@ async function fetchTokenRates(tokens) {
   // return the TokenRatesList
   return ratesList;
 }
-function hasCoingeckoId(token) {
-  return "coingeckoId" in token && typeof token.coingeckoId === "string";
-}
 
-exports.NewTokenRates = NewTokenRates;
+// TODO: Move this into a common module which can then be imported both here and into EvmErc20Module
+// 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;
+exports.SUPPORTED_CURRENCIES = SUPPORTED_CURRENCIES;
 exports.TalismanTokenRatesDatabase = TalismanTokenRatesDatabase;
+exports.TokenRatesError = TokenRatesError;
 exports.db = db;
 exports.fetchTokenRates = fetchTokenRates;
-exports.hasCoingeckoId = hasCoingeckoId;
+exports.newTokenRates = newTokenRates;

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

@@ -1,5 +1,4 @@
 import { Dexie } from 'dexie';
-import axios from 'axios';
 
 class TalismanTokenRatesDatabase extends Dexie {
   constructor() {
@@ -15,60 +14,166 @@ class TalismanTokenRatesDatabase extends Dexie {
       // https://dexie.org/docs/Version/Version.stores()#warning
       tokenRates: "tokenId"
     });
-
-    // this.on("ready", async () => {})
   }
 }
-
 const db = new TalismanTokenRatesDatabase();
 
-const NewTokenRates = () => ({
+const SUPPORTED_CURRENCIES = {
+  btc: {
+    name: "Bitcoin",
+    symbol: "₿"
+  },
+  eth: {
+    name: "Ethereum",
+    symbol: "Ξ"
+  },
+  dot: {
+    name: "Polkadot",
+    symbol: "D"
+  },
+  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,
   usd: null,
-  aud: null,
-  nzd: null,
-  cud: null,
-  hkd: null,
+  cny: null,
   eur: null,
   gbp: null,
+  cad: null,
+  aud: null,
+  nzd: null,
   jpy: null,
+  rub: null,
   krw: null,
-  cny: null,
-  btc: null,
-  eth: null,
-  dot: null
+  idr: null,
+  php: null,
+  thb: null,
+  vnd: null,
+  inr: null,
+  try: null,
+  // hkd: null,
+  sgd: null
+  // twd: null,
 });
 
-// the base url of the v3 coingecko api
-const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+class TokenRatesError extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+  }
+}
 
 // every currency in this list will be fetched from coingecko
 // comment out unused currencies to save some bandwidth!
-const coingeckoCurrencies = ["usd",
-// 'aud',
-// 'nzd',
-// 'cud',
-// 'hkd',
-"eur"
-// 'gbp',
-// 'jpy',
-// 'krw',
-// 'cny',
-// 'btc',
-// 'eth',
-// 'dot',
-];
+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"
+};
 
 // export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
-async function fetchTokenRates(tokens) {
+async function fetchTokenRates(tokens, config = DEFAULT_COINGECKO_CONFIG) {
   // create a map from `coingeckoId` -> `tokenId` for each token
   const coingeckoIdToTokenIds = Object.values(tokens)
   // ignore testnet tokens
   .filter(({
     isTestnet
-  }) => !isTestnet)
+  }) => !isTestnet).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.evmNetwork) return [];
+      const getToken = (evmNetworkId, tokenAddress, coingeckoId) => ({
+        id: evmErc20TokenId(evmNetworkId, tokenAddress),
+        coingeckoId
+      });
+      const token0 = token.coingeckoId0 ? [getToken(token.evmNetwork.id, token.tokenAddress0, token.coingeckoId0)] : [];
+      const token1 = token.coingeckoId1 ? [getToken(token.evmNetwork.id, 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
-  .filter(hasCoingeckoId)
+    // 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, {
@@ -81,31 +186,55 @@ async function fetchTokenRates(tokens) {
   }, {});
 
   // create a list of coingeckoIds we want to fetch
-  const coingeckoIds = Object.keys(coingeckoIdToTokenIds);
+  const coingeckoIds = Object.keys(coingeckoIdToTokenIds).sort();
 
   // skip network request if there is nothing for us to fetch
   if (coingeckoIds.length < 1) return {};
 
-  // construct a coingecko request
-  const idsSerialized = coingeckoIds.join(",");
-  const currenciesSerialized = coingeckoCurrencies.join(",");
-  const queryUrl = `${coingeckoApiUrl}/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}`;
+  // 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 coingeckoPrices = await axios.get(queryUrl).then(response => response.data);
+
+  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));
 
   // build a TokenRatesList from the token prices result
   const ratesList = Object.fromEntries(coingeckoIds.flatMap(coingeckoId => {
     const tokenIds = coingeckoIdToTokenIds[coingeckoId];
-    const rates = NewTokenRates();
+    const rates = newTokenRates();
     for (const currency of coingeckoCurrencies) {
-      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+      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]);
   }));
@@ -113,8 +242,9 @@ async function fetchTokenRates(tokens) {
   // return the TokenRatesList
   return ratesList;
 }
-function hasCoingeckoId(token) {
-  return "coingeckoId" in token && typeof token.coingeckoId === "string";
-}
 
-export { NewTokenRates, TalismanTokenRatesDatabase, db, fetchTokenRates, hasCoingeckoId };
+// TODO: Move this into a common module which can then be imported both here and into EvmErc20Module
+// 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/token-rates",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -20,29 +20,28 @@
   "engines": {
     "node": ">=18"
   },
-  "scripts": {
-    "test": "jest",
-    "lint": "eslint src --max-warnings 0",
-    "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
-  },
   "dependencies": {
-    "@talismn/chaindata-provider": "0.7.0",
-    "axios": "^0.27.2",
-    "dexie": "^3.2.4"
+    "dexie": "^4.0.9",
+    "@talismn/chaindata-provider": "0.8.0"
   },
   "devDependencies": {
-    "@talismn/eslint-config": "0.0.2",
+    "@types/jest": "^29.5.14",
+    "eslint": "^8.57.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3",
     "@talismn/tsconfig": "0.0.2",
-    "@types/jest": "^27.5.1",
-    "eslint": "^8.4.0",
-    "jest": "^28.1.0",
-    "ts-jest": "^28.0.2",
-    "typescript": "^4.6.4"
+    "@talismn/eslint-config": "0.0.3"
   },
   "eslintConfig": {
     "root": true,
     "extends": [
       "@talismn/eslint-config/base"
     ]
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint src --max-warnings 0",
+    "clean": "rm -rf dist .turbo node_modules"
   }
 }

package/CHANGELOG.md

@@ -1,158 +0,0 @@
-# @talismn/token-rates
-
-## 0.2.0
-
-### Minor Changes
-
-- b920ab98: Added GPL licence
-
-### Patch Changes
-
-- 3c1a8b10: Dependency updates
-- Updated dependencies [3c1a8b10]
-- Updated dependencies [b920ab98]
-  - @talismn/chaindata-provider@0.7.0
-
-## 0.1.18
-
-### Patch Changes
-
-- @talismn/chaindata-provider@0.6.0
-
-## 0.1.17
-
-### Patch Changes
-
-- Updated dependencies [1a2fdc73]
-  - @talismn/chaindata-provider@0.5.0
-
-## 0.1.16
-
-### Patch Changes
-
-- f7aca48b: eslint rules
-- 01bf239b: fix: packages publishing with incorrect interdependency versions
-- Updated dependencies [f7aca48b]
-- Updated dependencies [48f0222e]
-- Updated dependencies [01bf239b]
-  - @talismn/chaindata-provider@0.4.4
-
-## 0.1.15
-
-### Patch Changes
-
-- 6643a4e4: fix: tokenRates in @talismn/balances-react
-- Updated dependencies [79f6ccf6]
-- Updated dependencies [c24dc1fb]
-  - @talismn/chaindata-provider@0.4.3
-
-## 0.1.14
-
-### Patch Changes
-
-- @talismn/chaindata-provider@0.4.2
-
-## 0.1.13
-
-### Patch Changes
-
-- 8adc7f06: feat: switched build tool to preconstruct
-- Updated dependencies [8adc7f06]
-  - @talismn/chaindata-provider@0.4.1
-
-## 0.1.12
-
-### Patch Changes
-
-- 4aa691d: feat: new balance modules
-- Updated dependencies [4aa691d]
-  - @talismn/chaindata-provider@0.2.1
-
-## 0.1.11
-
-### Patch Changes
-
-- @talismn/chaindata-provider@0.2.0
-
-## 0.1.10
-
-### Patch Changes
-
-- fix: a variety of improvements from the wallet integration
-- Updated dependencies
-  - @talismn/chaindata-provider@0.1.10
-
-## 0.1.9
-
-### Patch Changes
-
-- Updated dependencies [8ecb8214]
-  - @talismn/chaindata-provider@0.1.9
-
-## 0.1.8
-
-### Patch Changes
-
-- @talismn/chaindata-provider@0.1.8
-
-## 0.1.7
-
-### Patch Changes
-
-- db04d0d: fix: missing token rates and empty token rates requests
-  - @talismn/chaindata-provider@0.1.7
-
-## 0.1.6
-
-### Patch Changes
-
-- ca50757: feat: implemented token fiat rates in @talismn/balances
-- Updated dependencies [ca50757]
-  - @talismn/chaindata-provider@0.1.6
-
-## 0.1.5
-
-### Patch Changes
-
-- Updated dependencies [d66c5bc]
-  - @talismn/chaindata-provider@0.1.5
-
-## 0.1.4
-
-### Patch Changes
-
-- @talismn/chaindata-provider@0.1.4
-
-## 0.1.3
-
-### Patch Changes
-
-- Updated dependencies [d5f69f7]
-  - @talismn/chaindata-provider@0.1.3
-
-## 0.1.2
-
-### Patch Changes
-
-- 5af305c: switched build output from esm to commonjs for ecosystem compatibility
-- Updated dependencies [5af305c]
-  - @talismn/chaindata-provider@0.1.2
-
-## 0.1.1
-
-### Patch Changes
-
-- Fixed publish config
-- Updated dependencies
-  - @talismn/chaindata-provider@0.1.1
-
-## 0.1.0
-
-### Minor Changes
-
-- 43c1a3a: Initial release
-
-### Patch Changes
-
-- Updated dependencies [43c1a3a]
-  - @talismn/chaindata-provider@0.1.0