essential-eth 0.10.3 → 0.11.1

package/package.json

@@ -1,22 +1,26 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS for Ethereum",
-  "version": "0.10.3",
+  "version": "0.11.1",
   "license": "MIT",
   "sideEffects": false,
   "type": "module",
   "private": false,
-  "main": "./dist/cjs/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "exports": {
     ".": {
-      "types": "./dist/esm/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
-  "types": "./dist/esm/index.d.ts",
+  "types": "./dist/index.d.ts",
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "files": [
     "dist/"
@@ -27,14 +31,10 @@
   "repository": "https://github.com/dawsbot/essential-eth.git",
   "author": "@dawsbot",
   "scripts": {
-    "test": "npm-run-all --parallel vitest compile lint",
+    "test": "vitest run && tsup && eslint --cache . --config .eslintrc.cjs",
     "test:all-node-versions": "npx trevor",
     "lint": "eslint --cache --fix . --config .eslintrc.cjs",
-    "compile": "npm-run-all --parallel build:esm build:cjs build:umd",
-    "build": "rm -rf dist && npm run compile",
-    "build:esm": "tsc -p tsconfig.json",
-    "build:cjs": "tsc -p tsconfig-cjs.json && printf '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
-    "build:umd": "microbundle --external none --format umd",
+    "build": "tsup",
     "build:readme": "bash ./scripts/markdown-magic/build-readme.sh",
     "vitest": "vitest run",
     "build:chains-info": "npx tsx scripts/update-chains-info/index.ts # used in getNetwork()",
@@ -62,11 +62,10 @@
     "husky": "^7.0.4",
     "lint-staged": "^13.2.1",
     "markdown-magic": "^2.6.1",
-    "microbundle": "^0.15.1",
-    "npm-run-all": "^4.1.5",
     "perf_hooks": "^0.0.1",
     "prettier": "^3.2.5",
     "prettier-plugin-organize-imports": "^3.2.4",
+    "tsup": "^8.5.1",
     "typedoc": "^0.24.5",
     "typescript": "^4.9.4",
     "vitest": "^0.34.6",

package/readme.md

@@ -40,7 +40,7 @@
 - 🧪 Strongly tested
 - 🌲 Tree-shaking and no side-effects
 - 🙌 All common JS versions (CommonJS, ESM, & UMD)
-  - ✅ Node 20, 18, 16, & 14
+  - ✅ Node 24, 22, 20, & 18
   - ✅ Web
 
 <br/>
@@ -126,7 +126,7 @@ Browsers:
 
 ```html
 <!-- index.html -->
-<script src="https://unpkg.com/essential-eth@0.10.3"></script>
+<script src="https://unpkg.com/essential-eth@0.11.1"></script>
 ```
 
 <!-- ⛔️ AUTO-GENERATED-CONTENT:END (UNPKG_SCRIPT_TAG) -->

package/dist/cjs/classes/Contract.d.ts

@@ -1,81 +0,0 @@
-import type { JsonRpcProvider } from '../providers/JsonRpcProvider';
-import type { ContractInterface } from '../types/Contract.types';
-export declare class BaseContract {
-    /**
-     * The URL to your Eth node. Consider POKT or Infura
-     */
-    private readonly _address;
-    private readonly _provider;
-    /**
-     * @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
-     * @example
-     */
-    constructor(addressOrName: string, contractInterface: ContractInterface, signerOrProvider: JsonRpcProvider);
-}
-/**
- * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
- *
- * @param object
- * @param name
- * @param value
- * @internal
- * @example
- */
-export declare function defineReadOnly<T>(object: T, name: string, value: any): void;
-/**
- * @alpha
- * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
- * Only read-only function calls currently supported.
- * @example
- * ```typescript
- * import { Contract, JsonRpcProvider } from 'essential-eth';
- * // UNI airdrop contract
- * const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
- * const provider = new JsonRpcProvider();
- * // for more robust contract calls, provide a fallback:
- * // const provider = new FallthroughProvider(['bad', 'https://free-eth-node.com/api/eth']);
- *
- * 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 declare class Contract extends BaseContract {
-    /**
-     * The function names on any given contract. Like "isClaimed", "merkleRoot", etc.
-     */
-    readonly [key: string]: any;
-}

package/dist/cjs/classes/Contract.js

@@ -1,139 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Contract = exports.defineReadOnly = exports.BaseContract = void 0;
-const encode_decode_transaction_1 = require("./utils/encode-decode-transaction");
-/**
- * @param txnData
- * @example
- */
-function estimateGas(txnData) {
-    // 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);
-}
-class BaseContract {
-    /**
-     * The URL to your Eth node. Consider POKT or Infura
-     */
-    _address;
-    _provider;
-    /**
-     * @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
-     * @example
-     */
-    constructor(addressOrName, contractInterface, signerOrProvider) {
-        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) => {
-                    let functionArguments = _args;
-                    let 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 = (0, encode_decode_transaction_1.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 () => {
-                        return await this._provider.call({
-                            to: this._address.toLowerCase(),
-                            data,
-                            // sometimes gas is defined in the ABI
-                            ...(decimalGas
-                                ? { gas: `0x${decimalGas.toString(16)}` }
-                                : {}),
-                        }, 'latest');
-                    };
-                    const nodeResponse = await req();
-                    return (0, encode_decode_transaction_1.decodeRPCResponse)(jsonABIArgument, nodeResponse);
-                });
-            }
-        });
-    }
-}
-exports.BaseContract = BaseContract;
-/**
- * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
- *
- * @param object
- * @param name
- * @param value
- * @internal
- * @example
- */
-function defineReadOnly(object, name, value) {
-    Object.defineProperty(object, name, {
-        enumerable: true,
-        value: value,
-        writable: false,
-    });
-}
-exports.defineReadOnly = defineReadOnly;
-/**
- * @alpha
- * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
- * Only read-only function calls currently supported.
- * @example
- * ```typescript
- * import { Contract, JsonRpcProvider } from 'essential-eth';
- * // UNI airdrop contract
- * const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
- * const provider = new JsonRpcProvider();
- * // for more robust contract calls, provide a fallback:
- * // const provider = new FallthroughProvider(['bad', 'https://free-eth-node.com/api/eth']);
- *
- * 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));
- * })()
- *
- *
- * ```
- */
-class Contract extends BaseContract {
-}
-exports.Contract = Contract;

package/dist/cjs/classes/test/Contract/crv-abi.d.ts

@@ -1,2 +0,0 @@
-import type { JSONABI } from '../../../types/Contract.types';
-export declare const abi: JSONABI;