essential-eth 0.4.10 → 0.4.11

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

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

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

@@ -1,17 +1,20 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
-import { Block } from '../types/Block.types';
+import { Block, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
 export declare class JsonRpcProvider {
     /**
-     * The URL to your Eth node. Consider POKT or Infura
+     * @ignore
      */
     readonly _rpcUrl: string;
+    /**
+     * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
+     */
     constructor(rpcUrl?: string);
     /**
      * Returns the block requested
      * Same as `web3.eth.getBlock`
      */
-    getBlock(timeFrame: 'latest' | 'earliest' | 'pending' | number, returnTransactionObjects?: boolean): Promise<Block>;
+    getBlock(timeFrame: BlockTag, returnTransactionObjects?: boolean): Promise<Block>;
     /**
      * Returns the network this provider is connected to
      */
@@ -21,6 +24,20 @@ export declare class JsonRpcProvider {
      * Same as `ethers.provider.getGasPrice`
      */
     getGasPrice(): Promise<TinyBig>;
+    /**
+     * Returns the balance of the account in wei as TinyBig
+     * Same as `ethers.provider.getBalance`
+     * Same as `web3.eth.getBalance`
+     *
+     * @example
+     * ```js
+     *  await provider
+     *   .getBalance('0x7cB57B5A97eAbe94205C07890BE4c1aD31E486A8')
+     *   .then((balance) => console.log(balance.toString()));
+     * // "28798127851528138"
+     * ```
+     */
+    getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
 }
 /**
  * Helper function to avoid "new"

package/lib/cjs/providers/JsonRpcProvider.js

@@ -19,6 +19,9 @@ const hex_to_decimal_1 = require("../classes/utils/hex-to-decimal");
 const tiny_big_1 = require("../shared/tiny-big/tiny-big");
 const chains_info_1 = __importDefault(require("./utils/chains-info"));
 class JsonRpcProvider {
+    /**
+     * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
+     */
     constructor(rpcUrl) {
         this._rpcUrl = rpcUrl || 'https://free-eth-node.com/api/eth';
     }
@@ -26,7 +29,7 @@ class JsonRpcProvider {
      * Returns the block requested
      * Same as `web3.eth.getBlock`
      */
-    getBlock(timeFrame /* block number as integer */, returnTransactionObjects = false) {
+    getBlock(timeFrame, returnTransactionObjects = false) {
         return __awaiter(this, void 0, void 0, function* () {
             let rpcTimeFrame;
             if (typeof timeFrame === 'number') {
@@ -37,12 +40,12 @@ class JsonRpcProvider {
                 // "latest", "earliest", and "pending" require no manipulation
                 rpcTimeFrame = timeFrame;
             }
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_getBlockByNumber', [
+            const req = () => {
+                return (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_getBlockByNumber', [
                     rpcTimeFrame,
                     returnTransactionObjects,
                 ]));
-            });
+            };
             const nodeResponse = (yield req());
             return (0, clean_block_1.cleanBlock)(nodeResponse, returnTransactionObjects);
         });
@@ -52,9 +55,9 @@ class JsonRpcProvider {
      */
     getNetwork() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_chainId', []));
-            });
+            const req = () => {
+                return (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_chainId', []));
+            };
             const nodeResponse = (yield req());
             const chainId = (0, hex_to_decimal_1.hexToDecimal)(nodeResponse);
             const info = chains_info_1.default[chainId];
@@ -71,9 +74,31 @@ class JsonRpcProvider {
      */
     getGasPrice() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_gasPrice', []));
-            });
+            const req = () => {
+                return (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_gasPrice', []));
+            };
+            const nodeResponse = (yield req()); /* '0x153cfb1ad0' */
+            return (0, tiny_big_1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(nodeResponse));
+        });
+    }
+    /**
+     * Returns the balance of the account in wei as TinyBig
+     * Same as `ethers.provider.getBalance`
+     * Same as `web3.eth.getBalance`
+     *
+     * @example
+     * ```js
+     *  await provider
+     *   .getBalance('0x7cB57B5A97eAbe94205C07890BE4c1aD31E486A8')
+     *   .then((balance) => console.log(balance.toString()));
+     * // "28798127851528138"
+     * ```
+     */
+    getBalance(address, blockTag = 'latest') {
+        return __awaiter(this, void 0, void 0, function* () {
+            const req = () => {
+                return (0, fetchers_1.post)(this._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_getBalance', [address, blockTag]));
+            };
             const nodeResponse = (yield req()); /* '0x153cfb1ad0' */
             return (0, tiny_big_1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(nodeResponse));
         });

package/lib/cjs/providers/test/rpc-urls.d.ts

@@ -5,4 +5,6 @@ export declare const rpcUrls: {
     mainnet: string;
     gno: string;
     bnb: string;
+    arb1: string;
+    gor: string;
 };

package/lib/cjs/providers/test/rpc-urls.js

@@ -8,4 +8,6 @@ exports.rpcUrls = {
     mainnet: `${process.env.RPC_ORIGIN}/api/eth`,
     gno: `${process.env.RPC_ORIGIN}/api/gno`,
     bnb: `${process.env.RPC_ORIGIN}/api/bnb`,
+    arb1: `${process.env.RPC_ORIGIN}/api/arb1`,
+    gor: `${process.env.RPC_ORIGIN}/api/gor`,
 };

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

@@ -262,6 +262,7 @@ declare const _default: {
     "16000": string[];
     "16001": string[];
     "19845": string[];
+    "21337": string[];
     "21816": string[];
     "24484": string[];
     "24734": string[];

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

@@ -587,7 +587,7 @@ exports.default = {
         "mrock"
     ],
     "1337": [
-        "cennz-a"
+        "cennz-old"
     ],
     "1618": [
         "cate"
@@ -796,6 +796,9 @@ exports.default = {
     "19845": [
         "btcix"
     ],
+    "21337": [
+        "cennz-a"
+    ],
     "21816": [
         "oml"
     ],

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

@@ -45,3 +45,4 @@ export interface RPCBlock {
     transactionsRoot: string;
     uncles: unknown[];
 }
+export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;

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

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

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

@@ -1,11 +1,12 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
-import { Block } from '../types/Block.types';
+import { Block, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
 export declare class JsonRpcProvider {
     readonly _rpcUrl: string;
     constructor(rpcUrl?: string);
-    getBlock(timeFrame: 'latest' | 'earliest' | 'pending' | number, returnTransactionObjects?: boolean): Promise<Block>;
+    getBlock(timeFrame: BlockTag, returnTransactionObjects?: boolean): Promise<Block>;
     getNetwork(): Promise<Network>;
     getGasPrice(): Promise<TinyBig>;
+    getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>;
 }
 export declare function jsonRpcProvider(rpcUrl?: string): JsonRpcProvider;

package/lib/esm/providers/JsonRpcProvider.js

@@ -25,21 +25,21 @@ export class JsonRpcProvider {
             else {
                 rpcTimeFrame = timeFrame;
             }
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_getBlockByNumber', [
+            const req = () => {
+                return post(this._rpcUrl, buildRPCPostBody('eth_getBlockByNumber', [
                     rpcTimeFrame,
                     returnTransactionObjects,
                 ]));
-            });
+            };
             const nodeResponse = (yield req());
             return cleanBlock(nodeResponse, returnTransactionObjects);
         });
     }
     getNetwork() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_chainId', []));
-            });
+            const req = () => {
+                return post(this._rpcUrl, buildRPCPostBody('eth_chainId', []));
+            };
             const nodeResponse = (yield req());
             const chainId = hexToDecimal(nodeResponse);
             const info = chainsInfo[chainId];
@@ -52,9 +52,18 @@ export class JsonRpcProvider {
     }
     getGasPrice() {
         return __awaiter(this, void 0, void 0, function* () {
-            const req = () => __awaiter(this, void 0, void 0, function* () {
-                return yield post(this._rpcUrl, buildRPCPostBody('eth_gasPrice', []));
-            });
+            const req = () => {
+                return post(this._rpcUrl, buildRPCPostBody('eth_gasPrice', []));
+            };
+            const nodeResponse = (yield req());
+            return tinyBig(hexToDecimal(nodeResponse));
+        });
+    }
+    getBalance(address, blockTag = 'latest') {
+        return __awaiter(this, void 0, void 0, function* () {
+            const req = () => {
+                return post(this._rpcUrl, buildRPCPostBody('eth_getBalance', [address, blockTag]));
+            };
             const nodeResponse = (yield req());
             return tinyBig(hexToDecimal(nodeResponse));
         });

package/lib/esm/providers/test/rpc-urls.d.ts

@@ -5,4 +5,6 @@ export declare const rpcUrls: {
     mainnet: string;
     gno: string;
     bnb: string;
+    arb1: string;
+    gor: string;
 };

package/lib/esm/providers/test/rpc-urls.js

@@ -5,4 +5,6 @@ export const rpcUrls = {
     mainnet: `${process.env.RPC_ORIGIN}/api/eth`,
     gno: `${process.env.RPC_ORIGIN}/api/gno`,
     bnb: `${process.env.RPC_ORIGIN}/api/bnb`,
+    arb1: `${process.env.RPC_ORIGIN}/api/arb1`,
+    gor: `${process.env.RPC_ORIGIN}/api/gor`,
 };

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

@@ -262,6 +262,7 @@ declare const _default: {
     "16000": string[];
     "16001": string[];
     "19845": string[];
+    "21337": string[];
     "21816": string[];
     "24484": string[];
     "24734": string[];

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

@@ -583,7 +583,7 @@ export default {
         "mrock"
     ],
     "1337": [
-        "cennz-a"
+        "cennz-old"
     ],
     "1618": [
         "cate"
@@ -792,6 +792,9 @@ export default {
     "19845": [
         "btcix"
     ],
+    "21337": [
+        "cennz-a"
+    ],
     "21816": [
         "oml"
     ],

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

@@ -45,3 +45,4 @@ export interface RPCBlock {
     transactionsRoot: string;
     uncles: unknown[];
 }
+export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.4.10",
+  "version": "0.4.11",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",

package/readme.md

@@ -264,6 +264,33 @@ provider.getGasPrice().toNumber();
 
 <br/>
 
+#### `getBalance`
+
+Returns the balance of an address at a given block
+
+```typescript
+// Same API as ethers.providers.getBalance
+// Same API as web3.eth.getBalance
+getBalance(address: string, blockTag?: BlockTag): Promise<TinyBig>
+```
+
+<details>
+  <summary>View Example</summary>
+
+```typescript
+import { JsonRpcProvider } from 'essential-eth';
+
+const provider = new JsonRpcProvider();
+await provider
+  .getBalance('0x7cB57B5A97eAbe94205C07890BE4c1aD31E486A8')
+  .then((balance) => console.log(balance.toString()));
+// "28798127851528138"
+```
+
+</details>
+
+<br/>
+
 #### `getNetwork`
 
 Returns a Network