@chain-registry/client 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1 (2022-10-20)
+
+**Note:** Version bump only for package @chain-registry/client

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dan Lynch <pyramation@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @chain-registry/client
+
+<p align="center" width="100%">
+    <img height="90" src="https://user-images.githubusercontent.com/545047/190171475-b416f99e-2831-4786-9ba3-a7ff4d95b0d3.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/cosmology-tech/chain-registry/actions/workflows/run-tests.yml">
+    <img height="20" src="https://github.com/cosmology-tech/chain-registry/actions/workflows/run-tests.yml/badge.svg" />
+  </a>
+   <a href="https://github.com/cosmology-tech/chain-registry/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+   <a href="https://www.npmjs.com/package/@chain-registry/client"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/chain-registry?filename=packages%2Fclient%2Fpackage.json"></a>
+</p>
+
+Client for the chain-registry 
+
+
+## Usage
+
+```js
+import { ChainRegistryFetcher, ChainRegistryFetcherOptions } from '@chain-registry/client';
+
+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/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _registry = require("./registry");
+
+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];
+    }
+  });
+});

package/main/registry.js

@@ -0,0 +1,313 @@
+"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 _utils = require("@chain-registry/utils");
+
+var _bfsPath = require("bfs-path");
+
+var _crossFetch = _interopRequireDefault(require("cross-fetch"));
+
+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;

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@chain-registry/client",
+  "version": "1.0.1",
+  "description": "Chain Registry Client",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "homepage": "https://github.com/cosmology-tech/chain-registry",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "main/index.js",
+  "typings": "types/index.d.ts",
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "files": [
+    "types",
+    "main"
+  ],
+  "scripts": {
+    "build": "cross-env BABEL_ENV=production babel src --out-dir main --delete-dir-on-start --extensions \".tsx,.ts,.js\"",
+    "build:ts": "tsc --project ./tsconfig.json",
+    "buidl": "npm run build && npm run build:ts",
+    "prepare": "npm run build",
+    "dev": "cross-env NODE_ENV=development babel-node src/telescope --extensions \".tsx,.ts,.js\"",
+    "watch": "cross-env NODE_ENV=development babel-watch src/telescope --extensions \".tsx,.ts,.js\"",
+    "file": "cross-env NODE_ENV=development babel-watch src/file --extensions \".tsx,.ts,.js\"",
+    "lint": "eslint --ext .ts,.tsx,.js .",
+    "format": "eslint --fix . --ext .ts,.tsx,.js",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:debug": "node --inspect node_modules/.bin/jest --runInBand"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cosmology-tech/chain-registry"
+  },
+  "keywords": [],
+  "bugs": {
+    "url": "https://github.com/cosmology-tech/chain-registry/issues"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.18.10",
+    "@babel/core": "7.19.1",
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/node": "^7.19.1",
+    "@babel/plugin-proposal-class-properties": "7.18.6",
+    "@babel/plugin-proposal-export-default-from": "7.18.10",
+    "@babel/plugin-proposal-object-rest-spread": "7.18.9",
+    "@babel/plugin-transform-runtime": "7.19.1",
+    "@babel/preset-env": "7.19.1",
+    "@babel/preset-typescript": "^7.17.12",
+    "@types/jest": "^29.0.2",
+    "@types/sha.js": "^2.4.0",
+    "@typescript-eslint/eslint-plugin": "5.37.0",
+    "@typescript-eslint/parser": "5.37.0",
+    "babel-core": "7.0.0-bridge.0",
+    "babel-jest": "29.0.3",
+    "babel-watch": "^7.0.0",
+    "cross-env": "^7.0.2",
+    "eslint": "8.23.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-simple-import-sort": "8.0.0",
+    "eslint-plugin-unused-imports": "2.0.0",
+    "jest": "^29.0.3",
+    "long": "^5.2.0",
+    "prettier": "^2.7.0",
+    "regenerator-runtime": "^0.13.7",
+    "ts-jest": "^29.0.1",
+    "typescript": "^4.8.3"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.19.0",
+    "@chain-registry/types": "^0.11.1",
+    "@chain-registry/utils": "^1.0.1",
+    "bfs-path": "^1.0.2",
+    "cross-fetch": "^3.1.5"
+  },
+  "gitHead": "1dc04b938a9bbfb226dc3f91092c98c2c2d4c15a"
+}