essential-eth 0.4.9-beta.1 → 0.4.9-beta.4

package/lib/esm/shared/tiny-big/helpers.d.ts

@@ -0,0 +1 @@
+export declare function scientificStrToDecimalStr(scientificString: string): string;

package/lib/esm/shared/tiny-big/helpers.js

@@ -0,0 +1,58 @@
+function stripTrailingZeroes(numberString) {
+    const isNegative = numberString.startsWith('-');
+    numberString = numberString.replace('-', '');
+    numberString = numberString.replace(/\.0*$/g, '');
+    numberString = numberString.replace(/^0+/, '');
+    if (numberString.includes('.')) {
+        numberString = numberString.replace(/0+$/, '');
+    }
+    if (numberString.startsWith('.')) {
+        numberString = `0${numberString}`;
+    }
+    return `${isNegative ? '-' : ''}${numberString}`;
+}
+export function scientificStrToDecimalStr(scientificString) {
+    if (!scientificString.match(/e/i)) {
+        return stripTrailingZeroes(scientificString);
+    }
+    let [base, power] = scientificString.split(/e/i);
+    const isNegative = Number(base) < 0;
+    base = base.replace('-', '');
+    base = stripTrailingZeroes(base);
+    const [wholeNumber, fraction = ''] = base.split('.');
+    if (Number(power) === 0) {
+        return `${isNegative ? '-' : ''}${stripTrailingZeroes(base)}`;
+    }
+    else {
+        const includesDecimal = base.includes('.');
+        if (!includesDecimal) {
+            base = `${base}.`;
+        }
+        base = base.replace('.', '');
+        const baseLength = base.length;
+        let splitPaddedNumber;
+        if (Number(power) < 0) {
+            if (wholeNumber.length < Math.abs(Number(power))) {
+                base = base.padStart(baseLength + Math.abs(Number(power)) - wholeNumber.length, '0');
+            }
+            splitPaddedNumber = base.split('');
+            if (wholeNumber.length < Math.abs(Number(power))) {
+                splitPaddedNumber = ['.', ...splitPaddedNumber];
+            }
+            else {
+                splitPaddedNumber.splice(splitPaddedNumber.length - Math.abs(Number(power)), 0, '.');
+            }
+        }
+        else {
+            if (fraction.length < Math.abs(Number(power))) {
+                base = base.padEnd(baseLength + Math.abs(Number(power)) - fraction.length, '0');
+            }
+            splitPaddedNumber = base.split('');
+            if (fraction.length > Math.abs(Number(power))) {
+                splitPaddedNumber.splice(splitPaddedNumber.length - Math.abs(Number(power)), 0, '.');
+            }
+        }
+        const toReturn = stripTrailingZeroes(splitPaddedNumber.join(''));
+        return `${isNegative ? '-' : ''}${toReturn}`;
+    }
+}

package/lib/esm/shared/tiny-big/tiny-big.d.ts

@@ -0,0 +1,8 @@
+import Big from 'big.js';
+export declare class TinyBig extends Big {
+    constructor(value: string | number | TinyBig | Big);
+    toHexString(): string;
+    toNumber(): number;
+    toString(): string;
+}
+export declare function tinyBig(value: string | number | TinyBig | Big): TinyBig;

package/lib/esm/shared/tiny-big/tiny-big.js

@@ -0,0 +1,22 @@
+import Big from 'big.js';
+import { scientificStrToDecimalStr } from './helpers';
+export class TinyBig extends Big {
+    constructor(value) {
+        super(value);
+    }
+    toHexString() {
+        return `0x${BigInt(this.toString()).toString(16)}`;
+    }
+    toNumber() {
+        return Number(scientificStrToDecimalStr(super.toString()));
+    }
+    toString() {
+        if (this.toNumber() === 0) {
+            return '0';
+        }
+        return scientificStrToDecimalStr(super.toString());
+    }
+}
+export function tinyBig(value) {
+    return new TinyBig(value);
+}

package/lib/esm/shared/validate-type.d.ts

@@ -0,0 +1,3 @@
+declare type JSPrimitiveTypes = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
+export declare const validateType: (value: unknown, allowedTypes: JSPrimitiveTypes[]) => void;
+export {};

package/lib/esm/shared/validate-type.js

@@ -0,0 +1,5 @@
+export const validateType = (value, allowedTypes) => {
+    if (!allowedTypes.includes(typeof value)) {
+        throw new Error(`${allowedTypes.join(' or ')} required. Received ${typeof value}`);
+    }
+};

package/lib/esm/types/Block.types.d.ts

@@ -0,0 +1,47 @@
+import { RPCTransaction, Transaction } from './Transaction.types';
+export interface Block {
+    baseFeePerGas: string;
+    difficulty: number;
+    extraData: string;
+    gasLimit: number;
+    gasUsed: number;
+    hash: string;
+    logsBloom: string;
+    miner: string;
+    mixHash: string;
+    nonce: string;
+    number: number;
+    parentHash: string;
+    receiptsRoot: string;
+    sha3Uncles: string;
+    size: number;
+    stateRoot: string;
+    timestamp: number;
+    totalDifficulty: number;
+    transactions: string[] | Transaction[];
+    transactionsRoot: string;
+    uncles: unknown[];
+}
+export interface RPCBlock {
+    baseFeePerGas: string;
+    difficulty: string;
+    extraData: string;
+    gasLimit: string;
+    gasUsed: string;
+    hash: string;
+    logsBloom: string;
+    miner: string;
+    mixHash: string;
+    nonce: string;
+    number: string;
+    parentHash: string;
+    receiptsRoot: string;
+    sha3Uncles: string;
+    size: string;
+    stateRoot: string;
+    timestamp: string;
+    totalDifficulty: string;
+    transactions: Array<string> | Array<RPCTransaction>;
+    transactionsRoot: string;
+    uncles: unknown[];
+}

package/lib/esm/types/Block.types.js

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

package/lib/esm/types/Contract.types.d.ts

@@ -0,0 +1,24 @@
+export declare type ContractTypes = 'bool' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | 'bytes17' | 'bytes18' | 'bytes19' | 'bytes20' | 'bytes21' | 'bytes22' | 'bytes23' | 'bytes24' | 'bytes25' | 'bytes26' | 'bytes27' | 'bytes28' | 'bytes29' | 'bytes30' | 'bytes31' | 'bytes32' | 'bytes32[]' | 'address' | 'address payable' | 'address[4]' | 'address[100]' | 'uint256' | 'uint256[100]' | 'uint8' | 'uint32' | string;
+export declare type ContractInterface = JSONABI;
+export declare type ContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
+export interface JSONABIArgument {
+    anonymous?: false;
+    inputs: {
+        internalType?: ContractTypes | string;
+        name: string;
+        type: ContractTypes;
+        indexed?: boolean;
+    }[];
+    name?: string;
+    outputs?: {
+        internalType?: ContractTypes | string;
+        name: string;
+        type: ContractTypes;
+    }[];
+    stateMutability?: 'view' | 'nonpayable' | string;
+    type: 'function' | 'event' | 'constructor' | 'error' | 'fallback';
+    gas?: number;
+    constant?: boolean;
+    payable?: boolean;
+}
+export declare type JSONABI = JSONABIArgument[];

package/lib/esm/types/Contract.types.js

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

package/lib/esm/types/Network.types.d.ts

@@ -0,0 +1,5 @@
+export interface Network {
+    chainId: number;
+    ensAddress: string | null;
+    name: string;
+}

package/lib/esm/types/Network.types.js

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

package/lib/esm/types/Transaction.types.d.ts

@@ -0,0 +1,34 @@
+export interface Transaction {
+    blockHash: string;
+    blockNumber: number;
+    from: string;
+    gas: number;
+    gasPrice: string;
+    hash: string;
+    input: string;
+    nonce: number;
+    r: string;
+    s: string;
+    to: string;
+    transactionIndex: number;
+    type: number;
+    v: string;
+    value: string;
+}
+export interface RPCTransaction {
+    blockHash: string;
+    blockNumber: string;
+    from: string;
+    gas: string;
+    gasPrice: string;
+    hash: string;
+    input: string;
+    nonce: string;
+    r: string;
+    s: string;
+    to: string;
+    transactionIndex: string;
+    type: string;
+    v: string;
+    value: string;
+}

package/lib/esm/types/Transaction.types.js

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

package/lib/esm/utils/ether-to-wei.d.ts

@@ -0,0 +1,3 @@
+import Big from 'big.js';
+import { TinyBig } from '../shared/tiny-big/tiny-big';
+export declare function etherToWei(etherQuantity: string | number | TinyBig | Big): TinyBig;

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

@@ -0,0 +1,7 @@
+import { tinyBig } from '../shared/tiny-big/tiny-big';
+import { validateType } from '../shared/validate-type';
+export function etherToWei(etherQuantity) {
+    validateType(etherQuantity, ['string', 'number', 'object']);
+    const result = tinyBig(etherQuantity).times('1000000000000000000');
+    return tinyBig(result);
+}

package/lib/esm/utils/index.d.ts

@@ -0,0 +1,5 @@
+import { etherToWei } from './ether-to-wei';
+import { isAddress } from './is-address';
+import { toChecksumAddress } from './to-checksum-address';
+import { weiToEther } from './wei-to-ether';
+export { etherToWei, isAddress, toChecksumAddress, weiToEther };

package/lib/esm/utils/index.js

@@ -0,0 +1,5 @@
+import { etherToWei } from './ether-to-wei';
+import { isAddress } from './is-address';
+import { toChecksumAddress } from './to-checksum-address';
+import { weiToEther } from './wei-to-ether';
+export { etherToWei, isAddress, toChecksumAddress, weiToEther };

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

@@ -0,0 +1 @@
+export declare function isAddress(address: string): boolean;

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

@@ -0,0 +1,12 @@
+import { toChecksumAddress } from '..';
+import { validateType } from '../shared/validate-type';
+export function isAddress(address) {
+    validateType(address, ['string']);
+    try {
+        toChecksumAddress(address);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}

package/lib/esm/utils/to-checksum-address.d.ts

@@ -0,0 +1 @@
+export declare function toChecksumAddress(address: string): string;

package/lib/esm/utils/to-checksum-address.js

@@ -0,0 +1,25 @@
+import { Keccak } from 'sha3';
+import { validateType } from '../shared/validate-type';
+export function toChecksumAddress(address) {
+    validateType(address, ['string']);
+    if (!/^(0x)?[0-9a-f]{40}$/i.test(address)) {
+        throw new Error(`Invalid Ethereum address "${address}"`);
+    }
+    const _address = address.toLowerCase().replace(/^0x/i, '');
+    const keccak = new Keccak(256);
+    const addressHash = keccak.update(_address).digest('hex').replace(/^0x/i, '');
+    let checksumAddress = '0x';
+    for (let i = 0; i < _address.length; i++) {
+        if (parseInt(addressHash[i], 16) > 7) {
+            checksumAddress += _address[i].toUpperCase();
+        }
+        else {
+            checksumAddress += _address[i];
+        }
+    }
+    if (address.match(/([A-F].*[a-f])|([a-f].*[A-F])/) &&
+        checksumAddress !== address) {
+        throw new Error(`Invalid Checksum address for "${address}"`);
+    }
+    return checksumAddress;
+}

package/lib/esm/utils/wei-to-ether.d.ts

@@ -0,0 +1,3 @@
+import Big from 'big.js';
+import { TinyBig } from './../shared/tiny-big/tiny-big';
+export declare function weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig;

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

@@ -0,0 +1,7 @@
+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);
+}

package/package.json

@@ -1,29 +1,14 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.4.9-beta.1",
+  "version": "0.4.9-beta.4",
   "license": "MIT",
   "sideEffects": false,
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    },
-    "./utils": {
-      "import": "./dist/esm/utils/index.js",
-      "require": "./dist/cjs/utils/index.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/cjs/index.d.ts"
-      ],
-      "utils": [
-        "./dist/cjs/utils/index.d.ts"
-      ]
-    }
-  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "files": [
+    "lib/"
+  ],
   "bugs": {
     "url": "https://github.com/dawsbot/essential-eth/issues"
   },
@@ -31,11 +16,12 @@
   "author": "@dawsbot",
   "scripts": {
     "test": "npm-run-all --parallel jest compile lint",
+    "test:all-node-versions": "npx trevor",
     "lint": "eslint .",
     "compile": "npm-run-all --parallel tsc:esm tsc:cjs",
     "tsc:esm": "tsc -p tsconfig.json",
     "tsc:cjs": "tsc -p tsconfig-cjs.json",
-    "build": "rm -rf dist && npm run compile",
+    "build": "rm -rf lib && npm run compile",
     "prepublishOnly": "npm run build && npm run build:website && npm run build:website:new-version",
     "jest": "jest",
     "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",

package/.env

@@ -1 +0,0 @@
-RPC_ORIGIN=https://free-eth-node.com

package/.eslintignore

@@ -1,4 +0,0 @@
-website
-dist
-lib
-typedoc

package/.eslintrc.js

@@ -1,34 +0,0 @@
-module.exports = {
-  ignorePatterns: ['scripts/calculate-bundle-size.js', 'test/*.js'],
-  env: {
-    browser: true,
-    es2021: true,
-    node: true,
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:jest/all',
-  ],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 12,
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint', 'jest'],
-  rules: {
-    'no-empty': 'warn',
-    'no-console': 'warn',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    'jest/prefer-expect-assertions': 'off',
-    'jest/require-to-throw-message': 'off',
-    'jest/expect-expect': 'off',
-    'jest/lowercase-name': 'off',
-    'jest/no-disabled-tests': 'warn',
-    'jest/no-commented-out-tests': 'warn',
-    'jest/require-hook': 'warn',
-    'jest/no-conditional-expect': 'error',
-    '@typescript-eslint/ban-ts-comment': 'warn',
-    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
-  },
-};

package/.gitattributes

@@ -1 +0,0 @@
-website/** linguist-generated

package/.github/workflows/test.yml

@@ -1,29 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: 🧪 npm test
-
-on:
-  pull_request:
-    branches: [master]
-  # push:
-  #   branches: [master]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: ['17', '16', '14', '12']
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      - run: npm ci
-      - run: npm test

package/.prettierignore

@@ -1,7 +0,0 @@
-website
-lib
-dist
-coverage
-
-# Autogenerated
-src/providers/utils/chains-info.ts

package/.travis.yml

@@ -1,5 +0,0 @@
-language: node_js
-node_js:
-  - '14'
-  - '12'
-  - '10'

package/jest.config.js

@@ -1,9 +0,0 @@
-module.exports = {
-  roots: ['<rootDir>/test', '<rootDir>/src'],
-  testMatch: ['**/*.test.*'],
-  transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest',
-  },
-  setupFiles: ['dotenv/config'],
-  setupFilesAfterEnv: ['./test/jest.setup-after-env.js'],
-};

package/scripts/build-website.sh

@@ -1,4 +0,0 @@
-# Necessary to not override website/versions
-mv website/versions .versions
-typedoc --options typedoc/options.js
-mv .versions website/versions

package/scripts/bump-minor.sh

@@ -1,4 +0,0 @@
-npm version minor -m "📦 %s"
-npm run build:website
-npm run build:website:new-version
-git push --follow-tags

package/scripts/bump-patch.sh

@@ -1,4 +0,0 @@
-npm version patch -m "📦 %s"
-npm run build:website
-npm run build:website:new-version
-git push --follow-tags

package/scripts/fetch-chains-info.ts

@@ -1,70 +0,0 @@
-import fs from 'fs';
-import unfetch from 'isomorphic-unfetch';
-import path from 'path';
-
-const outputFilePath = path.join(
-  __dirname,
-  '..',
-  'src',
-  'providers',
-  'utils',
-  'chains-info.ts',
-);
-(async () => {
-  const toReturn: any = {};
-  await unfetch('https://chainid.network/chains.json')
-    .then((res) => res.json())
-    .then((data: ChainsData) => {
-      data.forEach((networkInfo) => {
-        const writeableInfo = [networkInfo.shortName];
-
-        const registry = networkInfo?.ens?.registry;
-        if (registry) {
-          writeableInfo.push(registry);
-        }
-        toReturn[networkInfo.chainId] = writeableInfo;
-      });
-    });
-  fs.writeFileSync(
-    outputFilePath,
-    `// autogenerated in "fetch-chains-info.ts"\n// Do not edit directly\nexport default ${JSON.stringify(
-      toReturn,
-      null,
-      2,
-    )}`,
-  );
-})();
-
-type ChainsData = {
-  name: 'Ethereum Mainnet';
-  chain: 'ETH';
-  network: string; // 'mainnet';
-  icon: 'ethereum';
-  rpc: [
-    'https://mainnet.infura.io/v3/${INFURA_API_KEY}',
-    'wss://mainnet.infura.io/ws/v3/${INFURA_API_KEY}',
-    'https://api.mycryptoapi.com/eth',
-    'https://cloudflare-eth.com',
-  ];
-  faucets: [];
-  nativeCurrency: {
-    name: 'Ether';
-    symbol: 'ETH';
-    decimals: 18;
-  };
-  infoURL: 'https://ethereum.org';
-  shortName: string; //'eth';
-  chainId: 1;
-  networkId: 1;
-  slip44: 60;
-  ens: {
-    registry: string; //'0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e';
-  };
-  explorers: [
-    {
-      name: 'etherscan';
-      url: 'https://etherscan.io';
-      standard: 'EIP3091';
-    },
-  ];
-}[];

package/scripts/pre-commit.sh

@@ -1,5 +0,0 @@
-npx npm-check-updates -u  "/.*lint.*$/"
-npx npm-check-updates -u  "/.*jest.*$/"
-npx npm-check-updates -u ethers typescript web3 prettier
-npm install
-