@chain-registry/utils 0.5.0 → 0.6.1

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.1](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.6.0...@chain-registry/utils@0.6.1) (2022-08-31)
+
+**Note:** Version bump only for package @chain-registry/utils
+
+
+
+
+
+# [0.6.0](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.5.1...@chain-registry/utils@0.6.0) (2022-08-31)
+
+**Note:** Version bump only for package @chain-registry/utils
+
+
+
+
+
+## [0.5.1](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.5.0...@chain-registry/utils@0.5.1) (2022-08-23)
+
+**Note:** Version bump only for package @chain-registry/utils
+
+
+
+
+
 # [0.5.0](https://github.com/cosmology-tech/chain-registry/compare/@chain-registry/utils@0.4.0...@chain-registry/utils@0.5.0) (2022-08-23)
 
 **Note:** Version bump only for package @chain-registry/utils

package/README.md

@@ -12,4 +12,82 @@
    <a href="https://www.npmjs.com/package/@chain-registry/utils"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/chain-registry?filename=packages%2Futils%2Fpackage.json"></a>
 </p>
 
-Utility functions for the chain-registry 
+Utility functions for the chain-registry 
+
+
+## Usage
+
+```js
+import { ChainRegistry, ChainRegistryOptions } from '@chain-registry/utils';
+
+const options: ChainRegistryOptions = {
+  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
+
+```js
+// generated asset lists
+const generated: AssetList[] = registry.getGeneratedAssetLists('osmosis');
+
+// 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 regsitry via `getChain`
+
+```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();
+```
+

package/main/index.js

@@ -1,412 +1,31 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 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;
-
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _crypto = require("@keplr-wallet/crypto");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-var ibcDenom = function ibcDenom(paths, coinMinimalDenom) {
-  var prefixes = [];
-
-  var _iterator = _createForOfIteratorHelper(paths),
-      _step;
-
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var path = _step.value;
-      prefixes.push("".concat(path.portId, "/").concat(path.channelId));
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
-  }
-
-  var prefix = prefixes.join('/');
-  var denom = "".concat(prefix, "/").concat(coinMinimalDenom);
-  return 'ibc/' + Buffer.from(_crypto.Hash.sha256(Buffer.from(denom))).toString('hex').toUpperCase();
-};
-
-exports.ibcDenom = ibcDenom;
-
-var findInfo = function findInfo(ibc, to, from) {
-  return ibc.find(function (i) {
-    return i['chain-1']['chain-name'] === from && i['chain-2']['chain-name'] === to;
-  });
-};
-
-var getIbcInfo = function getIbcInfo(ibc, chain, counterparty) {
-  return findInfo(ibc, chain, counterparty) || findInfo(ibc, counterparty, chain);
-};
-
-exports.getIbcInfo = getIbcInfo;
-
-var getTransferChannel = function getTransferChannel(info) {
-  return info.channels.find(function (channel) {
-    return channel['chain-1']['port-id'] === 'transfer' && channel['chain-2']['port-id'] === 'transfer';
-  });
-};
-
-exports.getTransferChannel = getTransferChannel;
-
-var getNonTransferChannel = function getNonTransferChannel(info) {
-  return info.channels.find(function (channel) {
-    return channel['chain-1']['port-id'] !== 'transfer' && channel['chain-2']['port-id'] === 'transfer' || channel['chain-1']['port-id'] === 'transfer' && channel['chain-2']['port-id'] !== 'transfer';
-  });
-};
-
-exports.getNonTransferChannel = getNonTransferChannel;
-
-var getWasmChannel = function getWasmChannel(info) {
-  return info.channels.find(function (channel) {
-    return channel['chain-1']['port-id'].startsWith('wasm.') && channel['chain-2']['port-id'] === 'transfer' || channel['chain-1']['port-id'] === 'transfer' && channel['chain-2']['port-id'].startsWith('wasm');
-  });
-};
-
-exports.getWasmChannel = getWasmChannel;
-
-var getIbcDenomByBase = function getIbcDenomByBase(ibc, chain, counterparty, assets, base) {
-  var ibcInfo = getIbcInfo(ibc, chain, counterparty);
-
-  if (ibcInfo) {
-    var channel = getTransferChannel(ibcInfo);
-
-    if (!channel) {
-      return;
-    }
-
-    var channelInfo;
-
-    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;
-    });
-
-    if (!assetList) {
-      return;
-    }
-
-    var assetInfo = assetList.assets.find(function (asset) {
-      return asset.base === base;
-    });
-
-    if (!assetInfo) {
-      console.warn('missing referrenced asset');
-    } // TODO transition later!
-
-
-    var traces = [];
-
-    if (assetInfo.ibc) {
-      traces.push({
-        type: 'ibc',
-        counterparty: {
-          denom: assetInfo.ibc.source_denom,
-          channel: assetInfo.ibc.source_channel
-        },
-        chain: {
-          channel: assetInfo.ibc.dst_channel
-        }
-      });
-    }
-
-    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
-    //   );
-    // }
 
+var _registry = require("./registry");
 
-    return ibcDenom([{
-      portId: channelInfo['port-id'],
-      channelId: channelInfo['channel-id']
-    }], base);
-  }
-};
-
-exports.getIbcDenomByBase = getIbcDenomByBase;
-
-var getIbcDenomByBaseForCw20 = function getIbcDenomByBaseForCw20(ibc, chain, counterparty, assets, base) {
-  var ibcInfo = getIbcInfo(ibc, chain, counterparty);
-
-  if (ibcInfo) {
-    var channel = getWasmChannel(ibcInfo);
-
-    if (!channel) {
-      return;
-    }
-
-    var channelInfo;
-
-    if (ibcInfo['chain-1']['chain-name'] === chain) {
-      channelInfo = channel['chain-1'];
-    } else {
-      channelInfo = channel['chain-2'];
-    }
-
-    var assetInfo = assets.find(function (_ref2) {
-      var chain_name = _ref2.chain_name;
-      return chain_name === counterparty;
-    });
-
-    if (!assetInfo) {
-      return;
+Object.keys(_registry).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _registry[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _registry[key];
     }
-
-    return ibcDenom([{
-      portId: channelInfo['port-id'],
-      channelId: channelInfo['channel-id']
-    }], base);
-  }
-};
-
-exports.getIbcDenomByBaseForCw20 = getIbcDenomByBaseForCw20;
-
-var getIbcAssets = function getIbcAssets(chainName, ibc, assets) {
-  var chainIbcInfo = ibc.filter(function (i) {
-    return i['chain-1']['chain-name'] === chainName || i['chain-2']['chain-name'] === chainName;
   });
-  var ibcAssetLists = chainIbcInfo.map(function (ibcInfo) {
-    var counterpartyIs = ibcInfo['chain-1']['chain-name'] === chainName ? 'chain-2' : 'chain-1';
-    var chainIs = ibcInfo['chain-1']['chain-name'] === chainName ? 'chain-1' : 'chain-2';
-    var counterparty = ibcInfo[counterpartyIs]['chain-name'];
-    var counterpartyIbc = ibcInfo[counterpartyIs];
-    var chainIbc = ibcInfo[chainIs];
-    var counterpartyAssets = assets.find(function (a) {
-      return a.chain_name === counterparty;
-    });
-
-    if (!counterpartyAssets) {
-      console.warn('asset not found: ' + counterparty);
-      return;
-    }
-
-    var ibcAssets = counterpartyAssets.assets.filter(function (a) {
-      return !a.base.startsWith('cw20:');
-    }).map(function (asset) {
-      var denom = getIbcDenomByBase(ibc, chainName, counterparty, //
-      assets, asset.base);
-
-      var newAsset = _objectSpread({}, asset);
-
-      newAsset.base = denom;
-      newAsset.denom_units = newAsset.denom_units.map(function (unit) {
-        if (unit.denom === asset.base) {
-          var newUnit = _objectSpread({}, unit);
-
-          newUnit.denom = denom;
-          newUnit.aliases = [unit.denom];
-          return newUnit;
-        }
-
-        return unit;
-      });
-      return newAsset;
-    });
-    var channel = getTransferChannel(ibcInfo);
-    return {
-      chain: _objectSpread(_objectSpread({}, chainIbc), channel[chainIs]),
-      counterparty: _objectSpread(_objectSpread({}, counterpartyIbc), channel[counterpartyIs]),
-      assets: ibcAssets
-    };
-  }).filter(Boolean);
-  var hash = ibcAssetLists.reduce(function (m, v) {
-    m[v.chain['chain-name']] = m[v.chain['chain-name']] || [];
-    var assets = v.assets.map(function (asset) {
-      return _objectSpread(_objectSpread({}, asset), {}, {
-        traces: [{
-          type: 'ibc',
-          counterparty: {
-            // source_channel
-            channel: v.counterparty['channel-id'],
-            // source_denom
-            denom: asset.denom_units[0].aliases[0],
-            chain_name: v.counterparty['chain-name'] // port: v.counterparty['port-id']
-
-          },
-          chain: {
-            // dst_denom
-            channel: v.chain['channel-id'] // chain_name: v.chain['chain-name'],
-            // port: v.chain['port-id']
-
-          }
-        }]
-      });
-    });
-
-    var obj = _objectSpread(_objectSpread({}, v), {}, {
-      assets: assets
-    });
-
-    m[v.chain['chain-name']].push(obj);
-    return m;
-  }, {});
-  return Object.keys(hash).map(function (chain) {
-    return {
-      chain_name: chain,
-      assets: hash[chain].reduce(function (m, v) {
-        return [].concat((0, _toConsumableArray2["default"])(m), (0, _toConsumableArray2["default"])(v.assets));
-      }, [])
-    };
-  });
-};
-
-exports.getIbcAssets = getIbcAssets;
-
-var getCw20Assets = function getCw20Assets(chainName, ibc, assets) {
-  var chainIbcInfo = ibc.filter(function (i) {
-    return i['chain-1']['chain-name'] === chainName || i['chain-2']['chain-name'] === chainName;
-  });
-  var cw20AssetLists = chainIbcInfo.map(function (ibcInfo) {
-    var counterpartyIs = ibcInfo['chain-1']['chain-name'] === chainName ? 'chain-2' : 'chain-1';
-    var chainIs = ibcInfo['chain-1']['chain-name'] === chainName ? 'chain-1' : 'chain-2';
-    var counterparty = ibcInfo[counterpartyIs]['chain-name'];
-    var counterpartyIbc = ibcInfo[counterpartyIs];
-    var chainIbc = ibcInfo[chainIs];
-    var counterpartyAssets = assets.find(function (a) {
-      return a.chain_name === counterparty;
-    });
-
-    if (!counterpartyAssets) {
-      console.warn('asset not found: ' + counterparty);
-      return;
-    }
-
-    var cw20Assets = counterpartyAssets.assets.filter(function (a) {
-      return a.base.startsWith('cw20:');
-    }).map(function (asset) {
-      var denom = getIbcDenomByBaseForCw20(ibc, chainName, counterparty, //
-      assets, asset.base);
-
-      var newAsset = _objectSpread({}, asset);
-
-      newAsset.base = denom;
-      newAsset.denom_units = newAsset.denom_units.map(function (unit) {
-        if (unit.denom === asset.base) {
-          var newUnit = _objectSpread({}, unit);
-
-          newUnit.denom = denom;
-          newUnit.aliases = [unit.denom];
-          return newUnit;
-        }
+});
 
-        return unit;
-      });
-      return newAsset;
-    });
-    if (!cw20Assets.length) return;
-    var channel = getWasmChannel(ibcInfo);
+var _utils = require("./utils");
 
-    if (!channel) {
-      console.warn(chainIbc['chain-name'], '<>', counterpartyIbc['chain-name'], 'MISSING cw20 IBC info');
-      return;
+Object.keys(_utils).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _utils[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _utils[key];
     }
-
-    return {
-      chain: _objectSpread(_objectSpread({}, chainIbc), channel[chainIs]),
-      counterparty: _objectSpread(_objectSpread({}, counterpartyIbc), channel[counterpartyIs]),
-      assets: cw20Assets
-    };
-  }).filter(Boolean);
-  var hash = cw20AssetLists.reduce(function (m, v) {
-    m[v.chain['chain-name']] = m[v.chain['chain-name']] || [];
-    var assets = v.assets.map(function (asset) {
-      return _objectSpread(_objectSpread({}, asset), {}, {
-        traces: [{
-          type: 'ibc',
-          counterparty: {
-            port: v.counterparty['port-id'],
-            // source_channel
-            channel: v.counterparty['channel-id'],
-            // source_denom
-            denom: asset.denom_units[0].aliases[0],
-            chain_name: v.counterparty['chain-name']
-          },
-          chain: {
-            // dst_denom
-            port: v.chain['port-id'],
-            channel: v.chain['channel-id'] // chain_name: v.chain['chain-name'],
-
-          }
-        }]
-      });
-    });
-
-    var obj = _objectSpread(_objectSpread({}, v), {}, {
-      assets: assets
-    });
-
-    m[v.chain['chain-name']].push(obj);
-    return m;
-  }, {});
-  return Object.keys(hash).map(function (chain) {
-    return {
-      chain_name: chain,
-      assets: hash[chain].reduce(function (m, v) {
-        return [].concat((0, _toConsumableArray2["default"])(m), (0, _toConsumableArray2["default"])(v.assets));
-      }, [])
-    };
   });
-};
-
-exports.getCw20Assets = getCw20Assets;
-
-var getAssetLists = function getAssetLists(chainName, ibc, assets) {
-  var ibcAssetLists = getIbcAssets(chainName, ibc, assets);
-  var cw20Assets = getCw20Assets(chainName, ibc, assets);
-  return ibcAssetLists.reduce(function (m, v) {
-    var chain = v.chain_name;
-    var assets = (0, _toConsumableArray2["default"])(v.assets);
-    var cw20 = cw20Assets.find(function (a) {
-      return a.chain_name === chain;
-    });
-
-    if (cw20) {
-      [].push.apply(assets, cw20.assets);
-    }
-
-    return [{
-      chain_name: chain,
-      assets: assets
-    }].concat((0, _toConsumableArray2["default"])(m));
-  }, []);
-};
-
-exports.getAssetLists = getAssetLists;
+});