essential-eth 0.4.6 → 0.4.9-beta.0

package/.env

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

package/.eslintignore

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

package/.eslintrc.js

@@ -0,0 +1,34 @@
+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

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

package/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+# 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

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

package/.travis.yml

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

package/jest.config.js

@@ -0,0 +1,9 @@
+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/package.json

@@ -1,14 +1,29 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.4.6",
+  "version": "0.4.9-beta.0",
   "license": "MIT",
   "sideEffects": false,
-  "main": "./lib/cjs/index.js",
-  "module": "./lib/esm/index.js",
-  "files": [
-    "lib/"
-  ],
+  "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"
+      ]
+    }
+  },
   "bugs": {
     "url": "https://github.com/dawsbot/essential-eth/issues"
   },
@@ -16,12 +31,11 @@
   "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 lib && npm run compile",
+    "build": "rm -rf dist && 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()",
@@ -37,33 +51,33 @@
     "@types/jest": "^27.4.1",
     "@types/jest-dev-server": "^5.0.0",
     "@types/node": "^16.10.1",
-    "@types/prettier": "^2.4.0",
+    "@types/prettier": "^2.4.4",
     "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.12.1",
-    "@typescript-eslint/parser": "^5.12.1",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
     "body-parser": "^1.19.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.9.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "ethers": "^5.5.4",
+    "eslint": "^8.12.0",
+    "eslint-plugin-jest": "^26.1.3",
+    "ethers": "^5.6.2",
     "express": "^4.17.1",
     "husky": "^4.3.0",
     "jest": "^27.5.1",
     "jest-dev-server": "^6.0.3",
     "just-omit": "^1.2.0",
-    "lint-staged": "^12.3.4",
+    "lint-staged": "^12.3.7",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.1",
     "prettier-plugin-organize-imports": "^2.3.4",
     "supertest": "^6.1.6",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.12",
-    "typescript": "^4.5.5",
-    "web3": "^1.7.0"
+    "typescript": "^4.6.3",
+    "web3": "^1.7.1"
   },
   "dependencies": {
-    "@types/big.js": "^6.1.2",
+    "@types/big.js": "^6.1.3",
     "big.js": "^6.1.1",
     "isomorphic-unfetch": "^3.1.0",
     "sha3": "^2.1.4"

package/readme.md

@@ -12,7 +12,6 @@
 
 ---
 
-
 <br>
 
 ## Why you should replace Ethers.js and web3
@@ -35,7 +34,7 @@
 - 🧪 Tested to match both `web3` and `ethers`
 - 🌲 Tree-shaking and no side-effects
 - 🙌 Supports multiple JS versions (CommonJS and ESM)
-  - ✅ Node 16, 14, 12, & 10
+  - ✅ Node 17, 16, 14, & 12
   - ✅ Web
 
 <br/>

package/scripts/build-website.sh

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

package/scripts/bump-minor.sh

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

package/scripts/bump-patch.sh

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,70 @@
+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

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

package/src/classes/Contract.ts

@@ -0,0 +1,161 @@
+import { JsonRpcProvider } from '../providers/JsonRpcProvider';
+import { ContractInterface } from '../types/Contract.types';
+import {
+  decodeRPCResponse,
+  encodeData,
+} from './utils/encode-decode-transaction';
+import { buildRPCPostBody, post } from './utils/fetchers';
+function estimateGas(txnData: string) {
+  // https://ethereum.stackexchange.com/questions/1570/what-does-intrinsic-gas-too-low-mean/1694
+  txnData.split('').reduce((previousValue, currentValue) => {
+    // 0 characters are 4 gwei, all others are 48 gwei
+    const characterCost = currentValue === '0' ? 4 : 68;
+    return previousValue + characterCost;
+  }, 0);
+}
+interface Options {
+  gasLimit?: number;
+}
+export class BaseContract {
+  /**
+   * The URL to your Eth node. Consider POKT or Infura
+   */
+  private readonly _address: string;
+  private readonly _provider: JsonRpcProvider;
+
+  /**
+   * @param addressOrName - The ethereum address of the smart-contract
+   * @param contractInterface - The JSON ABI of the smart-contract (like http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw)
+   * @param signerOrProvider - An instantiated essential-eth provider
+   */
+  constructor(
+    addressOrName: string,
+    contractInterface: ContractInterface,
+    signerOrProvider: JsonRpcProvider,
+  ) {
+    this._address = addressOrName;
+    this._provider = signerOrProvider;
+    contractInterface
+      .filter((jsonABIArgument) => jsonABIArgument.type === 'function')
+      .forEach((jsonABIArgument) => {
+        if (
+          'name' in jsonABIArgument &&
+          typeof jsonABIArgument.name === 'string'
+        ) {
+          defineReadOnly(
+            this,
+            jsonABIArgument.name,
+            async (..._args: any[]) => {
+              let functionArguments = _args;
+              let options: Options = {};
+              // remove options from encoding
+              const lastArg = _args[_args.length - 1];
+              if (!Array.isArray(lastArg) && typeof lastArg === 'object') {
+                options = lastArg;
+                functionArguments = _args.slice(0, _args.length - 1);
+              }
+
+              const data = encodeData(jsonABIArgument, functionArguments);
+
+              const decimalGas =
+                typeof options.gasLimit === 'number'
+                  ? options.gasLimit /* user passed in "gasLimit" directly */
+                  : typeof jsonABIArgument?.gas ===
+                    'number' /* ABI specified "gas". */
+                  ? estimateGas(data)
+                  : null;
+              const req = async (): Promise<string> => {
+                return await post(
+                  this._provider._rpcUrl[this._provider._rpcUrlCounter],
+                  buildRPCPostBody('eth_call', [
+                    {
+                      to: this._address.toLowerCase(),
+                      data: data,
+                      // sometimes gas is defined in the ABI
+                      ...(decimalGas
+                        ? { gas: `0x${decimalGas.toString(16)}` }
+                        : {}),
+                    },
+                    'latest',
+                  ]),
+                ).catch((e) => {
+                  if (e.code === 'ENOTFOUND') {
+                    this._provider._rpcUrlCounter++;
+                    return req();
+                  }
+                });
+              };
+              const nodeResponse = await req();
+              return decodeRPCResponse(jsonABIArgument, nodeResponse);
+            },
+          );
+        }
+      });
+  }
+}
+
+/**
+ * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
+ */
+export function defineReadOnly<T>(object: T, name: string, value: any): void {
+  Object.defineProperty(object, name, {
+    enumerable: true,
+    value: value,
+    writable: false,
+  });
+}
+
+/**
+ * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
+ *
+ * @example
+ * ```typescript
+ * import { Contract, JsonRpcProvider } from 'essential-eth';
+ * // UNI airdrop contract
+ * const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
+ * const provider = new JsonRpcProvider();
+ *
+ * const JSONABI = [
+ *   {
+ *     inputs: [
+ *       {
+ *         internalType: 'uint256',
+ *         name: 'index',
+ *         type: 'uint256',
+ *       },
+ *     ],
+ *     name: 'isClaimed',
+ *     outputs: [
+ *       {
+ *         internalType: 'bool',
+ *         name: '',
+ *         type: 'bool',
+ *       },
+ *     ],
+ *     stateMutability: 'view',
+ *     type: 'function',
+ *   },
+ * ]
+ *
+ * const contract = new Contract(
+ *   contractAddress,
+ *   JSONABI,
+ *   provider,
+ * );
+ *
+ * (async () => {
+ *   // prints boolean as to whether index 0 has claimed airdrop or not
+ *   console.log(await contract.isClaimed(0));
+ * })()
+ *
+ *
+ * ```
+ */
+export class Contract extends BaseContract {
+  // The dynamic function names within a given smart-contract
+  /**
+   * The dynamic contract calls on any given contract. Like "isClaimed", "merkleRoot", etc.
+   */
+  readonly [key: string]: any;
+  // readonly [key: string]: ContractFunction | any;
+}