@chain-registry/utils 1.16.1 → 1.17.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.17.0](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@1.16.1...@chain-registry/utils@1.17.0) (2023-12-20)
+
+
+### Features
+
+* add chainName as optional param ([d415f33](https://github.com/cosmology-tech/chain-registry/commit/d415f33dc96651e5bb4ede689220d89ad11fe9d9))
+
+
+
+
+
 ## [1.16.1](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@1.16.0...@chain-registry/utils@1.16.1) (2023-12-15)
 
 **Note:** Version bump only for package @chain-registry/utils

package/main/asset-list-util.js

@@ -16,75 +16,74 @@ exports.getExponentByDenom = getExponentByDenom;
 exports.getSymbolByChainDenom = getSymbolByChainDenom;
 exports.noDecimals = noDecimals;
 var _bignumber = _interopRequireDefault(require("bignumber.js"));
-function getAssetByDenom(assets, denom) {
-  var asset = assets.find(function (asset) {
-    return asset.base === denom;
+function getAssetByKeyValue(assets, key, value, chainName) {
+  var filteredAssets = assets.filter(function (_ref) {
+    var chain_name = _ref.chain_name;
+    return !chainName || chain_name === chainName;
+  }).flatMap(function (_ref2) {
+    var assets = _ref2.assets;
+    return assets;
+  });
+  var matchingAssets = filteredAssets.filter(function (asset) {
+    return asset[key] === value;
   });
-  if (!asset) {
-    throw new Error("Asset not found: ".concat(denom));
+  if (matchingAssets.length === 0) {
+    throw new Error("No asset found for ".concat(key, " '").concat(value, "'"));
   }
-  return asset;
+  if (matchingAssets.length > 1) {
+    throw new Error("Ambiguity: ".concat(matchingAssets.length, " assets found for ").concat(key, " '").concat(value, "'"));
+  }
+  return matchingAssets[0];
+}
+function getAssetByDenom(assets, denom, chainName) {
+  return getAssetByKeyValue(assets, 'base', denom, chainName);
 }
-function getDenomByCoinGeckoId(assets, coinGeckoId) {
-  return assets.find(function (asset) {
-    return asset.coingecko_id === coinGeckoId;
-  }).base;
+function getDenomByCoinGeckoId(assets, coinGeckoId, chainName) {
+  return getAssetByKeyValue(assets, 'coingecko_id', coinGeckoId, chainName).base;
 }
 function getCoinGeckoIdByDenom(assets, denom) {
   var _asset$coingecko_id;
-  var _ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
-    _ref$allowTestnet = _ref.allowTestnet,
-    allowTestnet = _ref$allowTestnet === void 0 ? false : _ref$allowTestnet,
-    _ref$customAssetFilte = _ref.customAssetFilter,
-    customAssetFilter = _ref$customAssetFilte === void 0 ? function () {
+  var _ref3 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
+    chainName = _ref3.chainName,
+    _ref3$allowTestnet = _ref3.allowTestnet,
+    allowTestnet = _ref3$allowTestnet === void 0 ? false : _ref3$allowTestnet,
+    _ref3$customAssetFilt = _ref3.customAssetFilter,
+    customAssetFilter = _ref3$customAssetFilt === void 0 ? function () {
       return true;
-    } : _ref$customAssetFilte,
-    _ref$excludedChainNam = _ref.excludedChainNames,
-    excludedChainNames = _ref$excludedChainNam === void 0 ? [] : _ref$excludedChainNam;
-  var filteredAssetLists = assets.filter(function (_ref2) {
-    var chain_name = _ref2.chain_name;
-    return (allowTestnet || !chain_name.includes('testnet')) && !excludedChainNames.includes(chain_name);
+    } : _ref3$customAssetFilt,
+    _ref3$excludedChainNa = _ref3.excludedChainNames,
+    excludedChainNames = _ref3$excludedChainNa === void 0 ? [] : _ref3$excludedChainNa;
+  var filteredAssetLists = assets.filter(function (_ref4) {
+    var chain_name = _ref4.chain_name;
+    return (!chainName || chain_name === chainName) && (allowTestnet || !chain_name.includes('testnet')) && !excludedChainNames.includes(chain_name);
   });
-  var filteredAssets = filteredAssetLists.flatMap(function (_ref3) {
-    var assets = _ref3.assets;
+  var filteredAssets = filteredAssetLists.flatMap(function (_ref5) {
+    var assets = _ref5.assets;
     return assets;
-  }).filter(function (_ref4) {
-    var coingecko_id = _ref4.coingecko_id;
+  }).filter(function (_ref6) {
+    var coingecko_id = _ref6.coingecko_id;
     return coingecko_id;
   }).filter(customAssetFilter);
-  var asset = filteredAssets.find(function (_ref5) {
-    var base = _ref5.base;
+  var asset = filteredAssets.find(function (_ref7) {
+    var base = _ref7.base;
     return base === denom;
   });
   return (_asset$coingecko_id = asset === null || asset === void 0 ? void 0 : asset.coingecko_id) !== null && _asset$coingecko_id !== void 0 ? _asset$coingecko_id : null;
 }
-function getSymbolByChainDenom(assets, denom) {
-  var asset = getAssetByDenom(assets, denom);
-  var symbol = asset.symbol;
-  if (!symbol) {
-    return denom;
-  }
-  return symbol;
+function getSymbolByChainDenom(assets, denom, chainName) {
+  return getAssetByDenom(assets, denom, chainName).symbol;
 }
-function getChainDenomBySymbol(assets, token) {
-  var asset = assets.find(function (_ref6) {
-    var symbol = _ref6.symbol;
-    return symbol === token;
-  });
-  var base = asset === null || asset === void 0 ? void 0 : asset.base;
-  if (!base) {
-    console.log("cannot find base for token ".concat(token));
-    return null;
-  }
-  return base;
+function getChainDenomBySymbol(assets, symbol, chainName) {
+  return getAssetByKeyValue(assets, 'symbol', symbol, chainName).base;
 }
-function getExponentByDenom(assets, denom) {
-  var asset = getAssetByDenom(assets, denom);
-  var unit = asset.denom_units.find(function (_ref7) {
-    var denom = _ref7.denom;
+function getExponentByDenom(assets, denom, chainName) {
+  var _unit$exponent;
+  var asset = getAssetByDenom(assets, denom, chainName);
+  var unit = asset.denom_units.find(function (_ref8) {
+    var denom = _ref8.denom;
     return denom === asset.display;
   });
-  return (unit === null || unit === void 0 ? void 0 : unit.exponent) || 0;
+  return (_unit$exponent = unit === null || unit === void 0 ? void 0 : unit.exponent) !== null && _unit$exponent !== void 0 ? _unit$exponent : 0;
 }
 function convertCoinGeckoPricesToDenomPriceMap(assets, prices) {
   return Object.keys(prices).reduce(function (res, geckoId) {
@@ -96,15 +95,15 @@ function convertCoinGeckoPricesToDenomPriceMap(assets, prices) {
 function noDecimals(num) {
   return new _bignumber["default"](num).decimalPlaces(0, _bignumber["default"].ROUND_DOWN).toString();
 }
-function convertBaseUnitsToDollarValue(assets, prices, symbol, amount) {
-  var denom = getChainDenomBySymbol(assets, symbol);
-  return new _bignumber["default"](amount).shiftedBy(-getExponentByDenom(assets, denom)).multipliedBy(prices[denom]).toString();
+function convertBaseUnitsToDollarValue(assets, prices, symbol, amount, chainName) {
+  var denom = getChainDenomBySymbol(assets, symbol, chainName);
+  return new _bignumber["default"](amount).shiftedBy(-getExponentByDenom(assets, denom, chainName)).multipliedBy(prices[denom]).toString();
 }
-function convertDollarValueToDenomUnits(assets, prices, symbol, value) {
-  var denom = getChainDenomBySymbol(assets, symbol);
-  return new _bignumber["default"](value).dividedBy(prices[denom]).shiftedBy(getExponentByDenom(assets, denom)).toString();
+function convertDollarValueToDenomUnits(assets, prices, symbol, value, chainName) {
+  var denom = getChainDenomBySymbol(assets, symbol, chainName);
+  return new _bignumber["default"](value).dividedBy(prices[denom]).shiftedBy(getExponentByDenom(assets, denom, chainName)).toString();
 }
-function convertBaseUnitsToDisplayUnits(assets, symbol, amount) {
-  var denom = getChainDenomBySymbol(assets, symbol);
-  return new _bignumber["default"](amount).shiftedBy(-getExponentByDenom(assets, denom)).toString();
+function convertBaseUnitsToDisplayUnits(assets, symbol, amount, chainName) {
+  var denom = getChainDenomBySymbol(assets, symbol, chainName);
+  return new _bignumber["default"](amount).shiftedBy(-getExponentByDenom(assets, denom, chainName)).toString();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chain-registry/utils",
-  "version": "1.16.1",
+  "version": "1.17.0",
   "description": "Chain Registry Utils",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/cosmology-tech/chain-registry",
@@ -76,5 +76,5 @@
     "bignumber.js": "9.1.1",
     "sha.js": "^2.4.11"
   },
-  "gitHead": "4be96c12e66434cf3fd49ab5dc00102ccc8de551"
+  "gitHead": "c8644d2e748b506abf7e174f2c50bfdb77277ca8"
 }

package/types/asset-list-util.d.ts

@@ -1,4 +1,4 @@
-import { Asset, AssetDenomUnit } from '@chain-registry/types';
+import { Asset, AssetDenomUnit, AssetList } from '@chain-registry/types';
 export type CoinDenom = AssetDenomUnit['denom'];
 export type Exponent = AssetDenomUnit['exponent'];
 export interface CoinGeckoUSD {
@@ -7,13 +7,21 @@ export interface CoinGeckoUSD {
 export interface PriceHash {
     [key: CoinDenom]: number;
 }
-export declare function getAssetByDenom(assets: Asset[], denom: CoinDenom): Asset;
-export declare function getDenomByCoinGeckoId(assets: Asset[], coinGeckoId: string): CoinDenom;
-export declare function getSymbolByChainDenom(assets: Asset[], denom: CoinDenom): string;
-export declare function getChainDenomBySymbol(assets: Asset[], token: string): CoinDenom;
-export declare function getExponentByDenom(assets: Asset[], denom: CoinDenom): Exponent;
-export declare function convertCoinGeckoPricesToDenomPriceMap(assets: Asset[], prices: Record<string, CoinGeckoUSD>): PriceHash;
+export declare function getAssetByDenom(assets: AssetList[], denom: CoinDenom, chainName?: string): Asset;
+export declare function getDenomByCoinGeckoId(assets: AssetList[], coinGeckoId: string, chainName?: string): CoinDenom;
+type GetCoinGeckoIdByDenomOptions = {
+    chainName?: string;
+    allowTestnet?: boolean;
+    customAssetFilter?: (asset: Asset) => boolean;
+    excludedChainNames?: string[];
+};
+export declare function getCoinGeckoIdByDenom(assets: AssetList[], denom: CoinDenom, { chainName, allowTestnet, customAssetFilter, excludedChainNames }?: GetCoinGeckoIdByDenomOptions): string | null;
+export declare function getSymbolByChainDenom(assets: AssetList[], denom: CoinDenom, chainName?: string): string;
+export declare function getChainDenomBySymbol(assets: AssetList[], symbol: string, chainName?: string): CoinDenom;
+export declare function getExponentByDenom(assets: AssetList[], denom: CoinDenom, chainName?: string): Exponent;
+export declare function convertCoinGeckoPricesToDenomPriceMap(assets: AssetList[], prices: Record<string, CoinGeckoUSD>): PriceHash;
 export declare function noDecimals(num: number | string): string;
-export declare function convertBaseUnitsToDollarValue(assets: Asset[], prices: PriceHash, symbol: string, amount: string | number): string;
-export declare function convertDollarValueToDenomUnits(assets: Asset[], prices: PriceHash, symbol: string, value: string | number): string;
-export declare function convertBaseUnitsToDisplayUnits(assets: Asset[], symbol: string, amount: string | number): string;
+export declare function convertBaseUnitsToDollarValue(assets: AssetList[], prices: PriceHash, symbol: string, amount: string | number, chainName?: string): string;
+export declare function convertDollarValueToDenomUnits(assets: AssetList[], prices: PriceHash, symbol: string, value: string | number, chainName?: string): string;
+export declare function convertBaseUnitsToDisplayUnits(assets: AssetList[], symbol: string, amount: string | number, chainName?: string): string;
+export {};