essential-eth 0.5.9 → 0.5.10-next.0

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

@@ -1,137 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decodeRPCResponse = exports.encodeData = exports.hexFalse = void 0;
-const sha3_1 = require("sha3");
-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[]') {
-        return 'uint256[]';
-    }
-    else if (type === 'int[]') {
-        return 'int256[]';
-    }
-    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 */
-    const functionString = `${jsonABIArgument.name}(${jsonABIArgument.inputs.map((input) => expandType(input.type))})`;
-    // encoding learnt from https://ethereum.stackexchange.com/questions/3514/how-to-call-a-contract-method-using-the-eth-call-json-rpc-api
-    const functionHash = hash.update(functionString).digest('hex');
-    // no arrays
-    const jsonABIInputsLength = jsonABIArgument.inputs.length;
-    let shouldValidateInputLength = true;
-    // inputs contains 1 or more arrays
-    if (jsonABIArgument.inputs.find((input) => input.type.includes('['))) {
-        shouldValidateInputLength = false;
-    }
-    if (shouldValidateInputLength && args.length !== jsonABIInputsLength) {
-        throw new Error(`args inputs  of "${args.length}" does not match expected length of "${jsonABIArgument.inputs.length}"`);
-    }
-    const argsWithTypes = (jsonABIArgument.inputs || []).reduce((acc, input, i) => {
-        var _a;
-        if (input.type.includes('[')) {
-            // strip array and length like "[2]" from type
-            const basicType = (_a = /([^[]*)\[.*$/g.exec(input.type)) === null || _a === void 0 ? void 0 : _a[1];
-            args.forEach((arg) => {
-                acc = acc.concat([[arg, basicType]]);
-            });
-            return acc;
-        }
-        else {
-            return acc.concat([[args[i], input.type]]);
-        }
-    }, []);
-    const encodedArgs = argsWithTypes.map(([arg, inputType]) => {
-        let rawArg = arg;
-        switch (inputType) {
-            case 'bool':
-                return arg ? hexTrue : exports.hexFalse;
-            case 'address':
-                // remove leading "0x"
-                rawArg = arg.replace(/^0x/g, '').toLowerCase();
-                break;
-            default:
-                if (inputType.startsWith('bytes')) {
-                    // encode each character to hex
-                    const argEncoded = rawArg
-                        .split('')
-                        .map((character) => character.charCodeAt(0).toString(16))
-                        .join('');
-                    const paddedEncodedArg = argEncoded.padEnd(64, '0');
-                    return paddedEncodedArg;
-                }
-                else if (inputType === 'uint256') {
-                    const argEncoded = BigInt(arg).toString(16);
-                    const paddedEncodedArg = argEncoded.padStart(64, '0');
-                    return paddedEncodedArg;
-                }
-                else if (inputType.startsWith('uint')) {
-                    break;
-                }
-                else {
-                    throw new Error(`essential-eth does not yet support "${inputType}" inputs. Make a PR today!"`);
-                }
-        }
-        const argEncoded = rawArg.toString(16);
-        const paddedEncodedArg = argEncoded.padStart(64, '0');
-        return paddedEncodedArg;
-    });
-    const functionEncoded = functionHash.slice(0, 8);
-    const data = `0x${functionEncoded}${encodedArgs.join('')}`;
-    return data;
-}
-exports.encodeData = encodeData;
-/**
- *
- * @param jsonABIArgument
- * @param nodeResponse
- * @example
- */
-function decodeRPCResponse(jsonABIArgument, nodeResponse) {
-    const rawOutputs = jsonABIArgument.outputs;
-    // chunk response every 64 characters
-    const encodedOutputs = nodeResponse.slice(2).match(/.{1,64}/g);
-    const outputs = (encodedOutputs || []).map((output, i) => {
-        const outputType = (rawOutputs || [])[i].type;
-        switch (outputType) {
-            case 'bool':
-                return output === hexTrue;
-            case 'address':
-                /* address types have 26 leading zeroes to remove */
-                return (0, __1.toChecksumAddress)(`0x${output.slice(24)}`);
-            case 'uint256':
-                return (0, __1.tinyBig)((0, hex_to_decimal_1.hexToDecimal)(`0x${output}`));
-            case 'bytes32':
-                return `0x${output}`;
-            case 'uint8':
-                return Number((0, hex_to_decimal_1.hexToDecimal)(`0x${output}`));
-            default:
-                throw new Error(`essential-eth does not yet support "${outputType}" outputs. Make a PR today!"`);
-        }
-    });
-    return outputs.length === 1 ? outputs[0] : outputs;
-}
-exports.decodeRPCResponse = decodeRPCResponse;

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

@@ -1,39 +0,0 @@
-/**
- * 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_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;
-    method: RPCMethodName;
-    params: unknown[];
-};
-export {};

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

@@ -1,81 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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',
-        headers: {
-            'Content-Type': 'application/json',
-        },
-        body: JSON.stringify(body),
-    })
-        .then((r) => __awaiter(this, void 0, void 0, function* () {
-        const t = yield r.text();
-        try {
-            return JSON.parse(t);
-        }
-        catch (_a) {
-            throw new Error(`Invalid JSON RPC response: "${t}"`);
-        }
-    }))
-        .then((response) => {
-        const result = response === null || response === void 0 ? void 0 : response.result;
-        if (!result) {
-            throw new Error(`Invalid JSON RPC response: ${JSON.stringify(response)}`);
-        }
-        return response.result;
-    });
-}
-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',
-        id: 1,
-        method,
-        params,
-    };
-}
-exports.buildRPCPostBody = buildRPCPostBody;

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

@@ -1,18 +0,0 @@
-/**
- * Converts a hexadecimal string it's decimal equivalent.
- * 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

@@ -1,24 +0,0 @@
-"use strict";
-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.
- *
- * @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();
-}
-exports.hexToDecimal = hexToDecimal;

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

@@ -1,6 +0,0 @@
-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

@@ -1,45 +0,0 @@
-"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

@@ -1,25 +0,0 @@
-import { BaseContract, Contract } from './classes/Contract';
-import { ConstructorOptions, FallthroughProvider } from './providers/FallthroughProvider';
-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, 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';
-import { etherToWei } from './utils/ether-to-wei';
-import { gweiToEther } from './utils/gwei-to-ether';
-import { hashMessage } from './utils/hash-message';
-import { isAddress } from './utils/is-address';
-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 './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, Filter, FilterByBlockHash, JSONABI, JSONABIArgument, Network, TransactionResponse, RPCBlock, RPCTransaction, RPCTransactionReceipt, TransactionRequest, RPCTransactionRequest, TransactionReceipt, BlockTag, RPCLog, Log, BlockTransactionResponse, ConstructorOptions, };

package/lib/cjs/index.js

@@ -1,54 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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.BaseContract = exports.TinyBig = exports.Contract = exports.computePublicKey = exports.computeAddress = exports.toUtf8Bytes = exports.splitSignature = exports.hashMessage = 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, "BaseContract", { enumerable: true, get: function () { return Contract_1.BaseContract; } });
-Object.defineProperty(exports, "Contract", { enumerable: true, get: function () { return Contract_1.Contract; } });
-const FallthroughProvider_1 = require("./providers/FallthroughProvider");
-Object.defineProperty(exports, "FallthroughProvider", { enumerable: true, get: function () { return FallthroughProvider_1.FallthroughProvider; } });
-const JsonRpcProvider_1 = require("./providers/JsonRpcProvider");
-Object.defineProperty(exports, "JsonRpcProvider", { enumerable: true, get: function () { return JsonRpcProvider_1.JsonRpcProvider; } });
-Object.defineProperty(exports, "jsonRpcProvider", { enumerable: true, get: function () { return JsonRpcProvider_1.jsonRpcProvider; } });
-const tiny_big_1 = require("./shared/tiny-big/tiny-big");
-Object.defineProperty(exports, "tinyBig", { enumerable: true, get: function () { return tiny_big_1.tinyBig; } });
-Object.defineProperty(exports, "TinyBig", { enumerable: true, get: function () { return tiny_big_1.TinyBig; } });
-const compute_address_1 = require("./utils/compute-address");
-Object.defineProperty(exports, "computeAddress", { enumerable: true, get: function () { return compute_address_1.computeAddress; } });
-const compute_public_key_1 = require("./utils/compute-public-key");
-Object.defineProperty(exports, "computePublicKey", { enumerable: true, get: function () { return compute_public_key_1.computePublicKey; } });
-const ether_to_gwei_1 = require("./utils/ether-to-gwei");
-Object.defineProperty(exports, "etherToGwei", { enumerable: true, get: function () { return ether_to_gwei_1.etherToGwei; } });
-const ether_to_wei_1 = require("./utils/ether-to-wei");
-Object.defineProperty(exports, "etherToWei", { enumerable: true, get: function () { return ether_to_wei_1.etherToWei; } });
-const gwei_to_ether_1 = require("./utils/gwei-to-ether");
-Object.defineProperty(exports, "gweiToEther", { enumerable: true, get: function () { return gwei_to_ether_1.gweiToEther; } });
-const hash_message_1 = require("./utils/hash-message");
-Object.defineProperty(exports, "hashMessage", { enumerable: true, get: function () { return hash_message_1.hashMessage; } });
-const is_address_1 = require("./utils/is-address");
-Object.defineProperty(exports, "isAddress", { enumerable: true, get: function () { return is_address_1.isAddress; } });
-const split_signature_1 = require("./utils/split-signature");
-Object.defineProperty(exports, "splitSignature", { enumerable: true, get: function () { return split_signature_1.splitSignature; } });
-const to_checksum_address_1 = require("./utils/to-checksum-address");
-Object.defineProperty(exports, "toChecksumAddress", { enumerable: true, get: function () { return to_checksum_address_1.toChecksumAddress; } });
-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/logger.d.ts

@@ -1,11 +0,0 @@
-declare class Logger {
-    private packageVersion;
-    constructor();
-    throwError(message: string, args: {
-        [key: string]: any;
-    }): never;
-    throwArgumentError(message: string, arg: string, value: any): never;
-    checkSafeUint53(value: number, message?: string): void;
-}
-export declare const logger: Logger;
-export {};

package/lib/cjs/logger/logger.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = void 0;
-const package_version_1 = require("./package-version");
-class Logger {
-    constructor() {
-        this.packageVersion = package_version_1.version;
-    }
-    throwError(message, args) {
-        const argsLength = Object.keys(args).length;
-        throw new Error(`${message} (${Object.entries(args).map(([key, value], index) => `${key}=${value}${index < argsLength - 1 && ', '}`)}, version=essential-eth@${this.packageVersion})`);
-    }
-    throwArgumentError(message, arg, value) {
-        throw new Error(`${message} (argument="${arg}" value=${value}, version=essential-eth@${this.packageVersion})`);
-    }
-    checkSafeUint53(value, message = 'value not safe') {
-        if (typeof value !== 'number') {
-            return;
-        }
-        if (value < 0 || value >= 0x1fffffffffffff) {
-            this.throwError(message, {
-                operation: 'checkSafeInteger',
-                fault: 'out-of-safe-range',
-                value: value,
-            });
-        }
-        if (value % 1) {
-            this.throwError(message, {
-                operation: 'checkSafeInteger',
-                fault: 'non-integer',
-                value: value,
-            });
-        }
-    }
-}
-exports.logger = new Logger();

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

@@ -1 +0,0 @@
-export declare const version = "0.5.9";

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

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = void 0;
-// Generated by genversion.
-exports.version = '0.5.9';