essential-eth 0.5.4 → 0.5.9

package/lib/esm/utils/split-signature.js

@@ -0,0 +1,126 @@
+import { logger } from './../logger/logger';
+import { arrayify, hexlify, hexZeroPad, isBytesLike, isHexString, zeroPad, } from './bytes';
+export function splitSignature(signature) {
+    const result = {
+        r: '0x',
+        s: '0x',
+        _vs: '0x',
+        recoveryParam: 0,
+        v: 0,
+        yParityAndS: '0x',
+        compact: '0x',
+    };
+    if (isBytesLike(signature)) {
+        const bytes = arrayify(signature);
+        if (bytes.length === 64) {
+            result.v = 27 + (bytes[32] >> 7);
+            bytes[32] &= 0x7f;
+            result.r = hexlify(bytes.slice(0, 32));
+            result.s = hexlify(bytes.slice(32, 64));
+        }
+        else if (bytes.length === 65) {
+            result.r = hexlify(bytes.slice(0, 32));
+            result.s = hexlify(bytes.slice(32, 64));
+            result.v = bytes[64];
+        }
+        else {
+            logger.throwArgumentError('invalid signature string', 'signature', signature);
+        }
+        if (result.v < 27) {
+            if (result.v === 0 || result.v === 1) {
+                result.v += 27;
+            }
+            else {
+                logger.throwArgumentError('signature invalid v byte', 'signature', signature);
+            }
+        }
+        result.recoveryParam = 1 - (result.v % 2);
+        if (result.recoveryParam) {
+            bytes[32] |= 0x80;
+        }
+        result._vs = hexlify(bytes.slice(32, 64));
+    }
+    else {
+        result.r = signature.r;
+        result.s = signature.s;
+        result.v = signature.v;
+        result.recoveryParam = signature.recoveryParam;
+        result._vs = signature._vs;
+        if (result._vs != null) {
+            const vs_1 = zeroPad(arrayify(result._vs), 32);
+            result._vs = hexlify(vs_1);
+            const recoveryParam = vs_1[0] >= 128 ? 1 : 0;
+            if (result.recoveryParam == null) {
+                result.recoveryParam = recoveryParam;
+            }
+            else if (result.recoveryParam !== recoveryParam) {
+                logger.throwArgumentError('signature recoveryParam mismatch _vs', 'signature', signature);
+            }
+            vs_1[0] &= 0x7f;
+            const s = hexlify(vs_1);
+            if (result.s == null) {
+                result.s = s;
+            }
+            else if (result.s !== s) {
+                logger.throwArgumentError('signature v mismatch _vs', 'signature', signature);
+            }
+        }
+        if (result.recoveryParam == null) {
+            if (result.v == null) {
+                logger.throwArgumentError('signature missing v and recoveryParam', 'signature', signature);
+            }
+            else if (result.v === 0 || result.v === 1) {
+                result.recoveryParam = result.v;
+            }
+            else {
+                result.recoveryParam = 1 - (result.v % 2);
+            }
+        }
+        else {
+            if (result.v == null) {
+                result.v = 27 + result.recoveryParam;
+            }
+            else {
+                const recId = result.v === 0 || result.v === 1 ? result.v : 1 - (result.v % 2);
+                if (result.recoveryParam !== recId) {
+                    logger.throwArgumentError('signature recoveryParam mismatch v', 'signature', signature);
+                }
+            }
+        }
+        if (result.r == null || !isHexString(result.r)) {
+            logger.throwArgumentError('signature missing or invalid r', 'signature', signature);
+        }
+        else {
+            result.r = hexZeroPad(result.r, 32);
+        }
+        if (result.s == null || !isHexString(result.s)) {
+            logger.throwArgumentError('signature missing or invalid s', 'signature', signature);
+        }
+        else {
+            result.s = hexZeroPad(result.s, 32);
+        }
+        const vs = arrayify(result.s);
+        if (vs[0] >= 128) {
+            logger.throwArgumentError('signature s out of range', 'signature', signature);
+        }
+        if (result.recoveryParam) {
+            vs[0] |= 0x80;
+        }
+        const _vs = hexlify(vs);
+        if (result._vs) {
+            if (!isHexString(result._vs)) {
+                logger.throwArgumentError('signature invalid _vs', 'signature', signature);
+            }
+            result._vs = hexZeroPad(result._vs, 32);
+        }
+        if (result._vs == null) {
+            result._vs = _vs;
+        }
+        else if (result._vs !== _vs) {
+            logger.throwArgumentError('signature _vs mismatch v and s', 'signature', signature);
+        }
+    }
+    result.yParityAndS = result._vs;
+    result.compact = result.r + result.yParityAndS.substring(2);
+    return result;
+}

package/lib/esm/utils/wei-to-ether.js

@@ -2,6 +2,15 @@ import { tinyBig } from '../shared/tiny-big/tiny-big';
 import { validateType } from '../shared/validate-type';
 export function weiToEther(weiQuantity) {
     validateType(weiQuantity, ['string', 'number', 'object']);
-    const result = tinyBig(weiQuantity).div('1000000000000000000');
-    return tinyBig(result);
+    try {
+        let _weiQuantity = weiQuantity;
+        if (typeof weiQuantity === 'string' && weiQuantity.slice(0, 2) === '0x') {
+            _weiQuantity = BigInt(weiQuantity).toString();
+        }
+        const result = tinyBig(_weiQuantity).div('1000000000000000000');
+        return tinyBig(result);
+    }
+    catch (error) {
+        throw error;
+    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
-  "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.5.4",
+  "description": "Ultralight JS for Ethereum",
+  "version": "0.5.9",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -14,7 +14,28 @@
   },
   "repository": "https://github.com/dawsbot/essential-eth.git",
   "author": "@dawsbot",
+  "size-limit": [
+    {
+      "name": "etherToWei",
+      "path": "src/index.ts",
+      "import": "{ etherToWei }",
+      "limit": "3.9kb"
+    },
+    {
+      "name": "JsonRpcProvider",
+      "path": "src/index.ts",
+      "import": "{ JsonRpcProvider }",
+      "limit": "22kb"
+    },
+    {
+      "name": "Contract",
+      "path": "src/index.ts",
+      "import": "{ Contract }",
+      "limit": "18kb"
+    }
+  ],
   "scripts": {
+    "size": "size-limit",
     "test": "npm-run-all --parallel jest compile lint",
     "test:all-node-versions": "npx trevor",
     "lint": "eslint --cache --fix .",
@@ -22,6 +43,7 @@
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
     "build": "rm -rf lib && npm run compile",
+    "build:readme": "bash ./scripts/markdown-magic/build-readme.sh",
     "jest": "jest",
     "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",
     "update-deps": "sh ./scripts/pre-commit.sh",
@@ -29,23 +51,26 @@
     "prepare": "husky install",
     "version": "npx genversion --es6 src/logger/package-version.ts && git add src/logger/package-version.ts",
     "postversion": "git push --follow-tags",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "doc": "typedoc"
   },
   "devDependencies": {
+    "@size-limit/preset-small-lib": "^7.0.8",
     "@types/body-parser": "^1.19.1",
-    "@types/eslint": "^8.4.1",
+    "@types/eslint": "^8.4.2",
     "@types/express": "^4.17.13",
     "@types/jest": "^27.4.1",
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
     "@types/prettier": "^2.4.4",
-    "@typescript-eslint/eslint-plugin": "^5.21.0",
-    "@typescript-eslint/parser": "^5.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.14.0",
-    "eslint-plugin-jest": "^26.1.5",
-    "ethers": "^5.6.4",
+    "eslint": "^8.16.0",
+    "eslint-plugin-jest": "^26.2.2",
+    "eslint-plugin-jsdoc": "38.0.2",
+    "ethers": "^5.6.8",
     "express": "^4.17.1",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
@@ -56,15 +81,17 @@
     "perf_hooks": "^0.0.1",
     "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
+    "size-limit": "^7.0.8",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
-    "typedoc": "^0.22.13",
+    "typedoc": "^0.22.15",
     "typescript": "^4.6.4",
     "web3": "^1.7.3"
   },
   "dependencies": {
+    "@noble/secp256k1": "^1.5.5",
     "@types/big.js": "^6.1.3",
-    "big.js": "^6.1.1",
+    "big.js": "^6.2.0",
     "isomorphic-unfetch": "^3.1.0",
     "sha3": "^2.1.4"
   },