essential-eth 0.5.1 → 0.5.4-alpha.0

package/lib/cjs/classes/Contract.d.ts

@@ -18,8 +18,9 @@ export declare class BaseContract {
  */
 export declare function defineReadOnly<T>(object: T, name: string, value: any): void;
 /**
+ * @alpha
  * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
- *
+ * * Only read-only function calls currently supported.
  * @example
  * ```typescript
  * import { Contract, JsonRpcProvider } from 'essential-eth';
@@ -65,7 +66,7 @@ export declare function defineReadOnly<T>(object: T, name: string, value: any):
  */
 export declare class Contract extends BaseContract {
     /**
-     * The dynamic contract calls on any given contract. Like "isClaimed", "merkleRoot", etc.
+     * The function names on any given contract. Like "isClaimed", "merkleRoot", etc.
      */
     readonly [key: string]: any;
 }

package/lib/cjs/classes/Contract.js

@@ -51,7 +51,7 @@ class BaseContract {
                             ? estimateGas(data)
                             : null;
                     const req = () => __awaiter(this, void 0, void 0, function* () {
-                        return yield (0, fetchers_1.post)(this._provider._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_call', [
+                        return yield (0, fetchers_1.post)(this._provider.selectRpcUrl(), (0, fetchers_1.buildRPCPostBody)('eth_call', [
                             Object.assign({ to: this._address.toLowerCase(), data }, (decimalGas
                                 ? { gas: `0x${decimalGas.toString(16)}` }
                                 : {})),
@@ -78,8 +78,9 @@ function defineReadOnly(object, name, value) {
 }
 exports.defineReadOnly = defineReadOnly;
 /**
+ * @alpha
  * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
- *
+ * * Only read-only function calls currently supported.
  * @example
  * ```typescript
  * import { Contract, JsonRpcProvider } from 'essential-eth';

package/lib/cjs/classes/utils/encode-decode-transaction.d.ts

@@ -1,3 +1,4 @@
 import { JSONABIArgument } from '../../types/Contract.types';
+export declare const hexFalse: string;
 export declare function encodeData(jsonABIArgument: JSONABIArgument, args: any[]): string;
 export declare function decodeRPCResponse(jsonABIArgument: JSONABIArgument, nodeResponse: string): string | number | boolean | import("../..").TinyBig | (string | number | boolean | import("../..").TinyBig)[];

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

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decodeRPCResponse = exports.encodeData = void 0;
+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");
-const hexTrue = '0000000000000000000000000000000000000000000000000000000000000001';
-const hexFalse = '0000000000000000000000000000000000000000000000000000000000000000';
+exports.hexFalse = '0'.repeat(64);
+const hexTrue = '0'.repeat(63) + '1';
 function expandType(type) {
     // https://docs.soliditylang.org/en/v0.8.7/types.html#integers
     if (type === 'uint[]') {
@@ -50,7 +50,7 @@ function encodeData(jsonABIArgument, args) {
         let rawArg = arg;
         switch (inputType) {
             case 'bool':
-                return arg ? hexTrue : hexFalse;
+                return arg ? hexTrue : exports.hexFalse;
             case 'address':
                 // remove leading "0x"
                 rawArg = arg.replace(/^0x/g, '').toLowerCase();

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

package/lib/cjs/index.d.ts

@@ -1,4 +1,5 @@
 import { Contract } from './classes/Contract';
+import { FallthroughProvider } from './providers/FallthroughProvider';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
 import { BlockResponse } from './types/Block.types';
@@ -13,4 +14,4 @@ import { toChecksumAddress } from './utils/to-checksum-address';
 import { weiToEther } from './utils/wei-to-ether';
 export * from './utils/bytes';
 export * from './utils/solidity-keccak256';
-export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };
+export { etherToWei, etherToGwei, isAddress, jsonRpcProvider, JsonRpcProvider, FallthroughProvider, tinyBig, toChecksumAddress, weiToEther, gweiToEther, Contract, TinyBig, BlockResponse, ContractTypes, JSONABI, JSONABIArgument, Network, TransactionResponse, };

package/lib/cjs/index.js

@@ -14,9 +14,11 @@ 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.JsonRpcProvider = exports.jsonRpcProvider = exports.isAddress = exports.etherToGwei = exports.etherToWei = void 0;
+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;
 const Contract_1 = require("./classes/Contract");
 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; } });

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

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

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

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

@@ -0,0 +1,261 @@
+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';
+export declare abstract class BaseProvider {
+    /**
+     * ignore
+     */
+    abstract selectRpcUrl(): string;
+    abstract post(body: Record<string, unknown>): Promise<any>;
+    /**
+     * @ignore
+     */
+    readonly _rpcUrls: string[];
+    /**
+     * @ignore
+     */
+    protected _post: (body: Record<string, unknown>) => Promise<any>;
+    /**
+     * @param rpcUrl The URL to your Eth node. Consider POKT or Infura
+     */
+    constructor(rpcUrls: string[]);
+    /**
+     * Returns the network this provider is connected to
+     */
+    getNetwork(): Promise<Network>;
+    /**
+     * * Similar to [`ethers.provider.getTransaction`](https://docs.ethers.io/v5/api/providers/provider/#Provider-getTransaction), some information not included
+     *
+     * @returns information about one transaction
+     * @example
+     * ```js
+     * await provider.getTransaction('0x9014ae6ef92464338355a79e5150e542ff9a83e2323318b21f40d6a3e65b4789');
+     *  {
+     *    accessList: [],
+     *    blockHash: '0x876810a013dbcd140f6fd6048c1dc33abbb901f1f96b394c2fa63aef3cb40b5d',
+     *    blockNumber: 14578286,
+     *    chainId: 1,
+     *    from: '0xdfD9dE5f6FA60BD70636c0900752E93a6144AEd4',
+     *    gas: Big {
+     *    s: 1,
+     *    e: 5,
+     *    c: [ 1, 1, 2, 1, 6, 3 ],
+     *    constructor: <ref *1> [Function: Big] {
+     *    DP: 20,
+     *    RM: 1,
+     *    NE: -7,
+     *    PE: 21,
+     *    strict: false,
+     *    roundDown: 0,
+     *    roundHalfUp: 1,
+     *    roundHalfEven: 2,
+     *    roundUp: 3,
+     *    Big: [Circular *1],
+     *    default: [Circular *1]
+     *    }
+     *    },
+     *    gasPrice: Big {
+     *    s: 1,
+     *    e: 10,
+     *    c: [
+     *    4, 8, 5, 9, 2,
+     *    4, 2, 6, 8, 5,
+     *    8
+     *    ],
+     *    constructor: <ref *1> [Function: Big] {
+     *    DP: 20,
+     *    RM: 1,
+     *    NE: -7,
+     *    PE: 21,
+     *    strict: false,
+     *    roundDown: 0,
+     *    roundHalfUp: 1,
+     *    roundHalfEven: 2,
+     *    roundUp: 3,
+     *    Big: [Circular *1],
+     *    default: [Circular *1]
+     *    }
+     *    },
+     *    hash: '0x9014ae6ef92464338355a79e5150e542ff9a83e2323318b21f40d6a3e65b4789',
+     *    input: '0x83259f170000000000000000000000000000000000000000000000000000000000000080000000000000000000000000dfd9de5f6fa60bd70636c0900752e93a6144aed400000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000024000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000009e99ad11a214fd016b19dc3648678c5944859ae292b21c24ca94f857836c4596f1950c82dd0c23dd621af4763edc2f66466e63c5df9de0c1107b1cd16bf460fe93e43fd308e3444bc79c3d88a4cb961dc8367ab6ad048867afc76d193bca99cf3a068864ed4a7df1dbf1d4c52238eced3e5e05644b4040fc2b3ccb8557b0e99fff6131305a0ea2b8061b90bd418db5bbdd2e92129f52d93f90531465e309c4caec5b85285822b6196398d36f16f511811b61bbda6461e80e29210cd303118bdcee8df6fa0505ffbe8642094fd2ba4dd458496fe3b459ac880bbf71877c713e969ccf5ed7efab8a84ebc07e3939901371ca427e1192e455a8f35a6a1d7ad09e1475dd1758b36fa631dab5d70e99316b23c4c43094188d360cd9c3457355904e07c00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000162074a7047f',
+     *    maxFeePerGas: Big {
+     *    s: 1,
+     *    e: 10,
+     *    c: [
+     *    6, 7, 6, 8, 1,
+     *    2, 6, 1, 6, 1,
+     *    8
+     *    ],
+     *    constructor: <ref *1> [Function: Big] {
+     *    DP: 20,
+     *    RM: 1,
+     *    NE: -7,
+     *    PE: 21,
+     *    strict: false,
+     *    roundDown: 0,
+     *    roundHalfUp: 1,
+     *    roundHalfEven: 2,
+     *    roundUp: 3,
+     *    Big: [Circular *1],
+     *    default: [Circular *1]
+     *    }
+     *    },
+     *    maxPriorityFeePerGas: Big {
+     *    s: 1,
+     *    e: 9,
+     *    c: [ 1, 5 ],
+     *    constructor: <ref *1> [Function: Big] {
+     *    DP: 20,
+     *    RM: 1,
+     *    NE: -7,
+     *    PE: 21,
+     *    strict: false,
+     *    roundDown: 0,
+     *    roundHalfUp: 1,
+     *    roundHalfEven: 2,
+     *    roundUp: 3,
+     *    Big: [Circular *1],
+     *    default: [Circular *1]
+     *    }
+     *    },
+     *    nonce: 129,
+     *    r: '0x59a7c15b12c18cd68d6c440963d959bff3e73831ffc938e75ecad07f7ee43fbc',
+     *    s: '0x1ebaf05f0d9273b16c2a7748b150a79d22533a8cd74552611cbe620fee3dcf1c',
+     *    to: '0x39B72d136ba3e4ceF35F48CD09587ffaB754DD8B',
+     *    transactionIndex: 29,
+     *    type: 2,
+     *    v: 0,
+     *    value: Big {
+     *    s: 1,
+     *    e: 0,
+     *    c: [ 0 ],
+     *    constructor: <ref *1> [Function: Big] {
+     *    DP: 20,
+     *    RM: 1,
+     *    NE: -7,
+     *    PE: 21,
+     *    strict: false,
+     *    roundDown: 0,
+     *    roundHalfUp: 1,
+     *    roundHalfEven: 2,
+     *    roundUp: 3,
+     *    Big: [Circular *1],
+     *    default: [Circular *1]
+     *    }
+     *    },
+     *    confirmations: 1210
+     *    }
+     * ```
+     */
+    getTransaction(transactionHash: string): Promise<TransactionResponse>;
+    /**
+     * Returns the transaction count from genesis up to specified blockTag
+     *
+     * * Same as `ethers.provider.getTransactionCount`
+     * * Same as `web3.eth.getTransactionCount`
+     *
+     * @example
+     * ```js
+     * const address = '0x71660c4005ba85c37ccec55d0c4493e66fe775d3';
+     *  await provider
+     *   .getTransactionCount(address, 'latest')
+     * // 1060000
+     * ```
+     *
+     * @example
+     * ```js
+     *  await provider
+     *   .getTransactionCount(address)
+     * // 1053312
+     * ```
+     *
+     * @example
+     * ```js
+     *  await provider
+     *   .getTransactionCount(address, 14649390)
+     * // 1053312
+     * ```
+     */
+    getTransactionCount(address: string, blockTag?: BlockTag): Promise<number>;
+    /**
+     * Gets information about a certain block.
+     * Same as `web3.eth.getBlock` and `ethers.providers.getBlock`
+     *
+     * @param timeFrame The number, hash, or text-based description ('latest', 'earliest', or 'pending') of the block to collect information on.
+     *
+     * @param returnTransactionObjects Whether to also return data about the transactions on the block.
+     *
+     * @returns A BlockResponse object with information about the specified block
+     *
+     * @example
+     * ```js
+     * await provider.getBlock(14645431);
+     * ```
+     *
+     * @example
+     * ```js
+     * await provider.getBlock('0x3e5cea9c2be7e0ab4b0aa04c24dafddc37571db2d2d345caf7f88b3366ece0cf');
+     * ```
+     *
+     * @example
+     * ```js
+     * await provider.getBlock('latest');
+     * {
+     *   number: 4232826,
+     *   hash: '0x93211a1cd17e154b183565ec685254a03f844a8e34824a46ce1bdd6753dcb669',
+     *   parentHash: '0x1b32bfcba1bb2a57f56e166a3bb06875a1978992999dfc8828397b4c1526f472',
+     *   sha3Uncles: '0x0fb399c67bb5a071ec8a22549223215ab76b7d4009941c9c37aa3c3936010463',
+     *   logsBloom: '0x00000000000000000000101000000000020000000000000000000000000000000000400000010000000000000000000000000000010000000008800000000800000000200000000000000000000000000000000000000000000002000000000000000000000000000040000000000040000000000000000000000000000000000000000000000001000000000004000000000010000000000000000020000000000000000200100020000000000000000080000000000080001000000000000000000001040000000000000000008000000020010100000000200000100000000000000000000000002000000080000000020400000000002000200000000000',
+     *   transactionsRoot: '0xc43b3f13e1fe810e34d3a26ffe465b72c7063a5c70a02de2c78e91e4d10bd9fb',
+     *   stateRoot: '0x04d7bc816537ea7ef3a16e76c9879d29f34f99d4154273c2e98e012a31bad745',
+     *   receiptsRoot: '0x89c6f781ceac0bd49c4d9aa9115df4a5d4dd0e0220ff7668012f15bc04222c6b',
+     *   miner: '0x31fe561eb2c628cD32Ec52573D7c4b7E4C278Bfa',
+     *   difficulty: '1300907486001755331049',
+     *   totalDifficulty: '5989929395521171616186006183',
+     *   extraData: '0xce018c495249532d62613031656132',
+     *   size: 5416,
+     *   gasLimit: 6800000,
+     *   gasUsed: 202955,
+     *   timestamp: 1649884910,
+     *   transactions: [
+     *     '0x6b34a59c7b9aead24fa6dad782f8a3ad84ed4a23ee09bcbf0bcf880840fbbe20',
+     *     '0x9a3851ca24d5336c6a0d48aba2c4b4769d7a672c9b01729c5eb9924efd1b19a7',
+     *     '0xc3ed3d198b62f2f3427ebfa3bbd0fcada4e3c0c189e4464e7eeceb403c75981e'
+     *   ],
+     *   uncles: [
+     *     '0x0c567c054e98153f10d651fbbc018891c1dd9d62a9ffd998e87678803e95b6ed',
+     *     '0xb7d69389dbfb057c6fcb4bc0582d46a2ba01170703f0dadf8cd1462b83e88753',
+     *     '0xd5f74ccd0ad4c58b3161e8c2c507c264231e5f28925061b809c02e5e4bb6db28'
+     *   ],
+     *   minimumGasPrice: '0x387ee40',
+     *   bitcoinMergedMiningHeader: '0x04000020e8567ed3d2480e15a1dd1b4335e4732ae343c037e4fd03000000000000000000ed10a8340d163d3e813bdd430f902f4e5a56828dc62313b2e23797c0be6b8516eb3e576297d8091735884f42',
+     *   bitcoinMergedMiningCoinbaseTransaction: '0x0000000000000140e910128fda7bac502dc5e0573bbaf12de8e2524f70c22f7bd160dedcb19a2521002b6a2952534b424c4f434b3ae493303f597fa368c0ccc4f8aceabf1c315bb7c9a07605c073a89f260040967aace6a7d9',
+     *   bitcoinMergedMiningMerkleProof: '0xdf63a3d7eb6fbcfb301311faa46e9a15b0408bb1a04e284daee86c273c1dfd65ede23f3170f806e9e0f4cef7ba6b56aa37470d9c23f96ec8e43d08b58645919c5e10bcb892897a731f8f9ce79c72dc0e390896bcd6c67bb38c0bdb72982b6cf05519968d76673572c3f3ef3a08b0ddb464863f1788f7cdbaad3fe44a8a8af576d430ac282fe28852c16df198ca96cc5f71a50695912efe1a836e8442be69e31b6d6f973da2818bce9a3a1c2d9be0671aee9a7776e398d6a03d1e178e20d84646004a3d03c0501334e629d9146aa6a01316dcbaa289df6e6c5e3090cadaddff22699cfc7ff09512fc0d65c5062f17c98561ce3c9510de210d9d654cf99f8d756ff37c9fa21e7122ee8cadb923341690845d572921425f2bd7e044558b7e07983ac4df28928028b0c13c3624dc7a965af8091b0cecc845bf7da5308c03b2c97d607f6706a599f802025894435f1d76ea4e67cc2fc4e1559f1206f559a24633de0f',
+     *   hashForMergedMining: '0xe493303f597fa368c0ccc4f8aceabf1c315bb7c9a07605c073a89f260040967a',
+     *   paidFees: '0xc0744dcb7a0',
+     *   cumulativeDifficulty: '0x1190930db285269e582'
+     *   }
+     *```
+     */
+    getBlock(timeFrame?: BlockTag, returnTransactionObjects?: boolean): Promise<BlockResponse>;
+    /**
+     * Returns the current gas price in wei as TinyBig
+     * Same as `ethers.provider.getGasPrice`
+     */
+    getGasPrice(): Promise<TinyBig>;
+    /**
+     * Returns the balance of the account in wei as TinyBig
+     * * Same as [`ethers.provider.getBalance`](https://docs.ethers.io/v5/api/providers/provider/#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>;
+}