essential-eth 0.5.4-alpha.0 → 0.5.4

package/lib/cjs/classes/utils/clean-transaction-receipt.d.ts

@@ -0,0 +1,5 @@
+import { RPCTransactionReceipt, TransactionReceipt } from '../../types/Transaction.types';
+/**
+ * Converts RPC transaction receipt response to more JS-friendly format
+ */
+export declare function cleanTransactionReceipt(transactionReceipt: RPCTransactionReceipt): TransactionReceipt;

package/lib/cjs/classes/utils/clean-transaction-receipt.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanTransactionReceipt = void 0;
+const __1 = require("../..");
+const clean_transaction_1 = require("./clean-transaction");
+const hex_to_decimal_1 = require("./hex-to-decimal");
+/**
+ * Converts RPC transaction receipt response to more JS-friendly format
+ */
+function cleanTransactionReceipt(transactionReceipt) {
+    const cleanedTransaction = (0, clean_transaction_1.cleanTransaction)(transactionReceipt);
+    const cleanedTransactionReceipt = Object.assign({}, cleanedTransaction);
+    Object.keys(transactionReceipt).forEach((key) => {
+        if (!transactionReceipt[key])
+            return;
+        switch (key) {
+            case 'status':
+                cleanedTransactionReceipt[key] = Number((0, hex_to_decimal_1.hexToDecimal)(transactionReceipt[key]));
+                break;
+            case 'contractAddress':
+                if (transactionReceipt[key]) {
+                    cleanedTransactionReceipt[key] = (0, __1.toChecksumAddress)(transactionReceipt[key]);
+                }
+                break;
+            case 'cumulativeGasUsed':
+            case 'effectiveGasPrice':
+            case 'gasUsed':
+                cleanedTransactionReceipt[key] = (0, __1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(transactionReceipt[key]));
+                break;
+            case 'logs':
+                transactionReceipt[key].forEach((log, index) => {
+                    Object.keys(log).forEach((logKey) => {
+                        switch (logKey) {
+                            case 'address':
+                                cleanedTransactionReceipt[key][index][logKey] =
+                                    (0, __1.toChecksumAddress)(log[logKey]);
+                                break;
+                            case 'blockNumber':
+                            case 'logIndex':
+                            case 'transactionIndex':
+                                cleanedTransactionReceipt[key][index][logKey] = Number((0, hex_to_decimal_1.hexToDecimal)(log[logKey]));
+                                break;
+                            case 'removed':
+                                delete log[logKey];
+                                break;
+                        }
+                    });
+                });
+        }
+    });
+    cleanedTransactionReceipt.byzantium =
+        cleanedTransactionReceipt.blockNumber >= 4370000;
+    return cleanedTransactionReceipt;
+}
+exports.cleanTransactionReceipt = cleanTransactionReceipt;

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_getTransactionCount';
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount';
 export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;

package/lib/cjs/index.d.ts

@@ -11,7 +11,10 @@ import { etherToWei } from './utils/ether-to-wei';
 import { gweiToEther } from './utils/gwei-to-ether';
 import { isAddress } from './utils/is-address';
 import { toChecksumAddress } from './utils/to-checksum-address';
+import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
 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, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, toUtf8Bytes, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };

package/lib/cjs/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TinyBig = exports.Contract = exports.gweiToEther = exports.weiToEther = exports.toChecksumAddress = exports.tinyBig = exports.FallthroughProvider = exports.JsonRpcProvider = exports.jsonRpcProvider = exports.isAddress = exports.etherToGwei = exports.etherToWei = void 0;
+exports.TinyBig = exports.Contract = exports.toUtf8Bytes = exports.gweiToEther = exports.weiToEther = exports.toChecksumAddress = exports.tinyBig = exports.FallthroughProvider = exports.JsonRpcProvider = exports.jsonRpcProvider = exports.isAddress = exports.etherToGwei = exports.etherToWei = void 0;
 const Contract_1 = require("./classes/Contract");
 Object.defineProperty(exports, "Contract", { enumerable: true, get: function () { return Contract_1.Contract; } });
 const FallthroughProvider_1 = require("./providers/FallthroughProvider");
@@ -35,7 +35,12 @@ const is_address_1 = require("./utils/is-address");
 Object.defineProperty(exports, "isAddress", { enumerable: true, get: function () { return is_address_1.isAddress; } });
 const to_checksum_address_1 = require("./utils/to-checksum-address");
 Object.defineProperty(exports, "toChecksumAddress", { enumerable: true, get: function () { return to_checksum_address_1.toChecksumAddress; } });
+// import { verifyMessage } from './utils/verify-message';
+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("./utils/bytes"), exports);
+__exportStar(require("./utils/hash-message"), exports);
+__exportStar(require("./utils/keccak256"), exports);
 __exportStar(require("./utils/solidity-keccak256"), exports);

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

@@ -1 +1 @@
-export declare const version = "0.5.4-alpha.0";
+export declare const version = "0.5.4";

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.4-alpha.0';
+exports.version = '0.5.4';

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

@@ -1,7 +1,7 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
-import { TransactionResponse } from '../types/Transaction.types';
+import { TransactionReceipt, TransactionResponse } from '../types/Transaction.types';
 export declare abstract class BaseProvider {
     /**
      * ignore
@@ -149,6 +149,15 @@ export declare abstract class BaseProvider {
      * ```
      */
     getTransaction(transactionHash: string): Promise<TransactionResponse>;
+    /**
+     * Gives information about a transaction that has already been mined. Includes additional information beyond what's provided by `getTransaction()`
+     *
+     * * Similar to [`ethers.provider.getTransactionReceipt`](https://docs.ethers.io/v5/api/providers/provider/#Provider-getTransactionReceipt), some information not included
+     *
+     * @param transactionHash the hash of the transaction to get information about
+     *
+     */
+    getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
     /**
      * Returns the transaction count from genesis up to specified blockTag
      *

package/lib/cjs/providers/BaseProvider.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseProvider = void 0;
 const clean_block_1 = require("../classes/utils/clean-block");
 const clean_transaction_1 = require("../classes/utils/clean-transaction");
+const clean_transaction_receipt_1 = require("../classes/utils/clean-transaction-receipt");
 const fetchers_1 = require("../classes/utils/fetchers");
 const hex_to_decimal_1 = require("../classes/utils/hex-to-decimal");
 const tiny_big_1 = require("../shared/tiny-big/tiny-big");
@@ -186,6 +187,26 @@ class BaseProvider {
             return cleanedTransaction;
         });
     }
+    /**
+     * Gives information about a transaction that has already been mined. Includes additional information beyond what's provided by `getTransaction()`
+     *
+     * * Similar to [`ethers.provider.getTransactionReceipt`](https://docs.ethers.io/v5/api/providers/provider/#Provider-getTransactionReceipt), some information not included
+     *
+     * @param transactionHash the hash of the transaction to get information about
+     *
+     */
+    getTransactionReceipt(transactionHash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [rpcTransaction, blockNumber] = yield Promise.all([
+                this.post((0, fetchers_1.buildRPCPostBody)('eth_getTransactionReceipt', [transactionHash])),
+                this.getBlock('latest'),
+            ]);
+            const cleanedTransactionReceipt = (0, clean_transaction_receipt_1.cleanTransactionReceipt)(rpcTransaction);
+            cleanedTransactionReceipt.confirmations =
+                blockNumber.number - cleanedTransactionReceipt.blockNumber + 1;
+            return cleanedTransactionReceipt;
+        });
+    }
     /**
      * Returns the transaction count from genesis up to specified blockTag
      *

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

@@ -20,6 +20,32 @@ export declare type TransactionResponse = Modify<RPCTransaction, {
     maxPriorityFeePerGas: TinyBig;
     confirmations: number;
 }>;
+/**
+ * Type that contains information from the receipt of a transaction
+ * * Similar to [`Type TransactionReceipt on ethers.providers`](https://docs.ethers.io/v5/api/providers/types/#providers-TransactionReceipt)
+ */
+export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
+    blockNumber: number;
+    cumulativeGasUsed: TinyBig;
+    effectiveGasPrice: TinyBig;
+    gasUsed: TinyBig;
+    logs: Array<Log>;
+    status: number;
+    transactionIndex: number;
+    type: number;
+} & {
+    byzantium: boolean;
+    confirmations: number;
+}>;
+/**
+ * Type for the logs that are included in transaction receipts
+ * * Similar to [`Type Log on ethers.providers`](https://docs.ethers.io/v5/api/providers/types/#providers-Log)
+ */
+export declare type Log = Modify<Omit<RPCLog, 'removed'>, {
+    blockNumber: number;
+    logIndex: number;
+    transactionIndex: number;
+}>;
 export declare type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
 /** What JSONRPC responds with in getBlock transaction array */
 export interface RPCBlockTransaction {
@@ -40,4 +66,31 @@ export interface RPCBlockTransaction {
     v: string;
     value: string;
 }
+export interface RPCTransactionReceipt {
+    blockHash: string;
+    blockNumber: string;
+    contractAddress: string;
+    cumulativeGasUsed: string;
+    effectiveGasPrice: string;
+    from: string;
+    gasUsed: string;
+    logs: Array<RPCLog>;
+    logsBloom: string;
+    status: string;
+    to: string;
+    transactionHash: string;
+    transactionIndex: string;
+    type: string;
+}
+export interface RPCLog {
+    address: string;
+    blockHash: string;
+    blockNumber: string;
+    data: string;
+    logIndex: string;
+    removed?: boolean;
+    topics: Array<string>;
+    transactionHash: string;
+    transactionIndex: string;
+}
 export {};

package/lib/cjs/utils/bytes.d.ts

@@ -9,7 +9,8 @@ export declare type Bytes = ArrayLike<number>;
  * @example
  * '0x123'
  */
-export declare type BytesLike = Bytes | string | number;
+export declare type BytesLike = Bytes | string;
+export declare type BytesLikeWithNumber = BytesLike | number;
 export interface DataOptions {
     allowMissingPrefix?: boolean;
     hexPad?: 'left' | 'right' | null;
@@ -112,7 +113,7 @@ export declare function arrayify(value: BytesLike | Hexable | number, options?:
  * // Uint8Array(2) [ 0, 1 ]
  * ```
  */
-export declare function concat(arrayOfBytesLike: ReadonlyArray<BytesLike>): Uint8Array;
+export declare function concat(arrayOfBytesLike: ReadonlyArray<BytesLikeWithNumber>): Uint8Array;
 export declare function stripZeros(value: BytesLike): Uint8Array;
 export declare function zeroPad(value: BytesLike, length: number): Uint8Array;
 /**
@@ -133,7 +134,7 @@ export declare function isHexString(value: any, length?: number): boolean;
  */
 export declare function hexlify(value: BytesLike | Hexable | number | bigint, options?: DataOptions): string;
 export declare function hexDataLength(data: BytesLike): number | null;
-export declare function hexDataSlice(data: BytesLike, offset: number, endOffset?: number): string;
+export declare function hexDataSlice(data: BytesLikeWithNumber, offset: number, endOffset?: number): string;
 export declare function hexConcat(items: ReadonlyArray<BytesLike>): string;
 export declare function hexValue(value: BytesLike | Hexable | number | bigint): string;
 export declare function hexStripZeros(value: BytesLike): string;
@@ -168,4 +169,4 @@ export declare function hexStripZeros(value: BytesLike): string;
  * // Throws
  * ```
  */
-export declare function hexZeroPad(value: BytesLike, length: number): string;
+export declare function hexZeroPad(value: BytesLikeWithNumber, length: number): string;

package/lib/cjs/utils/hash-message.d.ts

@@ -0,0 +1,12 @@
+import { Bytes } from '../index';
+/**
+ * Computes the EIP-191 personal message digest of message.
+ * Personal messages are converted to UTF-8 bytes and prefixed with \x19Ethereum Signed Message: and the length of message.
+ *
+ * @example
+ * ```js
+ * hashMessage("Hello World");
+ * // '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2'
+ * ```
+ */
+export declare function hashMessage(message: Bytes | string): string;

package/lib/cjs/utils/hash-message.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashMessage = void 0;
+const index_1 = require("../index");
+const messagePrefix = '\x19Ethereum Signed Message:\n';
+/**
+ * Computes the EIP-191 personal message digest of message.
+ * Personal messages are converted to UTF-8 bytes and prefixed with \x19Ethereum Signed Message: and the length of message.
+ *
+ * @example
+ * ```js
+ * hashMessage("Hello World");
+ * // '0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2'
+ * ```
+ */
+function hashMessage(message) {
+    if (typeof message === 'string') {
+        message = (0, index_1.toUtf8Bytes)(message);
+    }
+    return (0, index_1.keccak256)((0, index_1.concat)([
+        (0, index_1.toUtf8Bytes)(messagePrefix),
+        (0, index_1.toUtf8Bytes)(String(message.length)),
+        message,
+    ]));
+}
+exports.hashMessage = hashMessage;

package/lib/cjs/utils/keccak256.d.ts

@@ -0,0 +1,2 @@
+import { BytesLike } from './bytes';
+export declare const keccak256: (data: BytesLike) => string;

package/lib/cjs/utils/keccak256.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keccak256 = void 0;
+const sha3_1 = require("sha3");
+const keccak256 = (data) => {
+    let bufferableData;
+    if (typeof data === 'string') {
+        bufferableData = Buffer.from(data.replace(/^0x/, ''), 'hex');
+    }
+    else {
+        bufferableData = Buffer.from(data);
+    }
+    const keccak = new sha3_1.Keccak(256);
+    const addressHash = '0x' + keccak.update(bufferableData).digest('hex');
+    return addressHash;
+};
+exports.keccak256 = keccak256;

package/lib/cjs/utils/solidity-keccak256.d.ts

@@ -1,5 +1,4 @@
 export declare function pack(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string;
-export declare const hashKeccak256: (data: string) => string;
 /**
  * Hashes data from Solidity using the Keccak256 algorithm.
  *

package/lib/cjs/utils/solidity-keccak256.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.solidityKeccak256 = exports.hashKeccak256 = exports.pack = void 0;
+exports.solidityKeccak256 = exports.pack = void 0;
 const buffer_1 = require("buffer");
-const sha3_1 = require("sha3");
 const encode_decode_transaction_1 = require("../classes/utils/encode-decode-transaction");
 const logger_1 = require("../logger/logger");
 const tiny_big_1 = require("../shared/tiny-big/tiny-big");
 const bytes_1 = require("./bytes");
+const keccak256_1 = require("./keccak256");
 const regexBytes = new RegExp('^bytes([0-9]+)$');
 const regexNumber = new RegExp('^(u?int)([0-9]*)$');
 const regexArray = new RegExp('^(.*)\\[([0-9]*)\\]$');
@@ -85,13 +85,6 @@ function pack(types, values) {
     return (0, bytes_1.hexlify)((0, bytes_1.concat)(tight));
 }
 exports.pack = pack;
-const hashKeccak256 = (data) => {
-    const keccak = new sha3_1.Keccak(256);
-    const bufferableData = buffer_1.Buffer.from(data.replace(/^0x/, ''), 'hex');
-    const addressHash = '0x' + keccak.update(bufferableData).digest('hex');
-    return addressHash;
-};
-exports.hashKeccak256 = hashKeccak256;
 /**
  * Hashes data from Solidity using the Keccak256 algorithm.
  *
@@ -120,6 +113,6 @@ exports.hashKeccak256 = hashKeccak256;
  * ```
  */
 function solidityKeccak256(types, values) {
-    return (0, exports.hashKeccak256)(pack(types, values));
+    return (0, keccak256_1.keccak256)(pack(types, values));
 }
 exports.solidityKeccak256 = solidityKeccak256;

package/lib/cjs/utils/to-utf8-bytes.d.ts

@@ -0,0 +1 @@
+export declare function toUtf8Bytes(data: string): Uint8Array;

package/lib/cjs/utils/to-utf8-bytes.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUtf8Bytes = void 0;
+function toUtf8Bytes(data) {
+    return new Uint8Array(Buffer.from(data));
+}
+exports.toUtf8Bytes = toUtf8Bytes;

package/lib/esm/classes/utils/clean-transaction-receipt.d.ts

@@ -0,0 +1,2 @@
+import { RPCTransactionReceipt, TransactionReceipt } from '../../types/Transaction.types';
+export declare function cleanTransactionReceipt(transactionReceipt: RPCTransactionReceipt): TransactionReceipt;

package/lib/esm/classes/utils/clean-transaction-receipt.js

@@ -0,0 +1,48 @@
+import { tinyBig, toChecksumAddress } from '../..';
+import { cleanTransaction } from './clean-transaction';
+import { hexToDecimal } from './hex-to-decimal';
+export function cleanTransactionReceipt(transactionReceipt) {
+    const cleanedTransaction = cleanTransaction(transactionReceipt);
+    const cleanedTransactionReceipt = Object.assign({}, cleanedTransaction);
+    Object.keys(transactionReceipt).forEach((key) => {
+        if (!transactionReceipt[key])
+            return;
+        switch (key) {
+            case 'status':
+                cleanedTransactionReceipt[key] = Number(hexToDecimal(transactionReceipt[key]));
+                break;
+            case 'contractAddress':
+                if (transactionReceipt[key]) {
+                    cleanedTransactionReceipt[key] = toChecksumAddress(transactionReceipt[key]);
+                }
+                break;
+            case 'cumulativeGasUsed':
+            case 'effectiveGasPrice':
+            case 'gasUsed':
+                cleanedTransactionReceipt[key] = tinyBig(hexToDecimal(transactionReceipt[key]));
+                break;
+            case 'logs':
+                transactionReceipt[key].forEach((log, index) => {
+                    Object.keys(log).forEach((logKey) => {
+                        switch (logKey) {
+                            case 'address':
+                                cleanedTransactionReceipt[key][index][logKey] =
+                                    toChecksumAddress(log[logKey]);
+                                break;
+                            case 'blockNumber':
+                            case 'logIndex':
+                            case 'transactionIndex':
+                                cleanedTransactionReceipt[key][index][logKey] = Number(hexToDecimal(log[logKey]));
+                                break;
+                            case 'removed':
+                                delete log[logKey];
+                                break;
+                        }
+                    });
+                });
+        }
+    });
+    cleanedTransactionReceipt.byzantium =
+        cleanedTransactionReceipt.blockNumber >= 4370000;
+    return cleanedTransactionReceipt;
+}

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_getTransactionCount';
+declare type RPCMethodName = 'eth_getBlockByNumber' | 'eth_getBlockByHash' | 'eth_call' | 'eth_chainId' | 'eth_gasPrice' | 'eth_getBalance' | 'eth_getTransactionByHash' | 'eth_getTransactionReceipt' | 'eth_getTransactionCount';
 export declare function buildRPCPostBody(method: RPCMethodName, params: unknown[]): {
     jsonrpc: string;
     id: number;

package/lib/esm/index.d.ts

@@ -11,7 +11,10 @@ import { etherToWei } from './utils/ether-to-wei';
 import { gweiToEther } from './utils/gwei-to-ether';
 import { isAddress } from './utils/is-address';
 import { toChecksumAddress } from './utils/to-checksum-address';
+import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
 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, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, toUtf8Bytes, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };

package/lib/esm/index.js

@@ -7,7 +7,10 @@ import { etherToWei } from './utils/ether-to-wei';
 import { gweiToEther } from './utils/gwei-to-ether';
 import { isAddress } from './utils/is-address';
 import { toChecksumAddress } from './utils/to-checksum-address';
+import { toUtf8Bytes } from './utils/to-utf8-bytes';
 import { weiToEther } from './utils/wei-to-ether';
 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, Contract, TinyBig, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, toUtf8Bytes, Contract, TinyBig, };

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

@@ -1 +1 @@
-export declare const version = "0.5.4-alpha.0";
+export declare const version = "0.5.4";

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

@@ -1 +1 @@
-export const version = '0.5.4-alpha.0';
+export const version = '0.5.4';

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

@@ -1,7 +1,7 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
 import { BlockResponse, BlockTag } from '../types/Block.types';
 import { Network } from '../types/Network.types';
-import { TransactionResponse } from '../types/Transaction.types';
+import { TransactionReceipt, TransactionResponse } from '../types/Transaction.types';
 export declare abstract class BaseProvider {
     abstract selectRpcUrl(): string;
     abstract post(body: Record<string, unknown>): Promise<any>;
@@ -10,6 +10,7 @@ export declare abstract class BaseProvider {
     constructor(rpcUrls: string[]);
     getNetwork(): Promise<Network>;
     getTransaction(transactionHash: string): Promise<TransactionResponse>;
+    getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
     getTransactionCount(address: string, blockTag?: BlockTag): Promise<number>;
     getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
     getGasPrice(): Promise<TinyBig>;

package/lib/esm/providers/BaseProvider.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { cleanBlock } from '../classes/utils/clean-block';
 import { cleanTransaction } from '../classes/utils/clean-transaction';
+import { cleanTransactionReceipt } from '../classes/utils/clean-transaction-receipt';
 import { buildRPCPostBody, post } from '../classes/utils/fetchers';
 import { hexToDecimal } from '../classes/utils/hex-to-decimal';
 import { tinyBig } from '../shared/tiny-big/tiny-big';
@@ -43,6 +44,18 @@ export class BaseProvider {
             return cleanedTransaction;
         });
     }
+    getTransactionReceipt(transactionHash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [rpcTransaction, blockNumber] = yield Promise.all([
+                this.post(buildRPCPostBody('eth_getTransactionReceipt', [transactionHash])),
+                this.getBlock('latest'),
+            ]);
+            const cleanedTransactionReceipt = cleanTransactionReceipt(rpcTransaction);
+            cleanedTransactionReceipt.confirmations =
+                blockNumber.number - cleanedTransactionReceipt.blockNumber + 1;
+            return cleanedTransactionReceipt;
+        });
+    }
     getTransactionCount(address, blockTag = 'latest') {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof blockTag === 'number') {

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

@@ -20,6 +20,24 @@ export declare type TransactionResponse = Modify<RPCTransaction, {
     maxPriorityFeePerGas: TinyBig;
     confirmations: number;
 }>;
+export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
+    blockNumber: number;
+    cumulativeGasUsed: TinyBig;
+    effectiveGasPrice: TinyBig;
+    gasUsed: TinyBig;
+    logs: Array<Log>;
+    status: number;
+    transactionIndex: number;
+    type: number;
+} & {
+    byzantium: boolean;
+    confirmations: number;
+}>;
+export declare type Log = Modify<Omit<RPCLog, 'removed'>, {
+    blockNumber: number;
+    logIndex: number;
+    transactionIndex: number;
+}>;
 export declare type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
 export interface RPCBlockTransaction {
     blockHash: string;
@@ -39,4 +57,31 @@ export interface RPCBlockTransaction {
     v: string;
     value: string;
 }
+export interface RPCTransactionReceipt {
+    blockHash: string;
+    blockNumber: string;
+    contractAddress: string;
+    cumulativeGasUsed: string;
+    effectiveGasPrice: string;
+    from: string;
+    gasUsed: string;
+    logs: Array<RPCLog>;
+    logsBloom: string;
+    status: string;
+    to: string;
+    transactionHash: string;
+    transactionIndex: string;
+    type: string;
+}
+export interface RPCLog {
+    address: string;
+    blockHash: string;
+    blockNumber: string;
+    data: string;
+    logIndex: string;
+    removed?: boolean;
+    topics: Array<string>;
+    transactionHash: string;
+    transactionIndex: string;
+}
 export {};

package/lib/esm/utils/bytes.d.ts

@@ -1,5 +1,6 @@
 export declare type Bytes = ArrayLike<number>;
-export declare type BytesLike = Bytes | string | number;
+export declare type BytesLike = Bytes | string;
+export declare type BytesLikeWithNumber = BytesLike | number;
 export interface DataOptions {
     allowMissingPrefix?: boolean;
     hexPad?: 'left' | 'right' | null;
@@ -26,14 +27,14 @@ export interface Signature {
 export declare function isBytesLike(value: any): value is BytesLike;
 export declare function isBytes(value: any): value is Bytes;
 export declare function arrayify(value: BytesLike | Hexable | number, options?: DataOptions): Uint8Array;
-export declare function concat(arrayOfBytesLike: ReadonlyArray<BytesLike>): Uint8Array;
+export declare function concat(arrayOfBytesLike: ReadonlyArray<BytesLikeWithNumber>): Uint8Array;
 export declare function stripZeros(value: BytesLike): Uint8Array;
 export declare function zeroPad(value: BytesLike, length: number): Uint8Array;
 export declare function isHexString(value: any, length?: number): boolean;
 export declare function hexlify(value: BytesLike | Hexable | number | bigint, options?: DataOptions): string;
 export declare function hexDataLength(data: BytesLike): number | null;
-export declare function hexDataSlice(data: BytesLike, offset: number, endOffset?: number): string;
+export declare function hexDataSlice(data: BytesLikeWithNumber, offset: number, endOffset?: number): string;
 export declare function hexConcat(items: ReadonlyArray<BytesLike>): string;
 export declare function hexValue(value: BytesLike | Hexable | number | bigint): string;
 export declare function hexStripZeros(value: BytesLike): string;
-export declare function hexZeroPad(value: BytesLike, length: number): string;
+export declare function hexZeroPad(value: BytesLikeWithNumber, length: number): string;

package/lib/esm/utils/hash-message.d.ts

@@ -0,0 +1,2 @@
+import { Bytes } from '../index';
+export declare function hashMessage(message: Bytes | string): string;

package/lib/esm/utils/hash-message.js

@@ -0,0 +1,12 @@
+import { concat, keccak256, toUtf8Bytes } from '../index';
+const messagePrefix = '\x19Ethereum Signed Message:\n';
+export function hashMessage(message) {
+    if (typeof message === 'string') {
+        message = toUtf8Bytes(message);
+    }
+    return keccak256(concat([
+        toUtf8Bytes(messagePrefix),
+        toUtf8Bytes(String(message.length)),
+        message,
+    ]));
+}

package/lib/esm/utils/keccak256.d.ts

@@ -0,0 +1,2 @@
+import { BytesLike } from './bytes';
+export declare const keccak256: (data: BytesLike) => string;

package/lib/esm/utils/keccak256.js

@@ -0,0 +1,13 @@
+import { Keccak } from 'sha3';
+export const keccak256 = (data) => {
+    let bufferableData;
+    if (typeof data === 'string') {
+        bufferableData = Buffer.from(data.replace(/^0x/, ''), 'hex');
+    }
+    else {
+        bufferableData = Buffer.from(data);
+    }
+    const keccak = new Keccak(256);
+    const addressHash = '0x' + keccak.update(bufferableData).digest('hex');
+    return addressHash;
+};

package/lib/esm/utils/solidity-keccak256.d.ts

@@ -1,3 +1,2 @@
 export declare function pack(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string;
-export declare const hashKeccak256: (data: string) => string;
 export declare function solidityKeccak256(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string;

package/lib/esm/utils/solidity-keccak256.js

@@ -1,9 +1,9 @@
 import { Buffer } from 'buffer';
-import { Keccak } from 'sha3';
 import { hexFalse } from '../classes/utils/encode-decode-transaction';
 import { logger } from '../logger/logger';
 import { tinyBig } from '../shared/tiny-big/tiny-big';
 import { arrayify, concat, hexlify, zeroPad } from './bytes';
+import { keccak256 } from './keccak256';
 const regexBytes = new RegExp('^bytes([0-9]+)$');
 const regexNumber = new RegExp('^(u?int)([0-9]*)$');
 const regexArray = new RegExp('^(.*)\\[([0-9]*)\\]$');
@@ -80,12 +80,6 @@ export function pack(types, values) {
     });
     return hexlify(concat(tight));
 }
-export const hashKeccak256 = (data) => {
-    const keccak = new Keccak(256);
-    const bufferableData = Buffer.from(data.replace(/^0x/, ''), 'hex');
-    const addressHash = '0x' + keccak.update(bufferableData).digest('hex');
-    return addressHash;
-};
 export function solidityKeccak256(types, values) {
-    return hashKeccak256(pack(types, values));
+    return keccak256(pack(types, values));
 }

package/lib/esm/utils/to-utf8-bytes.d.ts

@@ -0,0 +1 @@
+export declare function toUtf8Bytes(data: string): Uint8Array;

package/lib/esm/utils/to-utf8-bytes.js

@@ -0,0 +1,3 @@
+export function toUtf8Bytes(data) {
+    return new Uint8Array(Buffer.from(data));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "essential-eth",
   "description": "Ultralight JS library for Ethereum utilities",
-  "version": "0.5.4-alpha.0",
+  "version": "0.5.4",
   "license": "MIT",
   "sideEffects": false,
   "main": "./lib/cjs/index.js",
@@ -59,7 +59,7 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
     "typedoc": "^0.22.13",
-    "typescript": "^4.6.3",
+    "typescript": "^4.6.4",
     "web3": "^1.7.3"
   },
   "dependencies": {

package/readme.md

@@ -650,5 +650,9 @@ Any function on a contract. Returns are the same as `ethers.js`, except that ins
 
 <br/>
 
+![Alt](https://repobeats.axiom.co/api/embed/e479d8f777288a94cdde2fe3cdedf38d5243793d.svg 'Repobeats analytics image')
+
+<br/>
+
 - [📓 View full docs](https://essential-eth.vercel.app)
 - [📓 View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)