essential-eth 0.2.2 → 0.3.3

package/readme.md

@@ -51,6 +51,8 @@ npm install --save essential-eth # TypeScript types load automatically
 yarn add essential-eth # TypeScript types load automatically
 ```
 
+<br/>
+
 ## Utils (do not require connecting to an Eth node)
 
 ```typescript
@@ -64,30 +66,43 @@ const { etherToWei } = require('essential-eth');
 
 ```typescript
 // convert ether to wei
-etherToWei(etherQuantity: string | number): TinyBig
+etherToWei(etherQuantity: string | number | TinyBig | Big): TinyBig
 ```
 
 #### `weiToEther`
 
 ```typescript
 // convert wei to ether
-weiToEther(weiQuantity: string | number): TinyBig
+weiToEther(weiQuantity: string | number | TinyBig | Big): TinyBig
 ```
 
 #### `toChecksumAddress`
 
 ```typescript
 // return proper mixed-case address
+// does not support ICAP addresses
 toChecksumAddress(address: string): string
 ```
 
+#### `isAddress`
+
+```typescript
+// returns boolean as to whether input is a valid address
+// does not support ENS nor ICAP
+isAddress(address: string): boolean
+```
+
+<br/>
+
 ## RPC
 
 ```typescript
-import { EssentialEth } from 'essential-eth';
-const essentialEth = new EssentialEth('RPC URL HERE' /* Try POKT or Infura */);
+import { JsonRpcProvider } from 'essential-eth';
+const essentialEth = new JsonRpcProvider(
+  'RPC URL HERE' /* Try POKT or Infura */,
+);
 // OR for very quick testing (limited to 500 requests)
-const essentialEth = new EssentialEth();
+const essentialEth = new JsonRpcProvider();
 ```
 
 #### `getBlock`
@@ -99,6 +114,54 @@ Returns a [Block](src/types/block.types.ts)
 getBlock(timeFrame: number | "latest" | "earliest" | "pending", returnTransactionObjects?: boolean): Promise<Block>
 ```
 
+<br/>
+
+## Contract
+
+⚠️ Only read functions are currently supported. ⚠️
+
+- This is highly experimental, do not use this in production yet.
+
+```typescript
+import { Contract, jsonRpcProvider, JSONABI } from 'essential-eth';
+// UNI airdrop contract
+const contractAddress = '0x090D4613473dEE047c3f2706764f49E0821D256e';
+const provider = jsonRpcProvider(/* RPC URL optional */);
+
+const abi: 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, abi, provider);
+
+(async () => {
+  // prints boolean as to whether index 0 has claimed airdrop or not
+  console.log(await contract.isClaimed(0));
+})();
+```
+
+#### `contractFunctionName(args)`
+
+Any function on a contract. Returns are the same as `ethers.js`, except that instead of BigNumber, `essential-eth` always returns a [`TinyBig`](https://essential-eth.vercel.app/classes/TinyBig.html)
+
 <br/>
 <br/>
 

package/lib/cjs/rpc/utils/fetchers.d.ts

@@ -1,7 +0,0 @@
-export declare function post(url: string, body: Record<string, unknown>): Promise<any>;
-export declare function buildRPCPostBody(method: 'eth_getBlockByNumber', params: any[]): {
-    jsonrpc: string;
-    id: number;
-    method: "eth_getBlockByNumber";
-    params: any[];
-};

package/lib/esm/ether-to-wei.d.ts

@@ -1,2 +0,0 @@
-import { TinyBig } from './shared/tiny-big/tiny-big';
-export declare function etherToWei(etherQuantity: string | number): TinyBig;

package/lib/esm/ether-to-wei.js

@@ -1,8 +0,0 @@
-import Big from 'big.js';
-import { tinyBig } from './shared/tiny-big/tiny-big';
-import { validateType } from './shared/validate-type';
-export function etherToWei(etherQuantity) {
-    validateType(etherQuantity, ['string', 'number']);
-    const result = Big(etherQuantity).times('1000000000000000000').toString();
-    return tinyBig(result);
-}

package/lib/esm/rpc/utils/fetchers.d.ts

@@ -1,7 +0,0 @@
-export declare function post(url: string, body: Record<string, unknown>): Promise<any>;
-export declare function buildRPCPostBody(method: 'eth_getBlockByNumber', params: any[]): {
-    jsonrpc: string;
-    id: number;
-    method: "eth_getBlockByNumber";
-    params: any[];
-};

package/lib/esm/wei-to-ether.d.ts

@@ -1 +0,0 @@
-export declare function weiToEther(weiQuantity: string | number): import("./shared/tiny-big/tiny-big").TinyBig;

package/lib/esm/wei-to-ether.js

@@ -1,8 +0,0 @@
-import Big from 'big.js';
-import { tinyBig } from './shared/tiny-big/tiny-big';
-import { validateType } from './shared/validate-type';
-export function weiToEther(weiQuantity) {
-    validateType(weiQuantity, ['string', 'number']);
-    const result = Big(weiQuantity).div('1000000000000000000').toString();
-    return tinyBig(result);
-}