essential-eth 0.5.6 → 0.5.9

package/lib/cjs/classes/utils/encode-decode-transaction.js

@@ -6,6 +6,18 @@ const __1 = require("../..");
 const hex_to_decimal_1 = require("./hex-to-decimal");
 exports.hexFalse = '0'.repeat(64);
 const hexTrue = '0'.repeat(63) + '1';
+/**
+ * Expands an integer type to use a default of 256 bits. Used for consistency; not required in Solidity
+ *
+ * @see https://ethereum.stackexchange.com/questions/43241/why-write-uint256-instead-of-uint-if-theyre-the-same-thing
+ * @param type the type to explicitly define as 256 bits
+ * @returns the integer type expanded to explicitly be 256 bits when possible
+ * @example
+ * ```javascript
+ * expandType('uint[]');
+ * // 'uint256[]'
+ * ```
+ */
 function expandType(type) {
     // https://docs.soliditylang.org/en/v0.8.7/types.html#integers
     if (type === 'uint[]') {
@@ -16,6 +28,12 @@ function expandType(type) {
     }
     return type;
 }
+/**
+ *
+ * @param jsonABIArgument
+ * @param args
+ * @example
+ */
 function encodeData(jsonABIArgument, args) {
     const hash = new sha3_1.Keccak(256);
     /* first 4 bytes will create the data parameter */
@@ -86,6 +104,12 @@ function encodeData(jsonABIArgument, args) {
     return data;
 }
 exports.encodeData = encodeData;
+/**
+ *
+ * @param jsonABIArgument
+ * @param nodeResponse
+ * @example
+ */
 function decodeRPCResponse(jsonABIArgument, nodeResponse) {
     const rawOutputs = jsonABIArgument.outputs;
     // chunk response every 64 characters

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

@@ -1,5 +1,35 @@
+/**
+ * Makes a post request with the specified JSON data, normally to the a Ethereum JSON RPC API endpoint
+ *
+ * @param url the URL to send the request to
+ * @param body the body data (JSON) to send with the request
+ * @returns the JSON response from the server
+ * @example
+ * ```javascript
+ * post('https://free-eth-node.com/api/eth', { jsonrpc: '2.0', id: 1, method: 'eth_gasPrice', params: [] });
+ * // '0x66fa8dbfd'
+ *
+ * post('https://free-eth-node.com/api/eth', { jsonrpc: '2.0', id: 1, method: 'eth_getBalance', params: [ '0x4a986a6dCA6dbf99bC3d17F8D71aFb0d60e740f8', 'latest' ] });
+ * // '0x312faeb995df61d4'
+ * ```
+ */
 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' | 'eth_estimateGas';
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount' | 'eth_getCode' | 'eth_blockNumber' | 'eth_estimateGas' | 'eth_getLogs';
+/**
+ * Prepares data to be sent using the {@link post} function. Data is prepared per the {@link https://en.wikipedia.org/wiki/JSON-RPC#Examples JSON RPC v2 spec}
+ *
+ * @param method the RPC method to be invoked
+ * @param params the parameters to be passed to the defined method
+ * @returns a POST method body matching the {@link https://en.wikipedia.org/wiki/JSON-RPC#Examples JSON RPC v2 spec}
+ * @example
+ * ```javascript
+ * buildRPCPostBody('eth_gasPrice', []);
+ * // { jsonrpc: '2.0', id: 1, method: 'eth_gasPrice', params: [] }
+ *
+ * buildRPCPostBody('eth_getBalance', ['0x407d73d8a49eeb85d32cf465507dd71d507100c1', 'latest']);
+ * // { jsonrpc: '2.0', id: 1, method: 'eth_getBalance', params: [ '0x4a986a6dCA6dbf99bC3d17F8D71aFb0d60e740f8', 'latest' ] }
+ * ```
+ */
 export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;

package/lib/cjs/classes/utils/fetchers.js

@@ -14,6 +14,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildRPCPostBody = exports.post = void 0;
 const isomorphic_unfetch_1 = __importDefault(require("isomorphic-unfetch"));
+/**
+ * Makes a post request with the specified JSON data, normally to the a Ethereum JSON RPC API endpoint
+ *
+ * @param url the URL to send the request to
+ * @param body the body data (JSON) to send with the request
+ * @returns the JSON response from the server
+ * @example
+ * ```javascript
+ * post('https://free-eth-node.com/api/eth', { jsonrpc: '2.0', id: 1, method: 'eth_gasPrice', params: [] });
+ * // '0x66fa8dbfd'
+ *
+ * post('https://free-eth-node.com/api/eth', { jsonrpc: '2.0', id: 1, method: 'eth_getBalance', params: [ '0x4a986a6dCA6dbf99bC3d17F8D71aFb0d60e740f8', 'latest' ] });
+ * // '0x312faeb995df61d4'
+ * ```
+ */
 function post(url, body) {
     return (0, isomorphic_unfetch_1.default)(url, {
         method: 'POST',
@@ -40,6 +55,21 @@ function post(url, body) {
     });
 }
 exports.post = post;
+/**
+ * Prepares data to be sent using the {@link post} function. Data is prepared per the {@link https://en.wikipedia.org/wiki/JSON-RPC#Examples JSON RPC v2 spec}
+ *
+ * @param method the RPC method to be invoked
+ * @param params the parameters to be passed to the defined method
+ * @returns a POST method body matching the {@link https://en.wikipedia.org/wiki/JSON-RPC#Examples JSON RPC v2 spec}
+ * @example
+ * ```javascript
+ * buildRPCPostBody('eth_gasPrice', []);
+ * // { jsonrpc: '2.0', id: 1, method: 'eth_gasPrice', params: [] }
+ *
+ * buildRPCPostBody('eth_getBalance', ['0x407d73d8a49eeb85d32cf465507dd71d507100c1', 'latest']);
+ * // { jsonrpc: '2.0', id: 1, method: 'eth_getBalance', params: [ '0x4a986a6dCA6dbf99bC3d17F8D71aFb0d60e740f8', 'latest' ] }
+ * ```
+ */
 function buildRPCPostBody(method, params) {
     return {
         jsonrpc: '2.0',

package/lib/cjs/classes/utils/hex-to-decimal.d.ts

@@ -1,5 +1,18 @@
 /**
  * Converts a hexadecimal string it's decimal equivalent.
- * This is needed instead of parseInt because parseInt loses precision
+ * This is needed instead of parseInt because parseInt loses precision.
+ *
+ * @param hex the hex string to be converted to decimal
+ * @returns a decimal value equivalent to the hex string given
+ * @example
+ * ```javascript
+ * hexToDecimal('0x34');
+ * // 52
+ * ```
+ * @example
+ * ```javascript
+ * hexToDecimal('0x628608');
+ * // 6456840
+ * ```
  */
 export declare function hexToDecimal(hex: string): string;

package/lib/cjs/classes/utils/hex-to-decimal.js

@@ -3,7 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hexToDecimal = void 0;
 /**
  * Converts a hexadecimal string it's decimal equivalent.
- * This is needed instead of parseInt because parseInt loses precision
+ * This is needed instead of parseInt because parseInt loses precision.
+ *
+ * @param hex the hex string to be converted to decimal
+ * @returns a decimal value equivalent to the hex string given
+ * @example
+ * ```javascript
+ * hexToDecimal('0x34');
+ * // 52
+ * ```
+ * @example
+ * ```javascript
+ * hexToDecimal('0x628608');
+ * // 6456840
+ * ```
  */
 function hexToDecimal(hex) {
     return BigInt(hex).toString();

package/lib/cjs/classes/utils/prepare-transaction.d.ts

@@ -0,0 +1,6 @@
+import { RPCTransactionRequest, TransactionRequest } from './../../types/Transaction.types';
+/**
+ * @param transaction
+ * @example
+ */
+export declare function prepareTransaction(transaction: TransactionRequest): RPCTransactionRequest;

package/lib/cjs/classes/utils/prepare-transaction.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prepareTransaction = void 0;
+const big_js_1 = __importDefault(require("big.js"));
+const tiny_big_1 = require("../../shared/tiny-big/tiny-big");
+const bytes_1 = require("../../utils/bytes");
+/**
+ * @param transaction
+ * @example
+ */
+function prepareTransaction(transaction) {
+    const preparedTransaction = Object.assign({}, transaction);
+    Object.keys(transaction).forEach((key) => {
+        switch (key) {
+            case 'gas':
+            case 'gasPrice':
+            case 'nonce':
+            case 'maxFeePerGas':
+            case 'maxPriorityFeePerGas':
+            case 'value': {
+                const value = transaction[key];
+                if (value instanceof tiny_big_1.TinyBig) {
+                    preparedTransaction[key] = value.toHexString();
+                }
+                else if (value instanceof big_js_1.default) {
+                    preparedTransaction[key] = `0x${BigInt(value.toString()).toString(16)}`;
+                }
+                else if (typeof transaction[key] === 'number')
+                    preparedTransaction[key] =
+                        '0x' + transaction[key].toString(16);
+                else
+                    preparedTransaction[key] = transaction[key].toString();
+                break;
+            }
+            case 'data':
+                preparedTransaction[key] = (0, bytes_1.hexlify)(transaction[key]);
+                break;
+        }
+    });
+    return preparedTransaction;
+}
+exports.prepareTransaction = prepareTransaction;

package/lib/cjs/index.d.ts

@@ -4,8 +4,9 @@ import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag, RPCBlock } from './types/Block.types';
 import { ContractTypes, JSONABI, JSONABIArgument } from './types/Contract.types';
+import { Filter, FilterByBlockHash } from './types/Filter.types';
 import { Network } from './types/Network.types';
-import { BlockTransactionResponse, Log, RPCLog, RPCTransaction, RPCTransactionReceipt, TransactionReceipt, TransactionResponse } from './types/Transaction.types';
+import { BlockTransactionResponse, Log, RPCLog, RPCTransaction, RPCTransactionReceipt, RPCTransactionRequest, TransactionReceipt, TransactionRequest, TransactionResponse } from './types/Transaction.types';
 import { computeAddress } from './utils/compute-address';
 import { computePublicKey } from './utils/compute-public-key';
 import { etherToGwei } from './utils/ether-to-gwei';
@@ -17,9 +18,8 @@ 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';
 export * from './utils/solidity-keccak256';
-export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hashMessage, splitSignature, toUtf8Bytes, computeAddress, computePublicKey, Contract, TinyBig, BaseContract, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, RPCBlock, RPCTransaction, RPCTransactionReceipt, TransactionReceipt, BlockTag, RPCLog, Log, BlockTransactionResponse, ConstructorOptions, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, hashMessage, splitSignature, toUtf8Bytes, computeAddress, computePublicKey, Contract, TinyBig, BaseContract, BlockResponse, ContractTypes, Filter, FilterByBlockHash, JSONABI, JSONABIArgument, Network, TransactionResponse, RPCBlock, RPCTransaction, RPCTransactionReceipt, TransactionRequest, RPCTransactionRequest, TransactionReceipt, BlockTag, RPCLog, Log, BlockTransactionResponse, ConstructorOptions, };

package/lib/cjs/index.js

@@ -48,7 +48,6 @@ 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.6";
+export declare const version = "0.5.9";

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.6';
+exports.version = '0.5.9';