essential-eth 0.4.9-beta.1 → 0.4.9-beta.4

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

@@ -0,0 +1,71 @@
+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
+     */
+    private readonly _address;
+    private readonly _provider;
+    /**
+     * @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);
+}
+/**
+ * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
+ */
+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,133 @@
+"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) => {
+        // 0 characters are 4 gwei, all others are 48 gwei
+        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._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 req = () => __awaiter(this, void 0, void 0, function* () {
+                        return yield (0, fetchers_1.post)(this._provider._rpcUrl[this._provider._rpcUrlCounter], (0, fetchers_1.buildRPCPostBody)('eth_call', [
+                            Object.assign({ to: this._address.toLowerCase(), data: data }, (decimalGas
+                                ? { gas: `0x${decimalGas.toString(16)}` }
+                                : {})),
+                            'latest',
+                        ])).catch((e) => {
+                            if (e.code === 'ENOTFOUND') {
+                                this._provider._rpcUrlCounter++;
+                                return req();
+                            }
+                        });
+                    });
+                    const nodeResponse = yield req();
+                    return (0, encode_decode_transaction_1.decodeRPCResponse)(jsonABIArgument, nodeResponse);
+                }));
+            }
+        });
+    }
+}
+exports.BaseContract = BaseContract;
+/**
+ * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
+ */
+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/classes/test/Contract/crv-abi.d.ts

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

package/lib/cjs/classes/test/Contract/crv-abi.js

@@ -0,0 +1,488 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.abi = void 0;
+exports.abi = 
+// 20210406000308
+// http://api.etherscan.io/api?module=contract&action=getabi&address=0x575CCD8e2D300e2377B43478339E364000318E2c&format=raw
+[
+    {
+        name: 'Fund',
+        inputs: [
+            {
+                type: 'address',
+                name: 'recipient',
+                indexed: true,
+            },
+            {
+                type: 'uint256',
+                name: 'amount',
+                indexed: false,
+            },
+        ],
+        anonymous: false,
+        type: 'event',
+    },
+    {
+        name: 'Claim',
+        inputs: [
+            {
+                type: 'address',
+                name: 'recipient',
+                indexed: true,
+            },
+            {
+                type: 'uint256',
+                name: 'claimed',
+                indexed: false,
+            },
+        ],
+        anonymous: false,
+        type: 'event',
+    },
+    {
+        name: 'ToggleDisable',
+        inputs: [
+            {
+                type: 'address',
+                name: 'recipient',
+                indexed: false,
+            },
+            {
+                type: 'bool',
+                name: 'disabled',
+                indexed: false,
+            },
+        ],
+        anonymous: false,
+        type: 'event',
+    },
+    {
+        name: 'CommitOwnership',
+        inputs: [
+            {
+                type: 'address',
+                name: 'admin',
+                indexed: false,
+            },
+        ],
+        anonymous: false,
+        type: 'event',
+    },
+    {
+        name: 'ApplyOwnership',
+        inputs: [
+            {
+                type: 'address',
+                name: 'admin',
+                indexed: false,
+            },
+        ],
+        anonymous: false,
+        type: 'event',
+    },
+    {
+        outputs: [],
+        inputs: [
+            {
+                type: 'address',
+                name: '_token',
+            },
+            {
+                type: 'uint256',
+                name: '_start_time',
+            },
+            {
+                type: 'uint256',
+                name: '_end_time',
+            },
+            {
+                type: 'bool',
+                name: '_can_disable',
+            },
+            {
+                type: 'address[4]',
+                name: '_fund_admins',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'constructor',
+    },
+    {
+        name: 'add_tokens',
+        outputs: [],
+        inputs: [
+            {
+                type: 'uint256',
+                name: '_amount',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 39108,
+    },
+    {
+        name: 'fund',
+        outputs: [],
+        inputs: [
+            {
+                type: 'address[100]',
+                name: '_recipients',
+            },
+            {
+                type: 'uint256[100]',
+                name: '_amounts',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 3962646,
+    },
+    {
+        name: 'toggle_disable',
+        outputs: [],
+        inputs: [
+            {
+                type: 'address',
+                name: '_recipient',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 40280,
+    },
+    {
+        name: 'disable_can_disable',
+        outputs: [],
+        inputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 21295,
+    },
+    {
+        name: 'disable_fund_admins',
+        outputs: [],
+        inputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 21325,
+    },
+    {
+        name: 'vestedSupply',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 4468,
+    },
+    {
+        name: 'lockedSupply',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 5465,
+    },
+    {
+        name: 'vestedOf',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: '_recipient',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 5163,
+    },
+    {
+        name: 'balanceOf',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: '_recipient',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 6275,
+    },
+    {
+        name: 'lockedOf',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: '_recipient',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 6305,
+    },
+    {
+        name: 'claim',
+        outputs: [],
+        inputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+    // {
+    //   name: 'claim',
+    //   outputs: [],
+    //   inputs: [
+    //     {
+    //       type: 'address',
+    //       name: 'addr',
+    //     },
+    //   ],
+    //   stateMutability: 'nonpayable',
+    //   type: 'function',
+    // },
+    {
+        name: 'commit_transfer_ownership',
+        outputs: [
+            {
+                type: 'bool',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: 'addr',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 38032,
+    },
+    {
+        name: 'apply_transfer_ownership',
+        outputs: [
+            {
+                type: 'bool',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+        gas: 38932,
+    },
+    {
+        name: 'token',
+        outputs: [
+            {
+                type: 'address',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1601,
+    },
+    {
+        name: 'start_time',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1631,
+    },
+    {
+        name: 'end_time',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1661,
+    },
+    {
+        name: 'initial_locked',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: 'arg0',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1845,
+    },
+    {
+        name: 'total_claimed',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: 'arg0',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1875,
+    },
+    {
+        name: 'initial_locked_supply',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1751,
+    },
+    {
+        name: 'unallocated_supply',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1781,
+    },
+    {
+        name: 'can_disable',
+        outputs: [
+            {
+                type: 'bool',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1811,
+    },
+    {
+        name: 'disabled_at',
+        outputs: [
+            {
+                type: 'uint256',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: 'arg0',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1995,
+    },
+    {
+        name: 'admin',
+        outputs: [
+            {
+                type: 'address',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1871,
+    },
+    {
+        name: 'future_admin',
+        outputs: [
+            {
+                type: 'address',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1901,
+    },
+    {
+        name: 'fund_admins_enabled',
+        outputs: [
+            {
+                type: 'bool',
+                name: '',
+            },
+        ],
+        inputs: [],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 1931,
+    },
+    {
+        name: 'fund_admins',
+        outputs: [
+            {
+                type: 'bool',
+                name: '',
+            },
+        ],
+        inputs: [
+            {
+                type: 'address',
+                name: 'arg0',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        gas: 2115,
+    },
+];

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

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