@qevm/networks 5.7.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Richard Moore
+
+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,33 @@
+QuantumEVM Network Definitions
+======================================
+
+This sub-module is part of the qethers, a fork of [ethers project](https://github.com/ethers-io/ethers.js).
+
+It is responsible for tracking common networks along with important
+parameters for each.
+
+
+Importing
+---------
+
+Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/@qevm/qethers),
+but for those with more specific needs, individual components can be imported.
+
+```javascript
+const {
+
+    getNetwork,
+
+    // Types
+
+    Network,
+    Networkish
+
+} = require("@qevm/networks");
+```
+
+
+License
+-------
+
+MIT License

package/lib/_version.d.ts

@@ -0,0 +1,2 @@
+export declare const version = "networks/5.7.2";
+//# sourceMappingURL=_version.d.ts.map

package/lib/_version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_version.d.ts","sourceRoot":"","sources":["../src.ts/_version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,mBAAmB,CAAC"}

package/lib/_version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = void 0;
+exports.version = "networks/5.7.2";
+//# sourceMappingURL=_version.js.map

package/lib/_version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_version.js","sourceRoot":"","sources":["../src.ts/_version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,gBAAgB,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+import { Network, Networkish } from "./types";
+export { Network, Networkish };
+/**
+ *  getNetwork
+ *
+ *  Converts a named common networks or chain ID (network ID) to a Network
+ *  and verifies a network is a valid Network..
+ */
+export declare function getNetwork(network: Networkish): Network;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src.ts/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAoE/B;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CA+EvD"}

package/lib/index.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetwork = getNetwork;
+const logger_1 = require("@qevm/logger");
+const _version_1 = require("./_version");
+const logger = new logger_1.Logger(_version_1.version);
+function isRenetworkable(value) {
+    return value && typeof value.renetwork === "function";
+}
+function qevmDefaultProvider(network) {
+    const func = function (providers, options) {
+        if (options == null) {
+            options = {};
+        }
+        const providerList = [];
+        if (providers.BlockscoutProvider && options.blockscout !== "-") {
+            try {
+                providerList.push(new providers.BlockscoutProvider(network, options.blockscout));
+            }
+            catch (error) { }
+        }
+        if (providerList.length === 0) {
+            return null;
+        }
+        if (providers.FallbackProvider) {
+            let quorum = 1;
+            if (options.quorum != null) {
+                quorum = options.quorum;
+            }
+            else if (network === "mainnet") {
+                quorum = 2;
+            }
+            return new providers.FallbackProvider(providerList, quorum);
+        }
+        return providerList[0];
+    };
+    func.renetwork = function (network) {
+        return qevmDefaultProvider(network);
+    };
+    return func;
+}
+const poseidon = {
+    chainId: 15,
+    ensAddress: "0x0000000000000000000000000000000000000000000000000000000000000000", // TODO: Add Poseidon ENS address
+    name: "poseidon",
+    _defaultProvider: qevmDefaultProvider("poseidon"),
+};
+const networks = {
+    unspecified: { chainId: 0, name: "unspecified" },
+    testnet: poseidon,
+};
+/**
+ *  getNetwork
+ *
+ *  Converts a named common networks or chain ID (network ID) to a Network
+ *  and verifies a network is a valid Network..
+ */
+function getNetwork(network) {
+    // No network (null)
+    if (network == null) {
+        return null;
+    }
+    if (typeof network === "number") {
+        for (const name in networks) {
+            const standard = networks[name];
+            if (standard.chainId === network) {
+                return {
+                    name: standard.name,
+                    chainId: standard.chainId,
+                    ensAddress: standard.ensAddress || null,
+                    _defaultProvider: standard._defaultProvider || null,
+                };
+            }
+        }
+        return {
+            chainId: network,
+            name: "unknown",
+        };
+    }
+    if (typeof network === "string") {
+        const standard = networks[network];
+        if (standard == null) {
+            return null;
+        }
+        return {
+            name: standard.name,
+            chainId: standard.chainId,
+            ensAddress: standard.ensAddress,
+            _defaultProvider: standard._defaultProvider || null,
+        };
+    }
+    const standard = networks[network.name];
+    // Not a standard network; check that it is a valid network in general
+    if (!standard) {
+        if (typeof network.chainId !== "number") {
+            logger.throwArgumentError("invalid network chainId", "network", network);
+        }
+        return network;
+    }
+    // Make sure the chainId matches the expected network chainId (or is 0; disable EIP-155)
+    if (network.chainId !== 0 && network.chainId !== standard.chainId) {
+        logger.throwArgumentError("network chainId mismatch", "network", network);
+    }
+    // @TODO: In the next major version add an attach function to a defaultProvider
+    // class and move the _defaultProvider internal to this file (extend Network)
+    let defaultProvider = network._defaultProvider || null;
+    if (defaultProvider == null && standard._defaultProvider) {
+        if (isRenetworkable(standard._defaultProvider)) {
+            defaultProvider = standard._defaultProvider.renetwork(network);
+        }
+        else {
+            defaultProvider = standard._defaultProvider;
+        }
+    }
+    // Standard Network (allow overriding the ENS address)
+    return {
+        name: network.name,
+        chainId: standard.chainId,
+        ensAddress: network.ensAddress || standard.ensAddress || null,
+        _defaultProvider: defaultProvider,
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src.ts/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAkFb,gCA+EC;AA/JD,yCAAsC;AACtC,yCAAqC;AACrC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,kBAAO,CAAC,CAAC;AAYnC,SAAS,eAAe,CAAC,KAAU;IAC/B,OAAO,KAAK,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,CAAC;AAC1D,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAyB;IAClD,MAAM,IAAI,GAAG,UAAU,SAAc,EAAE,OAAa;QAChD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,GAAG,EAAE,CAAC;QACjB,CAAC;QACD,MAAM,YAAY,GAAe,EAAE,CAAC;QAEpC,IAAI,SAAS,CAAC,kBAAkB,IAAI,OAAO,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;YAC7D,IAAI,CAAC;gBACD,YAAY,CAAC,IAAI,CACb,IAAI,SAAS,CAAC,kBAAkB,CAC5B,OAAO,EACP,OAAO,CAAC,UAAU,CACrB,CACJ,CAAC;YACN,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC,CAAA,CAAC;QACtB,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAC7B,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC5B,CAAC;iBAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,GAAG,CAAC,CAAC;YACf,CAAC;YACD,OAAO,IAAI,SAAS,CAAC,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEF,IAAI,CAAC,SAAS,GAAG,UAAU,OAAgB;QACvC,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,QAAQ,GAAY;IACtB,OAAO,EAAE,EAAE;IACX,UAAU,EACN,oEAAoE,EAAE,iCAAiC;IAC3G,IAAI,EAAE,UAAU;IAChB,gBAAgB,EAAE,mBAAmB,CAAC,UAAU,CAAC;CACpD,CAAC;AAEF,MAAM,QAAQ,GAAgC;IAC1C,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE;IAEhD,OAAO,EAAE,QAAQ;CACpB,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,OAAmB;IAC1C,oBAAoB;IACpB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,QAAQ,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;gBAC/B,OAAO;oBACH,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzB,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,IAAI;oBACvC,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,IAAI,IAAI;iBACtD,CAAC;YACN,CAAC;QACL,CAAC;QAED,OAAO;YACH,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,SAAS;SAClB,CAAC;IACN,CAAC;IAED,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,IAAI,IAAI;SACtD,CAAC;IACN,CAAC;IAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,sEAAsE;IACtE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACtC,MAAM,CAAC,kBAAkB,CACrB,yBAAyB,EACzB,SAAS,EACT,OAAO,CACV,CAAC;QACN,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,wFAAwF;IACxF,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChE,MAAM,CAAC,kBAAkB,CACrB,0BAA0B,EAC1B,SAAS,EACT,OAAO,CACV,CAAC;IACN,CAAC;IAED,+EAA+E;IAC/E,6EAA6E;IAC7E,IAAI,eAAe,GAAwB,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC;IAC5E,IAAI,eAAe,IAAI,IAAI,IAAI,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QACvD,IAAI,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC7C,eAAe,GAAG,QAAQ,CAAC,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACJ,eAAe,GAAG,QAAQ,CAAC,gBAAgB,CAAC;QAChD,CAAC;IACL,CAAC;IAED,sDAAsD;IACtD,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,IAAI,IAAI;QAC7D,gBAAgB,EAAE,eAAe;KACpC,CAAC;AACN,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,8 @@
+export type Network = {
+    name: string;
+    chainId: number;
+    ensAddress?: string;
+    _defaultProvider?: (providers: any, options?: any) => any;
+};
+export type Networkish = Network | string | number;
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src.ts/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src.ts/types.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+    "contributors": [
+        "Eugene Kuleshov <kulevgen32@gmail.com>",
+        "Richard Moore <me@ricmoo.com>"
+    ],
+    "dependencies": {
+        "@qevm/logger": "^5.7.1"
+    },
+    "description": "Network definitions for qethers.",
+    "keywords": [
+        "QEVM",
+        "QuantumEVM",
+        "qethers"
+    ],
+    "license": "MIT",
+    "main": "./lib/index.js",
+    "module": "./lib.esm/index.js",
+    "name": "@qevm/networks",
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "sideEffects": false,
+    "tarballHash": "0x7d5f9d59cb0cbfaba26d9dc4d43610a2d647ee7ce211f07b180a8c5e347f5724",
+    "types": "./lib/index.d.ts",
+    "version": "5.7.2"
+}

package/src.ts/_version.ts

@@ -0,0 +1 @@
+export const version = "networks/5.7.2";

package/src.ts/index.ts

@@ -0,0 +1,162 @@
+"use strict";
+
+import { Logger } from "@qevm/logger";
+import { version } from "./_version";
+const logger = new Logger(version);
+
+import { Network, Networkish } from "./types";
+
+export { Network, Networkish };
+
+type DefaultProviderFunc = (providers: any, options?: any) => any;
+
+interface Renetworkable extends DefaultProviderFunc {
+    renetwork: (network: Network) => DefaultProviderFunc;
+}
+
+function isRenetworkable(value: any): value is Renetworkable {
+    return value && typeof value.renetwork === "function";
+}
+
+function qevmDefaultProvider(network: string | Network): Renetworkable {
+    const func = function (providers: any, options?: any): any {
+        if (options == null) {
+            options = {};
+        }
+        const providerList: Array<any> = [];
+
+        if (providers.BlockscoutProvider && options.blockscout !== "-") {
+            try {
+                providerList.push(
+                    new providers.BlockscoutProvider(
+                        network,
+                        options.blockscout,
+                    ),
+                );
+            } catch (error) {}
+        }
+
+        if (providerList.length === 0) {
+            return null;
+        }
+
+        if (providers.FallbackProvider) {
+            let quorum = 1;
+            if (options.quorum != null) {
+                quorum = options.quorum;
+            } else if (network === "mainnet") {
+                quorum = 2;
+            }
+            return new providers.FallbackProvider(providerList, quorum);
+        }
+
+        return providerList[0];
+    };
+
+    func.renetwork = function (network: Network) {
+        return qevmDefaultProvider(network);
+    };
+
+    return func;
+}
+
+const poseidon: Network = {
+    chainId: 15,
+    ensAddress:
+        "0x0000000000000000000000000000000000000000000000000000000000000000", // TODO: Add Poseidon ENS address
+    name: "poseidon",
+    _defaultProvider: qevmDefaultProvider("poseidon"),
+};
+
+const networks: { [name: string]: Network } = {
+    unspecified: { chainId: 0, name: "unspecified" },
+
+    testnet: poseidon,
+};
+
+/**
+ *  getNetwork
+ *
+ *  Converts a named common networks or chain ID (network ID) to a Network
+ *  and verifies a network is a valid Network..
+ */
+export function getNetwork(network: Networkish): Network {
+    // No network (null)
+    if (network == null) {
+        return null;
+    }
+
+    if (typeof network === "number") {
+        for (const name in networks) {
+            const standard = networks[name];
+            if (standard.chainId === network) {
+                return {
+                    name: standard.name,
+                    chainId: standard.chainId,
+                    ensAddress: standard.ensAddress || null,
+                    _defaultProvider: standard._defaultProvider || null,
+                };
+            }
+        }
+
+        return {
+            chainId: network,
+            name: "unknown",
+        };
+    }
+
+    if (typeof network === "string") {
+        const standard = networks[network];
+        if (standard == null) {
+            return null;
+        }
+        return {
+            name: standard.name,
+            chainId: standard.chainId,
+            ensAddress: standard.ensAddress,
+            _defaultProvider: standard._defaultProvider || null,
+        };
+    }
+
+    const standard = networks[network.name];
+
+    // Not a standard network; check that it is a valid network in general
+    if (!standard) {
+        if (typeof network.chainId !== "number") {
+            logger.throwArgumentError(
+                "invalid network chainId",
+                "network",
+                network,
+            );
+        }
+        return network;
+    }
+
+    // Make sure the chainId matches the expected network chainId (or is 0; disable EIP-155)
+    if (network.chainId !== 0 && network.chainId !== standard.chainId) {
+        logger.throwArgumentError(
+            "network chainId mismatch",
+            "network",
+            network,
+        );
+    }
+
+    // @TODO: In the next major version add an attach function to a defaultProvider
+    // class and move the _defaultProvider internal to this file (extend Network)
+    let defaultProvider: DefaultProviderFunc = network._defaultProvider || null;
+    if (defaultProvider == null && standard._defaultProvider) {
+        if (isRenetworkable(standard._defaultProvider)) {
+            defaultProvider = standard._defaultProvider.renetwork(network);
+        } else {
+            defaultProvider = standard._defaultProvider;
+        }
+    }
+
+    // Standard Network (allow overriding the ENS address)
+    return {
+        name: network.name,
+        chainId: standard.chainId,
+        ensAddress: network.ensAddress || standard.ensAddress || null,
+        _defaultProvider: defaultProvider,
+    };
+}

package/src.ts/types.ts

@@ -0,0 +1,10 @@
+"use strict";
+
+export type Network = {
+    name: string;
+    chainId: number;
+    ensAddress?: string;
+    _defaultProvider?: (providers: any, options?: any) => any;
+};
+
+export type Networkish = Network | string | number;