@chain-registry/utils 0.11.0 → 1.0.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.1](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@1.0.0...@chain-registry/utils@1.0.1) (2022-10-20)
+
+**Note:** Version bump only for package @chain-registry/utils
+
+
+
+
+
+# [1.0.0](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.11.0...@chain-registry/utils@1.0.0) (2022-09-29)
+
+**Note:** Version bump only for package @chain-registry/utils
+
+
+
+
+
 # [0.11.0](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.10.2...@chain-registry/utils@0.11.0) (2022-09-20)
 
 **Note:** Version bump only for package @chain-registry/utils

package/README.md

@@ -13,90 +13,6 @@
 </p>
 
 Utility functions for the chain-registry 
-
-
-## Usage
-
-```js
-import { ChainRegistryFetcher, ChainRegistryFetcherOptions } from '@chain-registry/utils';
-
-const options: ChainRegistryFetcherOptions = {
-  urls: [
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/chain.json',
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/assetlist.json',
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/juno/assetlist.json',
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/secretnetwork/assetlist.json',
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/_IBC/juno-osmosis.json',
-    'https://raw.githubusercontent.com/cosmos/chain-registry/master/_IBC/osmosis-secretnetwork.json'
-  ]
-};
-const registry = new ChainRegistry(options);
-await registry.fetchUrls();
-```
-
-## Fetching Schemata
-
-We currently only support fetching JSON schemas as defined in https://github.com/cosmos/chain-registry. Supported are `assetlist.schema.json`, `chain.schema.json` and `ibc_data.schema.json`.
-
-### fetchUrls
-
-You can set the `ChainRegistry.urls` property and call `ChainRegistry.fetchUrls()`
-
-```js
-registry.urls = [
-  // urls to fetch
-];
-await registry.fetchUrls();
-```
-
-### fetch
-
-Or, you can simply call `ChainRegistry.fetch()`
-
-```js
-await registry.fetch('https://some-json-schema.com/some-schema.json');
-```
-
-## Asset lists
-
-You can get generated asset lists directly from the registry:
-
-```js
-// generated asset lists
-const generated: AssetList[] = registry.getGeneratedAssetLists('osmosis');
-```
-
-You can get generated `AssetList[]` objects directly from the `ChainRegistry` via the `assetLists` method:
-
-```js
-// you can also get generated assets from ChainInfo object
-const chainInfo: Chain = registry.getChainInfo('osmosis');
-const generatedAssets: AssetList[] = chainInfo.assetLists;
-```
-## Chain info
-
-You can get `Chain` object directly from the `ChainRegistry` via the `getChain` method:
-
-```js
-// get Chain from registry
-const chain: Chain = registry.getChain('osmosis');
-```
-
-or get the `ChainInfo` object:
-
-```js
-const chainInfo: ChainInfo = registry.getChainInfo('osmosis');
-
-// AssetList[] of the generated assets
-const assetes: AssetList[] = chainInfo.assetLists;
-
-// Chain 
-const chain: Chain = chainInfo.chain;
-
-// AssetList[] of the native assets
-const assetes: AssetList[] = chainInfo.nativeAssetLists;
-```
-
 ## Credits
 
 🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.tech/validator)

package/main/utils.js

@@ -5,11 +5,13 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ibcDenom = exports.getWasmChannel = exports.getTransferChannel = exports.getNonTransferChannel = exports.getIbcInfo = exports.getIbcDenomByBaseForCw20 = exports.getIbcDenomByBase = exports.getIbcAssets = exports.getCw20Assets = exports.getAssetLists = void 0;
+exports.ibcDenom = exports.getWasmChannel = exports.getTransferChannel = exports.getNonTransferChannel = exports.getIbcInfo = exports.getIbcDenomByBase = exports.getIbcAssets = exports.getIbcAssetPath = exports.getCw20Assets = exports.getAssetLists = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
 var _sha = require("sha.js");
 
@@ -32,7 +34,7 @@ var ibcDenom = function ibcDenom(paths, coinMinimalDenom) {
   try {
     for (_iterator.s(); !(_step = _iterator.n()).done;) {
       var path = _step.value;
-      prefixes.push("".concat(path.portId, "/").concat(path.channelId));
+      prefixes.push("".concat(path.port_id, "/").concat(path.channel_id));
     }
   } catch (err) {
     _iterator.e(err);
@@ -83,105 +85,111 @@ var getWasmChannel = function getWasmChannel(info) {
 
 exports.getWasmChannel = getWasmChannel;
 
-var getIbcDenomByBase = function getIbcDenomByBase(ibc, chain, counterparty, assets, base) {
+var getIbcAssetPath = function getIbcAssetPath(ibc, chain, counterparty, assets, base) {
+  var _asset$traces$filter, _asset$traces, _asset$traces$filter2;
+
   var ibcInfo = getIbcInfo(ibc, chain, counterparty);
 
-  if (ibcInfo) {
-    var channel = getTransferChannel(ibcInfo);
+  if (!ibcInfo) {
+    return [];
+  }
 
-    if (!channel) {
-      return;
-    }
+  var channel = base.startsWith('cw20:') ? getWasmChannel(ibcInfo) : getTransferChannel(ibcInfo);
+
+  if (!channel) {
+    return [];
+  }
 
-    var channelInfo;
+  var channelInfo;
 
-    if (ibcInfo.chain_1.chain_name === chain) {
-      channelInfo = channel.chain_1;
-    } else {
-      channelInfo = channel.chain_2;
-    }
+  if (ibcInfo.chain_1.chain_name === chain) {
+    channelInfo = channel.chain_1;
+  } else {
+    channelInfo = channel.chain_2;
+  }
 
-    var assetList = assets.find(function (_ref) {
-      var chain_name = _ref.chain_name;
-      return chain_name === counterparty;
-    });
+  var memo = [channelInfo];
+  var assetList = assets.find(function (_ref) {
+    var chain_name = _ref.chain_name;
+    return chain_name === counterparty;
+  });
 
-    if (!assetList) {
-      return;
-    }
+  if (!assetList) {
+    return memo;
+  }
 
-    var assetInfo = assetList.assets.find(function (asset) {
-      return asset.base === base;
-    }); // if (!assetInfo) {
-    //   console.warn('missing referrenced asset');
-    // }
-
-    var traces = [];
-
-    if (assetInfo.traces && assetInfo.traces.length) {
-      [].push.apply(traces, assetInfo.traces);
-    } // console.log(transition);
-    // if (transition.length) {
-    //   return ibcDenom(
-    //     [
-    //       {
-    //         portId: 'transfer',
-    //         channelId: assetInfo.ibc.source_channel
-    //       },
-    //       {
-    //         portId: channelInfo.port_id,
-    //         channelId: channelInfo.channel_id
-    //       }
-    //     ],
-    //     base
-    //   );
-    // }
-
-
-    return ibcDenom([{
-      portId: channelInfo.port_id,
-      channelId: channelInfo.channel_id
-    }], base);
+  var asset = assetList.assets.find(function (asset) {
+    return asset.base === base;
+  });
+
+  if (!asset) {
+    console.log("no ".concat(base, " found in ").concat(counterparty));
+    return memo;
+  }
+
+  var traces = (_asset$traces$filter = (_asset$traces = asset.traces) === null || _asset$traces === void 0 ? void 0 : (_asset$traces$filter2 = _asset$traces.filter) === null || _asset$traces$filter2 === void 0 ? void 0 : _asset$traces$filter2.call(_asset$traces, function (trace) {
+    return trace.type === 'ibc' || trace.type === 'ibc-cw20';
+  })) !== null && _asset$traces$filter !== void 0 ? _asset$traces$filter : [];
+
+  if (!traces.length) {
+    return memo;
+  }
+
+  if (traces.length > 1) {
+    throw new Error('contact maintainers: multi-hop not yet supported');
   }
+
+  var _traces = (0, _slicedToArray2["default"])(traces, 1),
+      trace = _traces[0];
+
+  return [].concat(memo, (0, _toConsumableArray2["default"])(getIbcAssetPath(ibc, counterparty, trace.counterparty.chain_name, assets, trace.counterparty.base_denom // base
+  )));
 };
 
-exports.getIbcDenomByBase = getIbcDenomByBase;
+exports.getIbcAssetPath = getIbcAssetPath;
 
-var getIbcDenomByBaseForCw20 = function getIbcDenomByBaseForCw20(ibc, chain, counterparty, assets, base) {
+var getIbcDenomByBase = function getIbcDenomByBase(ibc, chain, counterparty, assets, base) {
   var ibcInfo = getIbcInfo(ibc, chain, counterparty);
 
   if (ibcInfo) {
-    var channel = getWasmChannel(ibcInfo);
+    var _asset$traces2, _asset$traces2$find, _ibcTrace$counterpart, _ibcTrace$counterpart2;
+
+    var channel = base.startsWith('cw20:') ? getWasmChannel(ibcInfo) : getTransferChannel(ibcInfo);
 
     if (!channel) {
       return;
     }
 
-    var channelInfo;
+    var ibcPath = getIbcAssetPath(ibc, chain, counterparty, assets, base);
+    var assetList = assets.find(function (_ref2) {
+      var chain_name = _ref2.chain_name;
+      return chain_name === counterparty;
+    });
 
-    if (ibcInfo.chain_1.chain_name === chain) {
-      channelInfo = channel.chain_1;
-    } else {
-      channelInfo = channel.chain_2;
+    if (!assetList) {
+      console.warn("missing asset list for ".concat(counterparty)); // could be incorrect...
+
+      return ibcDenom(ibcPath, base);
     }
 
-    var assetInfo = assets.find(function (_ref2) {
-      var chain_name = _ref2.chain_name;
-      return chain_name === counterparty;
+    var asset = assetList.assets.find(function (asset) {
+      return asset.base === base;
     });
 
-    if (!assetInfo) {
-      return;
+    if (!asset) {
+      console.warn("no ".concat(base, " found in ").concat(counterparty));
+      return ibcDenom(ibcPath, base);
     }
 
-    return ibcDenom([{
-      portId: channelInfo.port_id,
-      channelId: channelInfo.channel_id
-    }], base);
+    var ibcTrace = (_asset$traces2 = asset.traces) === null || _asset$traces2 === void 0 ? void 0 : (_asset$traces2$find = _asset$traces2.find) === null || _asset$traces2$find === void 0 ? void 0 : _asset$traces2$find.call(_asset$traces2, function (trace) {
+      return trace.type === 'ibc';
+    });
+    var baseDenom = (_ibcTrace$counterpart = ibcTrace === null || ibcTrace === void 0 ? void 0 : (_ibcTrace$counterpart2 = ibcTrace.counterparty) === null || _ibcTrace$counterpart2 === void 0 ? void 0 : _ibcTrace$counterpart2.base_denom) !== null && _ibcTrace$counterpart !== void 0 ? _ibcTrace$counterpart : asset.base;
+    return ibcDenom(ibcPath, baseDenom);
   }
 };
 
-exports.getIbcDenomByBaseForCw20 = getIbcDenomByBaseForCw20;
+exports.getIbcDenomByBase = getIbcDenomByBase;
 
 var getIbcAssets = function getIbcAssets(chainName, ibc, assets) {
   var chainIbcInfo = ibc.filter(function (i) {
@@ -296,7 +304,7 @@ var getCw20Assets = function getCw20Assets(chainName, ibc, assets) {
     var cw20Assets = counterpartyAssets.assets.filter(function (a) {
       return a.base.startsWith('cw20:');
     }).map(function (asset) {
-      var denom = getIbcDenomByBaseForCw20(ibc, chainName, counterparty, //
+      var denom = getIbcDenomByBase(ibc, chainName, counterparty, //
       assets, asset.base);
 
       var newAsset = _objectSpread({}, asset);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chain-registry/utils",
-  "version": "0.11.0",
+  "version": "1.0.1",
   "description": "Chain Registry Utils",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/cosmology-tech/chain-registry",
@@ -73,10 +73,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.19.0",
-    "@chain-registry/types": "^0.11.0",
-    "bfs-path": "^1.0.2",
-    "cross-fetch": "^3.1.5",
+    "@chain-registry/types": "^0.11.1",
     "sha.js": "^2.4.11"
   },
-  "gitHead": "7227af2939d83bdf4e68bd530aa68c14ae5aa18b"
+  "gitHead": "1dc04b938a9bbfb226dc3f91092c98c2c2d4c15a"
 }

package/types/utils.d.ts

@@ -1,7 +1,7 @@
 import { AssetList, IBCInfo } from '@chain-registry/types';
 export declare const ibcDenom: (paths: {
-    portId: string;
-    channelId: string;
+    port_id: string;
+    channel_id: string;
 }[], coinMinimalDenom: string) => string;
 export declare const getIbcInfo: (ibc: IBCInfo[], chain: string, counterparty: string) => IBCInfo;
 export declare const getTransferChannel: (info: IBCInfo) => {
@@ -43,8 +43,8 @@ export declare const getWasmChannel: (info: IBCInfo) => {
     version: string;
     tags?: object;
 };
+export declare const getIbcAssetPath: (ibc: IBCInfo[], chain: string, counterparty: string, assets: AssetList[], base: string) => any;
 export declare const getIbcDenomByBase: (ibc: IBCInfo[], chain: string, counterparty: string, assets: AssetList[], base: string) => string;
-export declare const getIbcDenomByBaseForCw20: (ibc: IBCInfo[], chain: string, counterparty: string, assets: AssetList[], base: string) => string;
 export declare const getIbcAssets: (chainName: string, ibc: IBCInfo[], assets: AssetList[]) => {
     chain_name: string;
     assets: any;

package/main/registry.js

@@ -1,313 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ChainRegistryFetcher = exports.ChainInfo = void 0;
-
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _bfsPath = require("bfs-path");
-
-var _crossFetch = _interopRequireDefault(require("cross-fetch"));
-
-var _utils = require("./utils");
-
-var fetchUrl = function fetchUrl(url) {
-  return (0, _crossFetch["default"])(url).then(function (res) {
-    if (res.status >= 400) {
-      throw new Error('Bad response');
-    }
-
-    return res.json();
-  });
-};
-
-var ChainInfo = /*#__PURE__*/function () {
-  function ChainInfo(options) {
-    (0, _classCallCheck2["default"])(this, ChainInfo);
-    (0, _defineProperty2["default"])(this, "chain_name", void 0);
-    (0, _defineProperty2["default"])(this, "fetcher", void 0);
-    (0, _defineProperty2["default"])(this, "_asset_list", void 0);
-    (0, _defineProperty2["default"])(this, "_asset_lists", void 0);
-    (0, _defineProperty2["default"])(this, "_chain", void 0);
-    (0, _defineProperty2["default"])(this, "_ibc_data", []);
-    this.chain_name = options.chain_name;
-    this.fetcher = options.fetcher;
-    this.refresh();
-  }
-
-  (0, _createClass2["default"])(ChainInfo, [{
-    key: "refresh",
-    value: function refresh() {
-      this._asset_list = this.fetcher.getChainAssetList(this.chain_name);
-      this._ibc_data = this.fetcher.getChainIbcData(this.chain_name);
-      this._chain = this.fetcher.getChain(this.chain_name);
-
-      var supportedChains = this._ibc_data.reduce(function (m, v) {
-        if (!m.includes(v.chain_1.chain_name)) m.push(v.chain_1.chain_name);
-        if (!m.includes(v.chain_2.chain_name)) m.push(v.chain_2.chain_name);
-        return m;
-      }, []);
-
-      this._asset_lists = this.fetcher.assetLists.filter(function (list) {
-        return supportedChains.includes(list.chain_name);
-      });
-    }
-  }, {
-    key: "nativeAssetLists",
-    get: function get() {
-      return this._asset_list;
-    }
-  }, {
-    key: "chain",
-    get: function get() {
-      return this._chain;
-    }
-  }, {
-    key: "assetLists",
-    get: function get() {
-      return (0, _utils.getAssetLists)(this.chain_name, this._ibc_data, this._asset_lists);
-    }
-  }]);
-  return ChainInfo;
-}(); // QUESTION: should ChainRegistryFetcher just be ChainRegistry?
-
-
-exports.ChainInfo = ChainInfo;
-
-var ChainRegistryFetcher = /*#__PURE__*/function () {
-  function ChainRegistryFetcher() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    (0, _classCallCheck2["default"])(this, ChainRegistryFetcher);
-    (0, _defineProperty2["default"])(this, "_asset_lists", []);
-    (0, _defineProperty2["default"])(this, "_chains", []);
-    (0, _defineProperty2["default"])(this, "_ibc_data", []);
-    (0, _defineProperty2["default"])(this, "urls", []);
-
-    //
-    if (options.assetLists) {
-      this._asset_lists = options.assetLists;
-    }
-
-    if (options.chains) {
-      this._chains = options.chains;
-    }
-
-    if (options.ibcData) {
-      this._ibc_data = options.ibcData;
-    }
-
-    if (options.urls) {
-      this.urls = options.urls;
-    }
-  }
-
-  (0, _createClass2["default"])(ChainRegistryFetcher, [{
-    key: "assetLists",
-    get: function get() {
-      return this._asset_lists;
-    }
-  }, {
-    key: "getChainAssetList",
-    value: function getChainAssetList(chainName) {
-      return this._asset_lists.find(function (list) {
-        return list.chain_name === chainName;
-      });
-    }
-  }, {
-    key: "getGeneratedAssetLists",
-    value: function getGeneratedAssetLists(chainName) {
-      return (0, _utils.getAssetLists)(chainName, this._ibc_data, this._asset_lists);
-    }
-  }, {
-    key: "chains",
-    get: function get() {
-      return this._chains;
-    }
-  }, {
-    key: "getChain",
-    value: function getChain(chainName) {
-      return this._chains.find(function (chain) {
-        return chain.chain_name === chainName;
-      });
-    }
-  }, {
-    key: "ibcData",
-    get: function get() {
-      return this._ibc_data;
-    }
-  }, {
-    key: "getChainIbcData",
-    value: function getChainIbcData(chainName) {
-      return this._ibc_data.filter(function (info) {
-        return info.chain_1.chain_name === chainName || info.chain_2.chain_name === chainName;
-      });
-    }
-  }, {
-    key: "getChainInfo",
-    value: function getChainInfo(chainName) {
-      return new ChainInfo({
-        chain_name: chainName,
-        fetcher: this
-      });
-    }
-  }, {
-    key: "upsertChain",
-    value: function upsertChain(data) {
-      var found = this._chains.find(function (chain) {
-        return chain.chain_name === data.chain_name && chain.network_type === data.network_type;
-      });
-
-      if (!found) {
-        this._chains.push(data);
-
-        return;
-      }
-
-      this._chains = this._chains.map(function (chain) {
-        if (chain.chain_name === data.chain_name && chain.network_type === data.network_type) {
-          return data;
-        } else {
-          return chain;
-        }
-      });
-    }
-  }, {
-    key: "updateAssetList",
-    value: function updateAssetList(data) {
-      var found = this._asset_lists.find(function (list) {
-        return list.chain_name === data.chain_name;
-      });
-
-      if (!found) {
-        this._asset_lists.push(data);
-
-        return;
-      }
-
-      this._asset_lists = this._asset_lists.map(function (list) {
-        if (list.chain_name === data.chain_name) {
-          return data;
-        } else {
-          return list;
-        }
-      });
-    }
-  }, {
-    key: "upsertIbcData",
-    value: function upsertIbcData(data) {
-      var found = this._ibc_data.find(function (info) {
-        return info.chain_1.chain_name === data.chain_1.chain_name && info.chain_2.chain_name === data.chain_2.chain_name;
-      });
-
-      if (!found) {
-        this._ibc_data.push(data);
-
-        return;
-      }
-
-      this._ibc_data = this._ibc_data.map(function (info) {
-        if (info.chain_1.chain_name === data.chain_1.chain_name && info.chain_2.chain_name === data.chain_2.chain_name) {
-          return data;
-        } else {
-          return info;
-        }
-      });
-    }
-  }, {
-    key: "update",
-    value: function update(data) {
-      if (!data.$schema) throw new Error('not a registered JSON schema type');
-      var type = (0, _bfsPath.basename)(data.$schema, '.schema.json');
-
-      switch (type) {
-        case 'chain':
-          this.upsertChain(data);
-          break;
-
-        case 'assetlist':
-          this.updateAssetList(data);
-          break;
-
-        case 'ibc_data':
-          this.upsertIbcData(data);
-          break;
-
-        default:
-          throw new Error('unknown schema type');
-      }
-    }
-  }, {
-    key: "fetch",
-    value: function () {
-      var _fetch = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(url) {
-        var data;
-        return _regenerator["default"].wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                _context.next = 2;
-                return fetchUrl(url);
-
-              case 2:
-                data = _context.sent;
-                this.update(data);
-
-              case 4:
-              case "end":
-                return _context.stop();
-            }
-          }
-        }, _callee, this);
-      }));
-
-      function fetch(_x) {
-        return _fetch.apply(this, arguments);
-      }
-
-      return fetch;
-    }()
-  }, {
-    key: "fetchUrls",
-    value: function () {
-      var _fetchUrls = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-        var _this = this;
-
-        return _regenerator["default"].wrap(function _callee2$(_context2) {
-          while (1) {
-            switch (_context2.prev = _context2.next) {
-              case 0:
-                return _context2.abrupt("return", Promise.all(this.urls.map(function (url) {
-                  return _this.fetch(url);
-                })));
-
-              case 1:
-              case "end":
-                return _context2.stop();
-            }
-          }
-        }, _callee2, this);
-      }));
-
-      function fetchUrls() {
-        return _fetchUrls.apply(this, arguments);
-      }
-
-      return fetchUrls;
-    }()
-  }]);
-  return ChainRegistryFetcher;
-}();
-
-exports.ChainRegistryFetcher = ChainRegistryFetcher;