essential-eth 0.5.5 → 0.5.6

package/lib/cjs/classes/utils/fetchers.d.ts

@@ -1,5 +1,5 @@
 export declare function post(url: string, body: Record<string, unknown>): Promise<any>;
-declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount' | 'eth_blockNumber';
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount' | 'eth_blockNumber' | 'eth_estimateGas';
 export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;

package/lib/cjs/index.d.ts

@@ -17,6 +17,7 @@ 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';
+export * from './providers/types';
 export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';

package/lib/cjs/index.js

@@ -48,6 +48,7 @@ const to_utf8_bytes_1 = require("./utils/to-utf8-bytes");
 Object.defineProperty(exports, "toUtf8Bytes", { enumerable: true, get: function () { return to_utf8_bytes_1.toUtf8Bytes; } });
 const wei_to_ether_1 = require("./utils/wei-to-ether");
 Object.defineProperty(exports, "weiToEther", { enumerable: true, get: function () { return wei_to_ether_1.weiToEther; } });
+__exportStar(require("./providers/types"), exports);
 __exportStar(require("./utils/bytes"), exports);
 __exportStar(require("./utils/hash-message"), exports);
 __exportStar(require("./utils/keccak256"), exports);

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

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

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

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // Generated by genversion.
-exports.version = '0.5.5';
+exports.version = '0.5.6';

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

@@ -2,6 +2,7 @@ import { TinyBig } from '../shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
 import { TransactionReceipt, TransactionResponse } from '../types/Transaction.types';
+import { TransactionRequest } from './types';
 export declare abstract class BaseProvider {
     /**
      * ignore
@@ -281,4 +282,23 @@ export declare abstract class BaseProvider {
      * ```
      */
     getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
+    /**
+     * Returns an estimate of the amount of gas that would be required to submit transaction to the network.
+     * An estimate may not be accurate since there could be another transaction on the network that was not accounted for, but after being mined affected relevant state.
+     *
+     * * Same as ["estimateGas" in ethers.js](https://docs.ethers.io/v5/api/providers/provider/#Provider-estimateGas)
+     *
+     * @example
+     * ```js
+     * await provider.estimateGas({
+     *   // Wrapped ETH address
+     *   to: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+     *   data: "0xd0e30db0",
+     *   value: etherToWei('1.0').toHexString(),
+     * });
+     * // { TinyBig: "27938" }
+     *
+     * ```
+     * */
+    estimateGas(transaction: TransactionRequest): Promise<TinyBig>;
 }

package/lib/cjs/providers/BaseProvider.js

@@ -376,5 +376,30 @@ class BaseProvider {
             return (0, tiny_big_1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(hexBalance));
         });
     }
+    /**
+     * Returns an estimate of the amount of gas that would be required to submit transaction to the network.
+     * An estimate may not be accurate since there could be another transaction on the network that was not accounted for, but after being mined affected relevant state.
+     *
+     * * Same as ["estimateGas" in ethers.js](https://docs.ethers.io/v5/api/providers/provider/#Provider-estimateGas)
+     *
+     * @example
+     * ```js
+     * await provider.estimateGas({
+     *   // Wrapped ETH address
+     *   to: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+     *   data: "0xd0e30db0",
+     *   value: etherToWei('1.0').toHexString(),
+     * });
+     * // { TinyBig: "27938" }
+     *
+     * ```
+     * */
+    estimateGas(transaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = (0, fetchers_1.buildRPCPostBody)('eth_estimateGas', [transaction]);
+            const gasUsed = (yield this.post(body));
+            return (0, tiny_big_1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(gasUsed));
+        });
+    }
 }
 exports.BaseProvider = BaseProvider;

package/lib/cjs/providers/types.d.ts

@@ -0,0 +1,7 @@
+import { BytesLike } from '../utils/bytes';
+export interface TransactionRequest {
+    to?: string;
+    from?: string;
+    data?: BytesLike;
+    [key: string]: any;
+}

package/lib/cjs/providers/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -28,7 +28,17 @@ const validate_type_1 = require("../shared/validate-type");
  */
 function weiToEther(weiQuantity) {
     (0, validate_type_1.validateType)(weiQuantity, ['string', 'number', 'object']);
-    const result = (0, tiny_big_1.tinyBig)(weiQuantity).div('1000000000000000000');
-    return (0, tiny_big_1.tinyBig)(result);
+    // eslint-disable-next-line no-useless-catch
+    try {
+        let _weiQuantity = weiQuantity;
+        if (typeof weiQuantity === 'string' && weiQuantity.slice(0, 2) === '0x') {
+            _weiQuantity = BigInt(weiQuantity).toString();
+        }
+        const result = (0, tiny_big_1.tinyBig)(_weiQuantity).div('1000000000000000000');
+        return (0, tiny_big_1.tinyBig)(result);
+    }
+    catch (error) {
+        throw error;
+    }
 }
 exports.weiToEther = weiToEther;

package/lib/esm/classes/utils/fetchers.d.ts

@@ -1,5 +1,5 @@
 export declare function post(url: string, body: Record<string, unknown>): Promise<any>;
-declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount' | 'eth_blockNumber';
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount' | 'eth_blockNumber' | 'eth_estimateGas';
 export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;

package/lib/esm/index.d.ts

@@ -17,6 +17,7 @@ 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';
+export * from './providers/types';
 export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';

package/lib/esm/index.js

@@ -13,6 +13,7 @@ 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';
+export * from './providers/types';
 export * from './utils/bytes';
 export * from './utils/hash-message';
 export * from './utils/keccak256';

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

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

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

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

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

@@ -2,6 +2,7 @@ import { TinyBig } from '../shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
 import { TransactionReceipt, TransactionResponse } from '../types/Transaction.types';
+import { TransactionRequest } from './types';
 export declare abstract class BaseProvider {
     abstract selectRpcUrl(): string;
     abstract post(body: Record<string, unknown>): Promise<any>;
@@ -16,4 +17,5 @@ export declare abstract class BaseProvider {
     getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
     getGasPrice(): Promise<TinyBig>;
     getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
+    estimateGas(transaction: TransactionRequest): Promise<TinyBig>;
 }

package/lib/esm/providers/BaseProvider.js

@@ -104,4 +104,11 @@ export class BaseProvider {
             return tinyBig(hexToDecimal(hexBalance));
         });
     }
+    estimateGas(transaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = buildRPCPostBody('eth_estimateGas', [transaction]);
+            const gasUsed = (yield this.post(body));
+            return tinyBig(hexToDecimal(gasUsed));
+        });
+    }
 }

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

@@ -0,0 +1,7 @@
+import { BytesLike } from '../utils/bytes';
+export interface TransactionRequest {
+    to?: string;
+    from?: string;
+    data?: BytesLike;
+    [key: string]: any;
+}

package/lib/esm/providers/types.js

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

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 for Ethereum",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",