essential-eth 0.2.2 → 0.3.3

package/lib/cjs/utils/tests/is-address.test.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+const web3_1 = __importDefault(require("web3"));
+const index_1 = require("../../index");
+describe('is-address', () => {
+    it('should validate real addresses', () => {
+        const addresses = [
+            '0x52908400098527886E0F7030069857D2E4169EE7',
+            '0x8617E340B3D01FA5F11F306F4090FD50E238070D',
+            '0xde709f2102306220921060314715629080e2fb77',
+            '0x27b1fdb04752bbc536007a920d24acb045561c26',
+            '0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed',
+            '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359',
+            '0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB',
+            '0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb',
+            '27b1fdb04752bbc536007a920d24acb045561c26' /* leading "0x" is not required */,
+        ];
+        addresses.forEach((address) => {
+            expect((0, index_1.isAddress)(address)).toStrictEqual(ethers_1.utils.isAddress(address));
+            expect((0, index_1.isAddress)(address)).toStrictEqual(web3_1.default.utils.isAddress(address));
+        });
+    });
+    it('should return false on invalid addresses', () => {
+        const addresses = [
+            '0x5290840009852',
+            '0x8617E340b3D01FA5F11F306F4090FD50E238070D',
+            '0x8617e340b3d01FA5F11F306F4090FD50E238070D' /* invalid checksum */,
+            ' 0xde709f2102306220921060314715629080e2fb77',
+            'dawsbot.eth' /* ens invalid */,
+            '',
+            'xyz',
+            '0x123',
+        ];
+        addresses.forEach((address) => {
+            const essentialEthIsAddress = (0, index_1.isAddress)(address);
+            const ethersIsAddress = ethers_1.utils.isAddress(address);
+            const web3IsAddress = web3_1.default.utils.isAddress(address);
+            expect(essentialEthIsAddress).toStrictEqual(ethersIsAddress);
+            expect(essentialEthIsAddress).toStrictEqual(web3IsAddress);
+        });
+    });
+    it('invalid type inputs', () => {
+        expect(() => {
+            // @ts-expect-error should not accept boolean
+            (0, index_1.isAddress)(false);
+        }).toThrow('string required. Received boolean');
+        expect(() => {
+            // @ts-expect-error should not accept array
+            (0, index_1.isAddress)([1, 2, 3]);
+        }).toThrow('string required. Received object');
+    });
+});

package/lib/cjs/utils/tests/to-checksum-address.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cjs/utils/tests/to-checksum-address.test.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+const web3_1 = __importDefault(require("web3"));
+const index_1 = require("../../index");
+describe('ether-to-wei', () => {
+    it('happy path', () => {
+        const addresses = [
+            '0x52908400098527886E0F7030069857D2E4169EE7',
+            '0x8617E340B3D01FA5F11F306F4090FD50E238070D',
+            '0xde709f2102306220921060314715629080e2fb77',
+            '0x27b1fdb04752bbc536007a920d24acb045561c26',
+            '0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed',
+            '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359',
+            '0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB',
+            '0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb',
+        ];
+        addresses.forEach((address) => {
+            expect((0, index_1.toChecksumAddress)(address)).toStrictEqual(ethers_1.utils.getAddress(address));
+            expect((0, index_1.toChecksumAddress)(address)).toStrictEqual(web3_1.default.utils.toChecksumAddress(address));
+        });
+    });
+    it('invalid inputs', () => {
+        const invalidChecksumAddress = '0x8617E340b3D01FA5F11F306F4090FD50E238070D';
+        expect(() => {
+            (0, index_1.toChecksumAddress)(invalidChecksumAddress);
+        }).toThrow(`Invalid Checksum address for "${invalidChecksumAddress}"`);
+        expect(() => {
+            // @ts-expect-error should not accept boolean
+            (0, index_1.toChecksumAddress)(false);
+        }).toThrow('string required. Received boolean');
+        expect(() => {
+            // @ts-expect-error should not accept array
+            (0, index_1.toChecksumAddress)([1, 2, 3]);
+        }).toThrow('string required. Received object');
+        expect(() => {
+            (0, index_1.toChecksumAddress)('0x1');
+        }).toThrow('Invalid Ethereum address "0x1"');
+    });
+});

package/lib/cjs/utils/tests/wei-to-ether.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cjs/utils/tests/wei-to-ether.test.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const big_js_1 = __importDefault(require("big.js"));
+const ethers = __importStar(require("ethers"));
+const web3_1 = __importDefault(require("web3"));
+const index_1 = require("../../index");
+describe('wei-to-ether', () => {
+    it('happy path', () => {
+        expect((0, index_1.weiToEther)('100000000000000000000.0').toString()).toStrictEqual('100');
+        expect((0, index_1.weiToEther)(100000000000000000000.0).toString()).toStrictEqual('100');
+        expect((0, index_1.weiToEther)('1000000000000000000000.0').toNumber()).toStrictEqual(1000);
+        expect((0, index_1.weiToEther)(1000000000000000000000.0).toNumber()).toStrictEqual(1000);
+        expect((0, index_1.weiToEther)((0, index_1.tinyBig)('1000000000000000000000.0')).toNumber()).toStrictEqual(1000);
+        expect((0, index_1.weiToEther)((0, index_1.tinyBig)(1000000000000000000000.0)).toNumber()).toStrictEqual(1000);
+        expect((0, index_1.weiToEther)((0, big_js_1.default)('1000000000000000000000.0')).toNumber()).toStrictEqual(1000);
+        expect((0, index_1.weiToEther)((0, big_js_1.default)(1000000000000000000000.0)).toNumber()).toStrictEqual(1000);
+    });
+    describe('matches ethers and web3 toString', () => {
+        it('toString', () => {
+            expect((0, index_1.weiToEther)('10').toString()).toStrictEqual(ethers.utils.formatEther('10'));
+            expect((0, index_1.weiToEther)('1000000000000000000000').toString()).toStrictEqual('1000');
+            expect((0, index_1.weiToEther)('10').toString()).toStrictEqual(web3_1.default.utils.fromWei('10', 'ether'));
+            expect((0, index_1.weiToEther)('1000000000000000000000').toString()).toStrictEqual(web3_1.default.utils.fromWei('1000000000000000000000', 'ether'));
+        });
+        it('toNumber', () => {
+            /* easy */
+            expect((0, index_1.weiToEther)('9').toNumber()).toStrictEqual(Number(ethers.utils.formatEther('9')));
+            // expect(weiToEther("9").toNumber()).toStrictEqual(
+            //   Number(ethers.utils.formatEther("9")),
+            // );
+            expect((0, index_1.weiToEther)('9').toNumber()).toStrictEqual(Number(web3_1.default.utils.fromWei('9', 'ether')));
+            /* hard because they respond with scientific notation or overflowing */
+            expect((0, index_1.weiToEther)('999999').toNumber()).toStrictEqual(Number(ethers.utils.formatEther('999999')) /* overflow error if you use the ".toNumber()", */);
+            expect((0, index_1.weiToEther)('999999').toNumber()).toStrictEqual(Number(web3_1.default.utils.fromWei('999999', 'ether')));
+        });
+    });
+    it('wrong types', () => {
+        expect(() => {
+            // @ts-expect-error should not accept boolean
+            (0, index_1.weiToEther)(false);
+        }).toThrow();
+        expect(() => {
+            // @ts-expect-error should not accept array
+            (0, index_1.weiToEther)([1, 2, 3]);
+        }).toThrow();
+    });
+});

package/lib/cjs/{to-checksum-address.js → utils/to-checksum-address.js}

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toChecksumAddress = void 0;
 const sha3_1 = require("sha3");
-const validate_type_1 = require("./shared/validate-type");
+const validate_type_1 = require("../shared/validate-type");
 /**
  * Returns an Ethereum address in proper mixed-case checksum.
  * Does NOT support ICAP

package/lib/cjs/{wei-to-ether.d.ts → utils/wei-to-ether.d.ts}

@@ -1,3 +1,5 @@
+import Big from 'big.js';
+import { TinyBig } from './../shared/tiny-big/tiny-big';
 /**
  * Convert from Ether to Wei
  *
@@ -21,4 +23,4 @@
  * // 1000000000000000000000
  * ```
  */
-export declare function weiToEther(weiQuantity: string | number): import("./shared/tiny-big/tiny-big").TinyBig;
+export declare function weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig;

package/lib/cjs/{wei-to-ether.js → utils/wei-to-ether.js}

@@ -1,12 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.weiToEther = void 0;
-const big_js_1 = __importDefault(require("big.js"));
-const tiny_big_1 = require("./shared/tiny-big/tiny-big");
-const validate_type_1 = require("./shared/validate-type");
+const tiny_big_1 = require("../shared/tiny-big/tiny-big");
+const validate_type_1 = require("../shared/validate-type");
 /**
  * Convert from Ether to Wei
  *
@@ -31,8 +27,8 @@ const validate_type_1 = require("./shared/validate-type");
  * ```
  */
 function weiToEther(weiQuantity) {
-    (0, validate_type_1.validateType)(weiQuantity, ['string', 'number']);
-    const result = (0, big_js_1.default)(weiQuantity).div('1000000000000000000').toString();
+    (0, validate_type_1.validateType)(weiQuantity, ['string', 'number', 'object']);
+    const result = (0, tiny_big_1.tinyBig)(weiQuantity).div('1000000000000000000');
     return (0, tiny_big_1.tinyBig)(result);
 }
 exports.weiToEther = weiToEther;

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

@@ -0,0 +1,12 @@
+import { JsonRpcProvider } from '../providers/JsonRpcProvider';
+import { ContractInterface } from '../types/Contract.types';
+export declare class BaseContract {
+    readonly _address: string;
+    readonly _contractInterface: ContractInterface;
+    readonly _provider: JsonRpcProvider;
+    constructor(addressOrName: string, contractInterface: ContractInterface, signerOrProvider: JsonRpcProvider);
+}
+export declare function defineReadOnly<T>(object: T, name: string, value: any): void;
+export declare class Contract extends BaseContract {
+    readonly [key: string]: any;
+}

package/lib/esm/classes/Contract.js

@@ -0,0 +1,63 @@
+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());
+    });
+};
+import { decodeRPCResponse, encodeData, } from './utils/encode-decode-transaction';
+import { buildRPCPostBody, post } from './utils/fetchers';
+function estimateGas(txnData) {
+    txnData.split('').reduce((previousValue, currentValue) => {
+        const characterCost = currentValue === '0' ? 4 : 68;
+        return previousValue + characterCost;
+    }, 0);
+}
+export class BaseContract {
+    constructor(addressOrName, contractInterface, signerOrProvider) {
+        this._address = addressOrName;
+        this._contractInterface = contractInterface;
+        this._provider = signerOrProvider;
+        contractInterface
+            .filter((jsonABIArgument) => jsonABIArgument.type === 'function')
+            .forEach((jsonABIArgument) => {
+            if ('name' in jsonABIArgument &&
+                typeof jsonABIArgument.name === 'string') {
+                defineReadOnly(this, jsonABIArgument.name, (..._args) => __awaiter(this, void 0, void 0, function* () {
+                    let functionArguments = _args;
+                    let options = {};
+                    const lastArg = _args[_args.length - 1];
+                    if (!Array.isArray(lastArg) && typeof lastArg === 'object') {
+                        options = lastArg;
+                        functionArguments = _args.slice(0, _args.length - 1);
+                    }
+                    const data = encodeData(jsonABIArgument, functionArguments);
+                    const decimalGas = typeof options.gasLimit === 'number'
+                        ? options.gasLimit
+                        : typeof (jsonABIArgument === null || jsonABIArgument === void 0 ? void 0 : jsonABIArgument.gas) ===
+                            'number'
+                            ? estimateGas(data)
+                            : null;
+                    const nodeResponse = yield post(this._provider._rpcUrl, buildRPCPostBody('eth_call', [
+                        Object.assign({ to: this._address.toLowerCase(), data: data }, (decimalGas
+                            ? { gas: `0x${decimalGas.toString(16)}` }
+                            : {})),
+                        'latest',
+                    ]));
+                    return decodeRPCResponse(jsonABIArgument, nodeResponse);
+                }));
+            }
+        });
+    }
+}
+export function defineReadOnly(object, name, value) {
+    Object.defineProperty(object, name, {
+        enumerable: true,
+        value: value,
+        writable: false,
+    });
+}
+export class Contract extends BaseContract {
+}

package/lib/esm/classes/get-block.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/esm/{rpc → classes}/get-block.test.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import Big from 'big.js';
 import omit from 'just-omit';
 import Web3 from 'web3';
-import { EssentialEth } from '.';
+import { JsonRpcProvider } from '../providers/JsonRpcProvider';
 const rpcUrl = 'https://free-eth-node.com/api/eth';
 describe('matches web3', () => {
     function testBlockEquality(block1, block2) {
@@ -22,7 +22,7 @@ describe('matches web3', () => {
             .toNumber()).toBeLessThan(4000000);
     }
     it('should allow default eth node to get latest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new EssentialEth();
+        const essentialEth = new JsonRpcProvider();
         const web3 = new Web3(rpcUrl);
         const [eeLatestBlock, web3LatestBlock] = yield Promise.all([
             essentialEth.getBlock('latest'),
@@ -31,7 +31,7 @@ describe('matches web3', () => {
         testBlockEquality(eeLatestBlock, web3LatestBlock);
     }));
     it('should get latest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider(rpcUrl);
         const web3 = new Web3(rpcUrl);
         const [eeLatestBlock, web3LatestBlock] = yield Promise.all([
             essentialEth.getBlock('latest'),
@@ -40,7 +40,7 @@ describe('matches web3', () => {
         testBlockEquality(eeLatestBlock, web3LatestBlock);
     }));
     it('should get earliest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider(rpcUrl);
         const web3 = new Web3(rpcUrl);
         const [eeEarliestBlock, web3EarliestBlock] = yield Promise.all([
             essentialEth.getBlock('earliest'),
@@ -50,7 +50,7 @@ describe('matches web3', () => {
     }));
     const blockNumber = Math.floor(Math.random() * 13250630);
     it(`should get random block as decimal integer. (block #${blockNumber})`, () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider(rpcUrl);
         const web3 = new Web3(rpcUrl);
         const [eeRandomBlock, web3RandomBlock] = yield Promise.all([
             essentialEth.getBlock(blockNumber, true),

package/lib/esm/classes/test/Contract/crv-abi.d.ts

@@ -0,0 +1,2 @@
+import { JSONABI } from '../../../types/Contract.types';
+export declare const abi: JSONABI;