essential-eth 0.2.2 → 0.3.3

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

@@ -0,0 +1,69 @@
+import { JsonRpcProvider } from '../providers/JsonRpcProvider';
+import { ContractInterface } from '../types/Contract.types';
+export declare class BaseContract {
+    /**
+     * The URL to your Eth node. Consider POKT or Infura
+     */
+    readonly _address: string;
+    readonly _contractInterface: ContractInterface;
+    readonly _provider: JsonRpcProvider;
+    /**
+     * @param addressOrName - The ethereum address of the smart-contract
+     * @param contractInterface - The JSON ABI of the smart-contract (like http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw)
+     * @param signerOrProvider - An instantiated essential-eth provider
+     */
+    constructor(addressOrName: string, contractInterface: ContractInterface, signerOrProvider: JsonRpcProvider);
+}
+export declare function defineReadOnly<T>(object: T, name: string, value: any): void;
+/**
+ * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
+ *
+ * @example
+ * ```typescript
+ * import { Contract, JsonRpcProvider } from 'essential-eth';
+ * // UNI airdrop contract
+ * const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
+ * const provider = new JsonRpcProvider();
+ *
+ * const JSONABI = [
+ *   {
+ *     inputs: [
+ *       {
+ *         internalType: 'uint256',
+ *         name: 'index',
+ *         type: 'uint256',
+ *       },
+ *     ],
+ *     name: 'isClaimed',
+ *     outputs: [
+ *       {
+ *         internalType: 'bool',
+ *         name: '',
+ *         type: 'bool',
+ *       },
+ *     ],
+ *     stateMutability: 'view',
+ *     type: 'function',
+ *   },
+ * ]
+ *
+ * const contract = new Contract(
+ *   contractAddress,
+ *   JSONABI,
+ *   provider,
+ * );
+ *
+ * (async () => {
+ *   // prints boolean as to whether index 0 has claimed airdrop or not
+ *   console.log(await contract.isClaimed(0));
+ * })()
+ *
+ *
+ * ```
+ */
+export declare class Contract extends BaseContract {
+    /**
+     * The dynamic contract calls on any given contract. Like "isClaimed", "merkleRoot", etc.
+     */
+    readonly [key: string]: any;
+}

package/lib/cjs/classes/Contract.js

@@ -0,0 +1,122 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contract = exports.defineReadOnly = exports.BaseContract = void 0;
+const encode_decode_transaction_1 = require("./utils/encode-decode-transaction");
+const fetchers_1 = require("./utils/fetchers");
+function estimateGas(txnData) {
+    // https://ethereum.stackexchange.com/questions/1570/what-does-intrinsic-gas-too-low-mean/1694
+    txnData.split('').reduce((previousValue, currentValue) => {
+        const characterCost = currentValue === '0' ? 4 : 68;
+        return previousValue + characterCost;
+    }, 0);
+}
+class BaseContract {
+    /**
+     * @param addressOrName - The ethereum address of the smart-contract
+     * @param contractInterface - The JSON ABI of the smart-contract (like http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw)
+     * @param signerOrProvider - An instantiated essential-eth provider
+     */
+    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 = {};
+                    // remove options from encoding
+                    const lastArg = _args[_args.length - 1];
+                    if (!Array.isArray(lastArg) && typeof lastArg === 'object') {
+                        options = lastArg;
+                        functionArguments = _args.slice(0, _args.length - 1);
+                    }
+                    const data = (0, encode_decode_transaction_1.encodeData)(jsonABIArgument, functionArguments);
+                    const decimalGas = typeof options.gasLimit === 'number'
+                        ? options.gasLimit /* user passed in "gasLimit" directly */
+                        : typeof (jsonABIArgument === null || jsonABIArgument === void 0 ? void 0 : jsonABIArgument.gas) ===
+                            'number' /* ABI specified "gas". */
+                            ? estimateGas(data)
+                            : null;
+                    const nodeResponse = yield (0, fetchers_1.post)(this._provider._rpcUrl, (0, fetchers_1.buildRPCPostBody)('eth_call', [
+                        Object.assign({ to: this._address.toLowerCase(), data: data }, (decimalGas
+                            ? { gas: `0x${decimalGas.toString(16)}` }
+                            : {})),
+                        'latest',
+                    ]));
+                    return (0, encode_decode_transaction_1.decodeRPCResponse)(jsonABIArgument, nodeResponse);
+                }));
+            }
+        });
+    }
+}
+exports.BaseContract = BaseContract;
+function defineReadOnly(object, name, value) {
+    Object.defineProperty(object, name, {
+        enumerable: true,
+        value: value,
+        writable: false,
+    });
+}
+exports.defineReadOnly = defineReadOnly;
+/**
+ * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
+ *
+ * @example
+ * ```typescript
+ * import { Contract, JsonRpcProvider } from 'essential-eth';
+ * // UNI airdrop contract
+ * const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
+ * const provider = new JsonRpcProvider();
+ *
+ * const JSONABI = [
+ *   {
+ *     inputs: [
+ *       {
+ *         internalType: 'uint256',
+ *         name: 'index',
+ *         type: 'uint256',
+ *       },
+ *     ],
+ *     name: 'isClaimed',
+ *     outputs: [
+ *       {
+ *         internalType: 'bool',
+ *         name: '',
+ *         type: 'bool',
+ *       },
+ *     ],
+ *     stateMutability: 'view',
+ *     type: 'function',
+ *   },
+ * ]
+ *
+ * const contract = new Contract(
+ *   contractAddress,
+ *   JSONABI,
+ *   provider,
+ * );
+ *
+ * (async () => {
+ *   // prints boolean as to whether index 0 has claimed airdrop or not
+ *   console.log(await contract.isClaimed(0));
+ * })()
+ *
+ *
+ * ```
+ */
+class Contract extends BaseContract {
+}
+exports.Contract = Contract;

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

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const big_js_1 = __importDefault(require("big.js"));
 const just_omit_1 = __importDefault(require("just-omit"));
 const web3_1 = __importDefault(require("web3"));
-const _1 = require(".");
+const JsonRpcProvider_1 = require("../providers/JsonRpcProvider");
 // const rpcUrl = 'http://localhost:3001/post';
 const rpcUrl = 'https://free-eth-node.com/api/eth';
 describe('matches web3', () => {
@@ -30,7 +30,7 @@ describe('matches web3', () => {
             .toNumber()).toBeLessThan(4000000 /* 2616793 and 1187442 on recent tests */);
     }
     it('should allow default eth node to get latest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new _1.EssentialEth();
+        const essentialEth = new JsonRpcProvider_1.JsonRpcProvider();
         const web3 = new web3_1.default(rpcUrl);
         const [eeLatestBlock, web3LatestBlock] = yield Promise.all([
             essentialEth.getBlock('latest'),
@@ -39,7 +39,7 @@ describe('matches web3', () => {
         testBlockEquality(eeLatestBlock, web3LatestBlock);
     }));
     it('should get latest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new _1.EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider_1.JsonRpcProvider(rpcUrl);
         const web3 = new web3_1.default(rpcUrl);
         const [eeLatestBlock, web3LatestBlock] = yield Promise.all([
             essentialEth.getBlock('latest'),
@@ -48,7 +48,7 @@ describe('matches web3', () => {
         testBlockEquality(eeLatestBlock, web3LatestBlock);
     }));
     it('should get earliest block', () => __awaiter(void 0, void 0, void 0, function* () {
-        const essentialEth = new _1.EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider_1.JsonRpcProvider(rpcUrl);
         const web3 = new web3_1.default(rpcUrl);
         const [eeEarliestBlock, web3EarliestBlock] = yield Promise.all([
             essentialEth.getBlock('earliest'),
@@ -58,7 +58,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 _1.EssentialEth(rpcUrl);
+        const essentialEth = new JsonRpcProvider_1.JsonRpcProvider(rpcUrl);
         const web3 = new web3_1.default(rpcUrl);
         const [eeRandomBlock, web3RandomBlock] = yield Promise.all([
             essentialEth.getBlock(blockNumber, true),

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

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