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

package/src/classes/Contract.ts

@@ -1,161 +0,0 @@
-import { JsonRpcProvider } from '../providers/JsonRpcProvider';
-import { ContractInterface } from '../types/Contract.types';
-import {
-  decodeRPCResponse,
-  encodeData,
-} from './utils/encode-decode-transaction';
-import { buildRPCPostBody, post } from './utils/fetchers';
-function estimateGas(txnData: string) {
-  // 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);
-}
-interface Options {
-  gasLimit?: number;
-}
-export class BaseContract {
-  /**
-   * The URL to your Eth node. Consider POKT or Infura
-   */
-  private readonly _address: string;
-  private 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,
-  ) {
-    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,
-            async (..._args: any[]) => {
-              let functionArguments = _args;
-              let options: 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 = encodeData(jsonABIArgument, functionArguments);
-
-              const decimalGas =
-                typeof options.gasLimit === 'number'
-                  ? options.gasLimit /* user passed in "gasLimit" directly */
-                  : typeof jsonABIArgument?.gas ===
-                    'number' /* ABI specified "gas". */
-                  ? estimateGas(data)
-                  : null;
-              const req = async (): Promise<string> => {
-                return await post(
-                  this._provider._rpcUrl[this._provider._rpcUrlCounter],
-                  buildRPCPostBody('eth_call', [
-                    {
-                      to: this._address.toLowerCase(),
-                      data: data,
-                      // sometimes gas is defined in the ABI
-                      ...(decimalGas
-                        ? { gas: `0x${decimalGas.toString(16)}` }
-                        : {}),
-                    },
-                    'latest',
-                  ]),
-                ).catch((e) => {
-                  if (e.code === 'ENOTFOUND') {
-                    this._provider._rpcUrlCounter++;
-                    return req();
-                  }
-                });
-              };
-              const nodeResponse = await req();
-              return decodeRPCResponse(jsonABIArgument, nodeResponse);
-            },
-          );
-        }
-      });
-  }
-}
-
-/**
- * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
- */
-export function defineReadOnly<T>(object: T, name: string, value: any): void {
-  Object.defineProperty(object, name, {
-    enumerable: true,
-    value: value,
-    writable: false,
-  });
-}
-
-/**
- * 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 class Contract extends BaseContract {
-  // The dynamic function names within a given smart-contract
-  /**
-   * The dynamic contract calls on any given contract. Like "isClaimed", "merkleRoot", etc.
-   */
-  readonly [key: string]: any;
-  // readonly [key: string]: ContractFunction | any;
-}

package/src/classes/test/Contract/crv-abi.ts

@@ -1,488 +0,0 @@
-import { JSONABI } from '../../../types/Contract.types';
-
-export const abi: JSONABI =
-  // 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/src/classes/test/Contract/crv.test.ts

@@ -1,56 +0,0 @@
-import { Contract as EthersContract } from '@ethersproject/contracts';
-import { StaticJsonRpcProvider } from '@ethersproject/providers';
-import { TinyBig } from '../../..';
-import { JsonRpcProvider } from '../../../providers/JsonRpcProvider';
-import { Contract as EssentialEthContract } from '../../Contract';
-import { abi } from './crv-abi';
-
-// The JSONABI
-const JSONABI = abi;
-
-const rpcURL = `${process.env.RPC_ORIGIN}/api/eth`;
-const ethersProvider = new StaticJsonRpcProvider(rpcURL);
-const essentialEthProvider = new JsonRpcProvider(rpcURL);
-
-// https://etherscan.io/address/0x575CCD8e2D300e2377B43478339E364000318E2c
-const contractAddress = '0x575CCD8e2D300e2377B43478339E364000318E2c';
-
-const ethersContract = new EthersContract(
-  contractAddress,
-  JSONABI as any,
-  ethersProvider,
-);
-const essentialEthContract = new EssentialEthContract(
-  contractAddress,
-  JSONABI,
-  essentialEthProvider,
-);
-describe('cRV contract', () => {
-  const address = '0xf8cd644baf494d13406187cf8628754dca0a10c2';
-  it('should fetch "uint256" balanceOf', async () => {
-    const [ethersBalanceOf, essentialEthBalanceOf] = await Promise.all([
-      ethersContract.balanceOf(address, {
-        gasLimit: 40955,
-      }) as TinyBig,
-      essentialEthContract.balanceOf(address, {
-        gasLimit: 40955,
-      }) as TinyBig,
-    ]);
-    expect(ethersBalanceOf.toString()).toStrictEqual(
-      essentialEthBalanceOf.toString(),
-    );
-  });
-  it('should fetch "uint256" total_claimed', async () => {
-    const [ethersTotalClaimed, essentialEthTotalClaimed] = await Promise.all([
-      // ensure library also handles empty options
-      ethersContract.total_claimed(address, {}) as TinyBig,
-      essentialEthContract.total_claimed(address, {}) as TinyBig,
-    ]);
-    expect(ethersTotalClaimed.toString()).toStrictEqual(
-      essentialEthTotalClaimed.toString(),
-    );
-    expect(ethersTotalClaimed.toNumber()).toStrictEqual(
-      essentialEthTotalClaimed.toNumber(),
-    );
-  });
-});