@talismn/token-rates 0.0.0-pr472-20230201082459

package/CHANGELOG.md

@@ -0,0 +1,106 @@
+# @talismn/token-rates
+
+## 0.0.0-pr472-20230201082459
+
+### Patch Changes
+
+- c0da9a1: feat: switched build tool to preconstruct
+- Updated dependencies [c0da9a1]
+  - @talismn/chaindata-provider@0.0.0-pr472-20230201082459
+
+## 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

package/README.md

@@ -0,0 +1 @@
+# @talismn/token-rates

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

@@ -0,0 +1,7 @@
+import { IToken, 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 function hasCoingeckoId(token: IToken): token is IToken & WithCoingeckoId;

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

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

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

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

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

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

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

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var axios = require('axios');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefault(axios);
+
+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
+});
+
+// the base url of the v3 coingecko api
+const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+
+// 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 {}
+async function fetchTokenRates(tokens) {
+  // create a map from `coingeckoId` -> `tokenId` for each token
+  const coingeckoIdToTokenIds = Object.values(tokens)
+  // ignore testnet tokens
+  .filter(({
+    isTestnet
+  }) => !isTestnet)
+
+  // ignore tokens which don't have a coingeckoId
+  .filter(hasCoingeckoId)
+
+  // 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);
+
+  // 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}`;
+
+  // fetch the token prices from coingecko
+  // the response should be in the format:
+  // {
+  //   [coingeckoId]: {
+  //     [currency]: rate
+  //   }
+  // }
+  const coingeckoPrices = await axios__default["default"].get(queryUrl).then(response => response.data);
+
+  // 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) {
+      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+    }
+    return tokenIds.map(tokenId => [tokenId, rates]);
+  }));
+
+  // return the TokenRatesList
+  return ratesList;
+}
+function hasCoingeckoId(token) {
+  return "coingeckoId" in token && typeof token.coingeckoId === "string";
+}
+
+exports.NewTokenRates = NewTokenRates;
+exports.fetchTokenRates = fetchTokenRates;
+exports.hasCoingeckoId = hasCoingeckoId;

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

@@ -0,0 +1,7 @@
+'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

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var axios = require('axios');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefault(axios);
+
+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
+});
+
+// the base url of the v3 coingecko api
+const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+
+// 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 {}
+async function fetchTokenRates(tokens) {
+  // create a map from `coingeckoId` -> `tokenId` for each token
+  const coingeckoIdToTokenIds = Object.values(tokens)
+  // ignore testnet tokens
+  .filter(({
+    isTestnet
+  }) => !isTestnet)
+
+  // ignore tokens which don't have a coingeckoId
+  .filter(hasCoingeckoId)
+
+  // 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);
+
+  // 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}`;
+
+  // fetch the token prices from coingecko
+  // the response should be in the format:
+  // {
+  //   [coingeckoId]: {
+  //     [currency]: rate
+  //   }
+  // }
+  const coingeckoPrices = await axios__default["default"].get(queryUrl).then(response => response.data);
+
+  // 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) {
+      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+    }
+    return tokenIds.map(tokenId => [tokenId, rates]);
+  }));
+
+  // return the TokenRatesList
+  return ratesList;
+}
+function hasCoingeckoId(token) {
+  return "coingeckoId" in token && typeof token.coingeckoId === "string";
+}
+
+exports.NewTokenRates = NewTokenRates;
+exports.fetchTokenRates = fetchTokenRates;
+exports.hasCoingeckoId = hasCoingeckoId;

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

@@ -0,0 +1,98 @@
+import axios from 'axios';
+
+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
+});
+
+// the base url of the v3 coingecko api
+const coingeckoApiUrl = "https://api.coingecko.com/api/v3";
+
+// 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 {}
+async function fetchTokenRates(tokens) {
+  // create a map from `coingeckoId` -> `tokenId` for each token
+  const coingeckoIdToTokenIds = Object.values(tokens)
+  // ignore testnet tokens
+  .filter(({
+    isTestnet
+  }) => !isTestnet)
+
+  // ignore tokens which don't have a coingeckoId
+  .filter(hasCoingeckoId)
+
+  // 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);
+
+  // 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}`;
+
+  // fetch the token prices from coingecko
+  // the response should be in the format:
+  // {
+  //   [coingeckoId]: {
+  //     [currency]: rate
+  //   }
+  // }
+  const coingeckoPrices = await axios.get(queryUrl).then(response => response.data);
+
+  // 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) {
+      rates[currency] = ((coingeckoPrices || {})[coingeckoId] || {})[currency] || null;
+    }
+    return tokenIds.map(tokenId => [tokenId, rates]);
+  }));
+
+  // return the TokenRatesList
+  return ratesList;
+}
+function hasCoingeckoId(token) {
+  return "coingeckoId" in token && typeof token.coingeckoId === "string";
+}
+
+export { NewTokenRates, fetchTokenRates, hasCoingeckoId };

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@talismn/token-rates",
+  "version": "0.0.0-pr472-20230201082459",
+  "author": "Talisman",
+  "homepage": "https://talisman.xyz",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "packages/token-rates",
+    "type": "git",
+    "url": "https://github.com/talismansociety/talisman.git"
+  },
+  "main": "dist/talismn-token-rates.cjs.js",
+  "module": "dist/talismn-token-rates.esm.js",
+  "files": [
+    "/dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint . --max-warnings 0",
+    "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
+  },
+  "dependencies": {
+    "@talismn/chaindata-provider": "^0.0.0-pr472-20230201082459",
+    "axios": "^0.27.2"
+  },
+  "devDependencies": {
+    "@talismn/eslint-config": "^0.0.0-pr472-20230201082459",
+    "@talismn/tsconfig": "^0.0.0-pr472-20230201082459",
+    "@types/jest": "^27.5.1",
+    "eslint": "^8.4.0",
+    "jest": "^28.1.0",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.6.4"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@talismn/eslint-config/base"
+    ]
+  }
+}