essential-eth 0.4.6 → 0.4.9-beta.0

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

@@ -0,0 +1,526 @@
+import { JSONABI } from '../../../types/Contract.types';
+
+export const feiABI: JSONABI =
+  // http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw
+
+  [
+    {
+      inputs: [
+        { internalType: 'address', name: '_core', type: 'address' },
+        { internalType: 'address', name: '_bondingcurve', type: 'address' },
+        { internalType: 'address', name: '_ido', type: 'address' },
+        { internalType: 'address', name: '_oracle', type: 'address' },
+        { internalType: 'uint256', name: '_duration', type: 'uint256' },
+        {
+          internalType: 'uint256',
+          name: '_exchangeRateDiscount',
+          type: 'uint256',
+        },
+      ],
+      stateMutability: 'nonpayable',
+      type: 'constructor',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: 'owner',
+          type: 'address',
+        },
+        {
+          indexed: true,
+          internalType: 'address',
+          name: 'spender',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'value',
+          type: 'uint256',
+        },
+      ],
+      name: 'Approval',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: '_from',
+          type: 'address',
+        },
+        {
+          indexed: true,
+          internalType: 'address',
+          name: '_to',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_amount',
+          type: 'uint256',
+        },
+      ],
+      name: 'Commit',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: '_core',
+          type: 'address',
+        },
+      ],
+      name: 'CoreUpdate',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_duration',
+          type: 'uint256',
+        },
+      ],
+      name: 'DurationUpdate',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_timestamp',
+          type: 'uint256',
+        },
+      ],
+      name: 'Launch',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'address',
+          name: 'account',
+          type: 'address',
+        },
+      ],
+      name: 'Paused',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: '_to',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_value',
+          type: 'uint256',
+        },
+      ],
+      name: 'Purchase',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: '_to',
+          type: 'address',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_amountIn',
+          type: 'uint256',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_amountFei',
+          type: 'uint256',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_amountTribe',
+          type: 'uint256',
+        },
+      ],
+      name: 'Redeem',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: '_startTime',
+          type: 'uint256',
+        },
+      ],
+      name: 'TimerReset',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'address',
+          name: 'from',
+          type: 'address',
+        },
+        { indexed: true, internalType: 'address', name: 'to', type: 'address' },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'value',
+          type: 'uint256',
+        },
+      ],
+      name: 'Transfer',
+      type: 'event',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: false,
+          internalType: 'address',
+          name: 'account',
+          type: 'address',
+        },
+      ],
+      name: 'Unpaused',
+      type: 'event',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'owner', type: 'address' },
+        { internalType: 'address', name: 'spender', type: 'address' },
+      ],
+      name: 'allowance',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'spender', type: 'address' },
+        { internalType: 'uint256', name: 'amount', type: 'uint256' },
+      ],
+      name: 'approve',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+      name: 'balanceOf',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'from', type: 'address' },
+        { internalType: 'address', name: 'to', type: 'address' },
+        { internalType: 'uint256', name: 'amount', type: 'uint256' },
+      ],
+      name: 'commit',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: '', type: 'address' }],
+      name: 'committedFGEN',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'core',
+      outputs: [{ internalType: 'contract ICore', name: '', type: 'address' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'decimals',
+      outputs: [{ internalType: 'uint8', name: '', type: 'uint8' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'spender', type: 'address' },
+        { internalType: 'uint256', name: 'subtractedValue', type: 'uint256' },
+      ],
+      name: 'decreaseAllowance',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'duration',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'from', type: 'address' },
+        { internalType: 'address payable', name: 'to', type: 'address' },
+      ],
+      name: 'emergencyExit',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'fei',
+      outputs: [{ internalType: 'contract IFei', name: '', type: 'address' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'feiBalance',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'uint256', name: 'amountIn', type: 'uint256' },
+        { internalType: 'bool', name: 'inclusive', type: 'bool' },
+      ],
+      name: 'getAmountOut',
+      outputs: [
+        { internalType: 'uint256', name: 'feiAmount', type: 'uint256' },
+        { internalType: 'uint256', name: 'tribeAmount', type: 'uint256' },
+      ],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'to', type: 'address' }],
+      name: 'getAmountsToRedeem',
+      outputs: [
+        { internalType: 'uint256', name: 'feiAmount', type: 'uint256' },
+        { internalType: 'uint256', name: 'genesisTribe', type: 'uint256' },
+        { internalType: 'uint256', name: 'idoTribe', type: 'uint256' },
+      ],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'spender', type: 'address' },
+        { internalType: 'uint256', name: 'addedValue', type: 'uint256' },
+      ],
+      name: 'increaseAllowance',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'initGenesis',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'isTimeEnded',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'isTimeStarted',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'launch',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'launchBlock',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'name',
+      outputs: [{ internalType: 'string', name: '', type: 'string' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'pause',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'paused',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'to', type: 'address' },
+        { internalType: 'uint256', name: 'value', type: 'uint256' },
+      ],
+      name: 'purchase',
+      outputs: [],
+      stateMutability: 'payable',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'to', type: 'address' }],
+      name: 'redeem',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'remainingTime',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [{ internalType: 'address', name: 'core', type: 'address' }],
+      name: 'setCore',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'startTime',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'symbol',
+      outputs: [{ internalType: 'string', name: '', type: 'string' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'timeSinceStart',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'totalCommittedFGEN',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'totalCommittedTribe',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'totalSupply',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'recipient', type: 'address' },
+        { internalType: 'uint256', name: 'amount', type: 'uint256' },
+      ],
+      name: 'transfer',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [
+        { internalType: 'address', name: 'sender', type: 'address' },
+        { internalType: 'address', name: 'recipient', type: 'address' },
+        { internalType: 'uint256', name: 'amount', type: 'uint256' },
+      ],
+      name: 'transferFrom',
+      outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'tribe',
+      outputs: [{ internalType: 'contract IERC20', name: '', type: 'address' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'tribeBalance',
+      outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [],
+      name: 'unpause',
+      outputs: [],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+  ];

package/src/classes/test/Contract/fei.test.ts

@@ -0,0 +1,86 @@
+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 { feiABI } from './fei-abi';
+
+// The JSONABI
+const JSONABI = feiABI;
+
+const rpcURL = `${process.env.RPC_ORIGIN}/api/eth`;
+const ethersProvider = new StaticJsonRpcProvider(rpcURL);
+const essentialEthProvider = new JsonRpcProvider(rpcURL);
+
+// https://etherscan.io/address/0xBFfB152b9392e38CdDc275D818a3Db7FE364596b
+const contractAddress = '0xBFfB152b9392e38CdDc275D818a3Db7FE364596b';
+
+const smartContractGetFeiAmountsToRedeem = async (
+  contract: any,
+  address: string,
+) => {
+  const merkleRoot = (await contract.getAmountsToRedeem(address)) as TinyBig[];
+  return merkleRoot;
+};
+
+const ethersContract = new EthersContract(
+  contractAddress,
+  JSONABI as any,
+  ethersProvider,
+);
+const essentialEthContract = new EssentialEthContract(
+  contractAddress,
+  JSONABI,
+  essentialEthProvider,
+);
+describe('fEI contract', () => {
+  it('should fetch unclaimed amounts "[uint256, uint256, uint256]" data-type', async () => {
+    const [ethersResponse, essentialEthResponse] = await Promise.all([
+      smartContractGetFeiAmountsToRedeem(
+        ethersContract,
+        '0xf5dBA31743ea341057280bb3AdD5c2Fb505BDC4C',
+      ),
+      smartContractGetFeiAmountsToRedeem(
+        essentialEthContract,
+        '0xf5dBA31743ea341057280bb3AdD5c2Fb505BDC4C',
+      ),
+    ]);
+    expect(ethersResponse[0].toString()).toStrictEqual(
+      essentialEthResponse[0].toString(),
+    );
+    expect(ethersResponse[1].toString()).toStrictEqual(
+      essentialEthResponse[1].toString(),
+    );
+    expect(ethersResponse[2].toString()).toStrictEqual(
+      essentialEthResponse[2].toString(),
+    );
+
+    expect(essentialEthResponse[2].toNumber()).toBe(0);
+  });
+  it('should fetch "uint8" data-type', async () => {
+    const [ethersResponse, essentialEthResponse] = await Promise.all([
+      ethersContract.decimals(),
+      essentialEthContract.decimals(),
+    ]);
+    expect(ethersResponse).toStrictEqual(essentialEthResponse);
+  });
+
+  it('should throw errors for methods using unsupported data-types', async () => {
+    await expect(essentialEthContract.name()).rejects.toThrow(
+      'essential-eth does not yet support "string" outputs. Make a PR today!',
+    );
+  });
+  // it.only('should fetch "string" name data-type', async () => {
+  //   const [ethersResponse, essentialEthResponse] = await Promise.all([
+  //     ethersContract.symbol(),
+  //     essentialEthContract.symbol(),
+  //   ]);
+  //   expect(ethersResponse).toStrictEqual(essentialEthResponse);
+
+  //   const [ethers2Response, essential2EthResponse] = await Promise.all([
+  //     ethersContract.name(),
+  //     essentialEthContract.name(),
+  //   ]);
+  //   expect(ethers2Response).toStrictEqual(essential2EthResponse);
+  // });
+});

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

@@ -0,0 +1,42 @@
+// https://docs.soliditylang.org/en/v0.6.8/abi-spec.html#examples
+// contract Foo {
+// 	function bar(bytes3[2] memory) public pure {}
+// 	function baz(uint32 x, bool y) public pure returns (bool r) { r = x > 32 || y; }
+// 	function sam(bytes memory, bool, uint[] memory) public pure {}
+
+import { JSONABI } from '../../..';
+
+//     }
+export const fooABI: JSONABI = [
+  {
+    inputs: [
+      {
+        internalType: 'bytes3[2]',
+        name: 'memory',
+        type: 'bytes3[2]',
+      },
+    ],
+    name: 'bar',
+    outputs: [],
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'uint32', name: 'x', type: 'uint32' },
+      { internalType: 'bool', name: 'y', type: 'bool' },
+    ],
+    name: 'baz',
+    outputs: [{ internalType: 'bool', name: 'r', type: 'bool' }],
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'bytes', name: 'memory', type: 'bytes' },
+      { internalType: 'bool', name: '', type: 'bool' },
+      { internalType: 'uint[]', name: 'memory', type: 'uint[]' },
+    ],
+    name: 'sam',
+    outputs: [],
+    type: 'function',
+  },
+];

package/src/classes/test/Contract/foo.test.ts

@@ -0,0 +1,33 @@
+import { encodeData } from '../../utils/encode-decode-transaction';
+import { JSONABIArgument } from './../../../types/Contract.types';
+import { fooABI } from './foo-abi';
+
+describe('foo encode', () => {
+  it('encodes "baz" function', () => {
+    const jsonABIArgument = fooABI.find(
+      (abi) => abi.name === 'baz',
+    ) as JSONABIArgument;
+    const encoded = encodeData(jsonABIArgument, [69, true]);
+    expect(encoded).toBe(
+      '0xcdcd77c000000000000000000000000000000000000000000000000000000000000000450000000000000000000000000000000000000000000000000000000000000001',
+    );
+  });
+  it('encodes "bar" function', () => {
+    const jsonABIArgument = fooABI.find(
+      (abi) => abi.name === 'bar',
+    ) as JSONABIArgument;
+    const encoded = encodeData(jsonABIArgument, ['abc', 'def']);
+    expect(encoded).toBe(
+      '0xfce353f661626300000000000000000000000000000000000000000000000000000000006465660000000000000000000000000000000000000000000000000000000000',
+    );
+  });
+  //   it('encodes "sam" function', () => {
+  //     const jsonABIArgument = fooABI.find(
+  //       (abi) => abi.name === 'sam',
+  //     ) as JSONABIArgument;
+  //     const encoded = encodeData(jsonABIArgument, ['dave', true, [1, 2, 3]]);
+  //     expect(encoded).toBe(
+  //       '0xa5643bf20000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000000464617665000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000003',
+  //     );
+  //   });
+});