@revoke.cash/chains 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+[![Publish](https://github.com/RevokeCash/chains/actions/workflows/publish-release.yml/badge.svg)](https://github.com/RevokeCash/chains/actions/workflows/publish-release.yml/badge.svg) ![npm](https://img.shields.io/npm/v/@revoke.cash/chains?logoColor=blue)
+
+# Eth Chains
+
+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).
+
+## Installation
+
+```
+yarn add @revoke.cash/chains
+```
+
+### Note on versioning
+
+`@revoke.cash/chains` uses a weekly automated release script that updates its chain data. This release script takes breaking changes into account, so breaking changes (e.g. renamed chains) are released as a new major version, while non-breaking changes (e.g. new chains) are released as a new minor version.
+
+## Usage
+
+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)
+```
+
+### Chain names and ids via Enums:
+
+```ts
+console.log(ChainId.EthereumMainnet) // 1
+console.log(ChainId.BinanceSmartChainMainnet) // 56
+console.log(ChainName.EthereumMainnet) // "Ethereum Mainnet"
+console.log(ChainName.Rinkeby) // "Rinkeby"
+```
+
+### Chain by ID:
+
+```ts
+chains.getById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+// Equivalent
+chains.getById(1)
+```
+
+### Chain by Name:
+
+```ts
+chains.getByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+// Equivalent
+chains.getByName('Ethereum Mainnet')
+```
+
+### Get all Chains:
+
+```ts
+const allChains = chains.all()
+// { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
+```
+
+### Typescript Types:
+
+```ts
+import { Chain, NativeCurrency, Explorer } from '@revoke.cash/chains'
+const ethereum: Chain = chains.getById(ChainId.EthereumMainnet)
+ethereum.chain // 'ETH'
+```

package/dist/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+    "semi": false,
+    "trailingComma": "none",
+    "singleQuote": true,
+    "printWidth": 80,
+    "tabWidth": 2,
+    "arrowParens": "avoid"
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as chains, Chain, ChainId, ChainName, NativeCurrency, Explorer, Parent, chain } from './src';

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chain = exports.ChainName = exports.ChainId = exports.chains = void 0;
+var src_1 = require("./src");
+Object.defineProperty(exports, "chains", { enumerable: true, get: function () { return __importDefault(src_1).default; } });
+Object.defineProperty(exports, "ChainId", { enumerable: true, get: function () { return src_1.ChainId; } });
+Object.defineProperty(exports, "ChainName", { enumerable: true, get: function () { return src_1.ChainName; } });
+Object.defineProperty(exports, "chain", { enumerable: true, get: function () { return src_1.chain; } });

package/dist/src/build.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/build.js

@@ -0,0 +1,105 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var got_1 = __importDefault(require("got"));
+var fs_1 = require("fs");
+var util_1 = require("util");
+var prettier_1 = require("prettier");
+var helpers_1 = require("./helpers");
+var _prettierrc_json_1 = __importDefault(require("../.prettierrc.json"));
+var constants_1 = require("./constants");
+var formatterOptions = __assign(__assign({}, _prettierrc_json_1.default), { parser: 'typescript' });
+var getEnumKey = function (chainName) {
+    var enumKey = helpers_1.capitalize(chainName.replace(/\s/g, ''));
+    // If the key starts with a number or contains ',' or '.' then wrap it in quotes
+    enumKey = !!chainName.match(/^\d|[\-\.\()]/) ? "'" + enumKey + "'" : enumKey;
+    return enumKey;
+};
+var getBuildEnums = function (chains) {
+    return chains
+        .reduce(function (enumStrings, chain, index, array) {
+        var _a;
+        var key = (_a = constants_1.ENUM_KEY_OVERRIDES[chain.chainId]) !== null && _a !== void 0 ? _a : getEnumKey(chain.name);
+        var tail = index === array.length - 1 ? ' }' : ', ';
+        enumStrings[0] += key + " = '" + chain.name + "'" + tail;
+        enumStrings[1] += key + " = " + chain.chainId + tail;
+        return enumStrings;
+    }, ['export enum ChainName { ', 'export enum ChainId { '])
+        .join('\n');
+};
+var generateEnumFile = function (chains) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        fs_1.promises.writeFile('./src/enums.ts', prettier_1.format(getBuildEnums(chains), __assign(__assign({}, _prettierrc_json_1.default), { parser: 'typescript' })));
+        return [2 /*return*/];
+    });
+}); };
+var generateChainsFile = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var 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:
+                chains = _a.sent();
+                return [4 /*yield*/, generateEnumFile(chains).catch(function () {
+                        console.log('Error generating enum file');
+                    })];
+            case 2:
+                _a.sent();
+                chainsJs = chains
+                    .map(function (chain) { return chain.chainId + ": " + util_1.inspect(chain, { depth: null }); })
+                    .join(',\n');
+                fs_1.promises.writeFile('./src/chains.ts', prettier_1.format("import { Chains } from \"./types\"\nexport const chains: Chains = {\n" + chainsJs + "\n}", formatterOptions));
+                return [2 /*return*/];
+        }
+    });
+}); };
+generateChainsFile();

package/dist/src/chains.d.ts

@@ -0,0 +1,2 @@
+import { Chains } from './types';
+export declare const chains: Chains;