essential-eth 0.5.4 → 0.5.5

package/lib/esm/index.js

@@ -1,11 +1,15 @@
-import { Contract } from './classes/Contract';
-import { FallthroughProvider } from './providers/FallthroughProvider';
+import { BaseContract, Contract } from './classes/Contract';
+import { FallthroughProvider, } from './providers/FallthroughProvider';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
+import { computeAddress } from './utils/compute-address';
+import { computePublicKey } from './utils/compute-public-key';
 import { etherToGwei } from './utils/ether-to-gwei';
 import { etherToWei } from './utils/ether-to-wei';
 import { gweiToEther } from './utils/gwei-to-ether';
+import { hashMessage } from './utils/hash-message';
 import { isAddress } from './utils/is-address';
+import { splitSignature } from './utils/split-signature';
 import { toChecksumAddress } from './utils/to-checksum-address';
 import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
@@ -13,4 +17,4 @@ export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';
 export * from './utils/solidity-keccak256';
-export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, toUtf8Bytes, Contract, TinyBig, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hashMessage, splitSignature, toUtf8Bytes, computeAddress, computePublicKey, Contract, TinyBig, BaseContract, };

package/lib/esm/logger/package-version.d.ts

@@ -1 +1 @@
-export declare const version = "0.5.4";
+export declare const version = "0.5.5";

package/lib/esm/logger/package-version.js

@@ -1 +1 @@
-export const version = '0.5.4';
+export const version = '0.5.5';

package/lib/esm/providers/BaseProvider.d.ts

@@ -9,6 +9,7 @@ export declare abstract class BaseProvider {
     protected _post: (body: Record<string, unknown>) => Promise<any>;
     constructor(rpcUrls: string[]);
     getNetwork(): Promise<Network>;
+    getBlockNumber(): Promise<number>;
     getTransaction(transactionHash: string): Promise<TransactionResponse>;
     getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
     getTransactionCount(address: string, blockTag?: BlockTag): Promise<number>;

package/lib/esm/providers/BaseProvider.js

@@ -32,6 +32,12 @@ export class BaseProvider {
             };
         });
     }
+    getBlockNumber() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentBlockNumber = (yield this.post(buildRPCPostBody('eth_blockNumber', [])));
+            return Number(hexToDecimal(currentBlockNumber));
+        });
+    }
     getTransaction(transactionHash) {
         return __awaiter(this, void 0, void 0, function* () {
             const [rpcTransaction, blockNumber] = yield Promise.all([

package/lib/esm/providers/FallthroughProvider.d.ts

@@ -1,5 +1,5 @@
 import { BaseProvider } from './BaseProvider';
-interface ConstructorOptions {
+export interface ConstructorOptions {
     timeoutDuration?: number;
 }
 export declare class FallthroughProvider extends BaseProvider {
@@ -9,4 +9,3 @@ export declare class FallthroughProvider extends BaseProvider {
     constructor(rpcUrls: string[], options?: ConstructorOptions);
     post: (body: Record<string, unknown>) => Promise<any>;
 }
-export {};

package/lib/esm/providers/utils/chains-info.d.ts

@@ -119,6 +119,7 @@ declare const _default: {
     "222": string[];
     "225": string[];
     "226": string[];
+    "239": string[];
     "246": string[];
     "250": string[];
     "256": string[];
@@ -143,10 +144,14 @@ declare const _default: {
     "499": string[];
     "512": string[];
     "513": string[];
+    "534": string[];
     "555": string[];
     "558": string[];
     "588": string[];
+    "592": string[];
     "595": string[];
+    "596": string[];
+    "597": string[];
     "600": string[];
     "666": string[];
     "686": string[];
@@ -154,6 +159,7 @@ declare const _default: {
     "707": string[];
     "708": string[];
     "721": string[];
+    "776": string[];
     "777": string[];
     "787": string[];
     "788": string[];
@@ -201,14 +207,18 @@ declare const _default: {
     "1620": string[];
     "1657": string[];
     "1688": string[];
+    "1819": string[];
     "1856": string[];
     "1898": string[];
     "1984": string[];
     "1987": string[];
     "2001": string[];
+    "2008": string[];
+    "2009": string[];
     "2020": string[];
     "2021": string[];
     "2022": string[];
+    "2023": string[];
     "2025": string[];
     "2100": string[];
     "2101": string[];
@@ -219,6 +229,8 @@ declare const _default: {
     "2223": string[];
     "2559": string[];
     "2569": string[];
+    "2612": string[];
+    "2613": string[];
     "3000": string[];
     "3001": string[];
     "3331": string[];
@@ -254,6 +266,7 @@ declare const _default: {
     "8723": string[];
     "8724": string[];
     "8888": string[];
+    "8898": string[];
     "8995": string[];
     "9000": string[];
     "9001": string[];
@@ -274,10 +287,13 @@ declare const _default: {
     "19845": string[];
     "21337": string[];
     "21816": string[];
+    "22023": string[];
     "24484": string[];
     "24734": string[];
+    "30067": string[];
     "31102": string[];
     "31337": string[];
+    "32520": string[];
     "32659": string[];
     "39797": string[];
     "42069": string[];

package/lib/esm/providers/utils/chains-info.js

@@ -363,6 +363,9 @@ export default {
     "226": [
         "TLA"
     ],
+    "239": [
+        "AITD"
+    ],
     "246": [
         "ewt"
     ],
@@ -435,6 +438,9 @@ export default {
     "513": [
         "aact"
     ],
+    "534": [
+        "CNDL"
+    ],
     "555": [
         "CLASS"
     ],
@@ -444,9 +450,18 @@ export default {
     "588": [
         "metis-stardust"
     ],
+    "592": [
+        "astr"
+    ],
     "595": [
         "maca"
     ],
+    "596": [
+        "tkar"
+    ],
+    "597": [
+        "taca"
+    ],
     "600": [
         "mesh-chain-testnet"
     ],
@@ -468,6 +483,9 @@ export default {
     "721": [
         "tfeth"
     ],
+    "776": [
+        "opc"
+    ],
     "777": [
         "cth"
     ],
@@ -609,6 +627,9 @@ export default {
     "1688": [
         "LUDAN"
     ],
+    "1819": [
+        "cubet"
+    ],
     "1856": [
         "tsf"
     ],
@@ -624,6 +645,12 @@ export default {
     "2001": [
         "milkAda"
     ],
+    "2008": [
+        "cloudwalk_testnet"
+    ],
+    "2009": [
+        "cloudwalk_mainnet"
+    ],
     "2020": [
         "420"
     ],
@@ -633,6 +660,9 @@ export default {
     "2022": [
         "edgt"
     ],
+    "2023": [
+        "taycan-testnet"
+    ],
     "2025": [
         "rpg"
     ],
@@ -663,6 +693,12 @@ export default {
     "2569": [
         "tpc"
     ],
+    "2612": [
+        "EZChain"
+    ],
+    "2613": [
+        "Fuji-EZChain"
+    ],
     "3000": [
         "cennz-r"
     ],
@@ -768,6 +804,9 @@ export default {
     "8888": [
         "ambrostestnet"
     ],
+    "8898": [
+        "mmt"
+    ],
     "8995": [
         "berg"
     ],
@@ -826,7 +865,10 @@ export default {
         "cennz-a"
     ],
     "21816": [
-        "oml"
+        "omc"
+    ],
+    "22023": [
+        "SFL"
     ],
     "24484": [
         "web"
@@ -834,12 +876,18 @@ export default {
     "24734": [
         "mintme"
     ],
+    "30067": [
+        "Piece"
+    ],
     "31102": [
         "esn"
     ],
     "31337": [
         "got"
     ],
+    "32520": [
+        "Brise"
+    ],
     "32659": [
         "fsn"
     ],
@@ -874,7 +922,7 @@ export default {
         "ALFA"
     ],
     "45000": [
-        "autobahn"
+        "Autobahn Network"
     ],
     "47805": [
         "REI"

package/lib/esm/utils/compute-address.d.ts

@@ -0,0 +1 @@
+export declare function computeAddress(key: string): string;

package/lib/esm/utils/compute-address.js

@@ -0,0 +1,11 @@
+import { computePublicKey, toChecksumAddress } from '..';
+import { hexDataSlice } from './bytes';
+import { keccak256 } from './keccak256';
+export function computeAddress(key) {
+    if (!key.startsWith('0x04') &&
+        !key.startsWith('0x03') &&
+        !key.startsWith('0x02')) {
+        key = computePublicKey(key);
+    }
+    return toChecksumAddress(hexDataSlice(keccak256(hexDataSlice(key, 1)), 12));
+}

package/lib/esm/utils/compute-public-key.d.ts

@@ -0,0 +1,2 @@
+import { BytesLike } from './bytes';
+export declare function computePublicKey(privKey: BytesLike): string;

package/lib/esm/utils/compute-public-key.js

@@ -0,0 +1,6 @@
+import { Point } from '@noble/secp256k1';
+import { hexlify } from './bytes';
+export function computePublicKey(privKey) {
+    privKey = hexlify(privKey).slice(2);
+    return '0x' + Point.fromPrivateKey(privKey).toHex();
+}

package/lib/esm/utils/split-signature.d.ts

@@ -0,0 +1,2 @@
+import { Signature, SignatureLike } from './bytes';
+export declare function splitSignature(signature: SignatureLike): Signature;

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/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.5",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -22,6 +22,7 @@
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
     "build": "rm -rf lib && npm run compile",
+    "build:readme": ". ./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 +30,24 @@
     "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": {
     "@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.25.0",
+    "@typescript-eslint/parser": "^5.25.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",
+    "ethers": "^5.6.7",
     "express": "^4.17.1",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
@@ -58,11 +60,12 @@
     "prettier-plugin-organize-imports": "^2.3.4",
     "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",
     "isomorphic-unfetch": "^3.1.0",