@talismn/token-rates 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @talismn/token-rates
 
+## 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

package/dist/TokenRates.d.ts

@@ -1,31 +1,7 @@
-import { TokenId } from "@talismn/chaindata-provider";
-export declare type TokenRatesList = Record<TokenId, TokenRates>;
-export declare type TokenRateCurrency = keyof TokenRates;
-export declare 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;
-};
+import { Token, TokenList } from "@talismn/chaindata-provider";
+import { TokenRatesList } from "./types";
+export declare function fetchTokenRates(tokens: TokenList): Promise<TokenRatesList>;
+export interface WithCoingeckoId {
+    coingeckoId: string;
+}
+export declare function hasCoingeckoId(token: Token): token is Token & WithCoingeckoId;

package/dist/TokenRates.js

@@ -1,12 +1,81 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasCoingeckoId = exports.fetchTokenRates = void 0;
+const axios_1 = __importDefault(require("axios"));
+const types_1 = require("./types");
+// the base url of the v3 coingecko api
 const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
-// // Some handy types from https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
-// export type FunctionPropertyNames<T> = {
-//   [K in keyof T]: T[K] extends Function ? K : never
-// }[keyof T]
-// export type FunctionProperties<T> = Pick<T, FunctionPropertyNames<T>>
-// export type NonFunctionPropertyNames<T> = {
-//   [K in keyof T]: T[K] extends Function ? never : K
-// }[keyof T]
-// export type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>
+// 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',
+];
+// export function tokenRates(tokens: WithCoingeckoId[]): TokenRatesList {}
+function fetchTokenRates(tokens) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // create a map from `coingeckoId` -> `tokenId` for each token
+        const coingeckoIdToTokenId = Object.fromEntries(Object.values(tokens)
+            // ignore testnet tokens
+            .filter(({ isTestnet }) => !isTestnet)
+            // ignore tokens which don't have a coingeckoId
+            .filter(hasCoingeckoId)
+            // get each token's coingeckoId
+            .map(({ id, coingeckoId }) => [coingeckoId, id]));
+        // create a list of coingeckoIds we want to fetch
+        const coingeckoIds = Object.keys(coingeckoIdToTokenId);
+        // construct a coingecko request
+        const idsSerialized = coingeckoIds.join(",");
+        const currenciesSerialized = coingeckoCurrencies.join(",");
+        const queryUrl = `${coingeckoApiUrl}/simple/price?ids=${idsSerialized}&vs_currencies=${currenciesSerialized}`;
+        // fetch the token prices from coingecko
+        // the response should be in the format:
+        // {
+        //   [coingeckoId]: {
+        //     [currency]: rate
+        //   }
+        // }
+        const coingeckoPrices = yield axios_1.default
+            .get(queryUrl)
+            .then((response) => response.data);
+        // build a TokenRatesList from the token prices result
+        const ratesList = Object.fromEntries(coingeckoIds.map((coingeckoId) => {
+            const tokenId = coingeckoIdToTokenId[coingeckoId];
+            const rates = (0, types_1.NewTokenRates)();
+            for (const currency of coingeckoCurrencies) {
+                rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+            }
+            return [tokenId, rates];
+        }));
+        // return the TokenRatesList
+        return ratesList;
+    });
+}
+exports.fetchTokenRates = fetchTokenRates;
+function hasCoingeckoId(token) {
+    return "coingeckoId" in token && typeof token.coingeckoId === "string";
+}
+exports.hasCoingeckoId = hasCoingeckoId;

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from "./TokenRates";
+export * from "./types";

package/dist/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./TokenRates"), exports);
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,32 @@
+import { TokenId } from "@talismn/chaindata-provider";
+export declare type TokenRatesList = Record<TokenId, TokenRates>;
+export declare type TokenRateCurrency = keyof TokenRates;
+export declare 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;

package/dist/types.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewTokenRates = void 0;
+const NewTokenRates = () => ({
+    usd: null,
+    aud: null,
+    nzd: null,
+    cud: null,
+    hkd: null,
+    eur: null,
+    gbp: null,
+    jpy: null,
+    krw: null,
+    cny: null,
+    btc: null,
+    eth: null,
+    dot: null,
+});
+exports.NewTokenRates = NewTokenRates;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/token-rates",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -30,7 +30,8 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chaindata-provider": "^0.1.4"
+    "@talismn/chaindata-provider": "^0.1.6",
+    "axios": "^0.27.2"
   },
   "devDependencies": {
     "@talismn/eslint-config": "^0.0.0",