@revoke.cash/chains 42.0.0 → 44.0.0

package/README.md

@@ -4,7 +4,7 @@
 
 Helper module for getting EVM chain info from [chainid.network](https://chainid.network/).
 
-Note: This package was initially created by @taylorjdawson. We forked the repository so we can control the release process with an automated script. The original package can be found [here](https://github.com/taylorjdawson/eth-chains).
+Note: This package was initially created by @taylorjdawson. We forked the repository so we can control the release process with an automated script and make additional changes. The original package can be found [here](https://github.com/taylorjdawson/eth-chains).
 
 ## Installation
 
@@ -21,17 +21,7 @@ yarn add @revoke.cash/chains
 Import `chains` methods and enums:
 
 ```ts
-import chains, { ChainId, ChainName } from '@revoke.cash/chains'
-```
-
-### Easily get most popular chains:
-
-```ts
-import { chain } from '@revoke.cash/chains'
-
-console.log(chain.ethereum.rinkeby)
-
-console.log(chain.polygon.mumbai)
+import allChains, { ChainId, ChainName } from '@revoke.cash/chains'
 ```
 
 ### Chain names and ids via Enums:
@@ -46,23 +36,23 @@ console.log(ChainName.Rinkeby) // "Rinkeby"
 ### Chain by ID:
 
 ```ts
-chains.getById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+getChainById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
 // Equivalent
-chains.getById(1)
+getChainById(1)
 ```
 
 ### Chain by Name:
 
 ```ts
-chains.getByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+getChainByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
 // Equivalent
-chains.getByName('Ethereum Mainnet')
+getChainByName('Ethereum Mainnet')
 ```
 
 ### Get all Chains:
 
 ```ts
-const allChains = chains.all()
+const chains = allChains()
 // { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
 ```
 
@@ -70,6 +60,6 @@ const allChains = chains.all()
 
 ```ts
 import { Chain, NativeCurrency, Explorer } from '@revoke.cash/chains'
-const ethereum: Chain = chains.getById(ChainId.EthereumMainnet)
+const ethereum: Chain = getChainById(ChainId.EthereumMainnet)
 ethereum.chain // 'ETH'
 ```

package/dist/src/build.js

@@ -83,16 +83,19 @@ var generateEnumFile = function (chains) { return __awaiter(void 0, void 0, void
     });
 }); };
 var generateChainsFile = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var chains, chainsJs;
+    var initialChains, chains, chainsJs;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, got_1.default('https://chainid.network/chains.json').json()];
             case 1:
+                initialChains = _a.sent();
+                return [4 /*yield*/, annotateIconUrls(initialChains)];
+            case 2:
                 chains = _a.sent();
                 return [4 /*yield*/, generateEnumFile(chains).catch(function () {
                         console.log('Error generating enum file');
                     })];
-            case 2:
+            case 3:
                 _a.sent();
                 chainsJs = chains
                     .map(function (chain) { return chain.chainId + ": " + util_1.inspect(chain, { depth: null }); })
@@ -102,4 +105,24 @@ var generateChainsFile = function () { return __awaiter(void 0, void 0, void 0,
         }
     });
 }); };
+var annotateIconUrls = function (chains) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, Promise.all(chains.map(function (chain) { return __awaiter(void 0, void 0, void 0, function () {
+                var icon, iconURL;
+                var _a;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            if (!chain.icon)
+                                return [2 /*return*/, chain];
+                            return [4 /*yield*/, got_1.default("https://raw.githubusercontent.com/ethereum-lists/chains/master/_data/icons/" + chain.icon + ".json").json()];
+                        case 1:
+                            icon = (_b.sent())[0];
+                            iconURL = (_a = icon === null || icon === void 0 ? void 0 : icon.url) === null || _a === void 0 ? void 0 : _a.replace('ipfs://', 'https://cloudflare-ipfs.com/ipfs/');
+                            return [2 /*return*/, __assign(__assign({}, chain), { iconURL: iconURL })];
+                    }
+                });
+            }); }))];
+    });
+}); };
 generateChainsFile();