✨ Add AlchemyProvider class (#205)

* feat: AlchemyProvider class

* chore: deleting yarn.lock

* chore: fixing package.json

* test: testing alchemy provider

* Simplify alchemy provider

* env cleanup

* Improve testing logging errros

* Remove excess dotenv

---------

Co-authored-by: dawsbot <[email protected]>

.env → .env.example

@@ -1,2 +1,2 @@
 RPC_ORIGIN=https://free-eth-node.com
-# RPC_ORIGIN=http://localhost:3000
+ALCHEMY_API_KEY=API_KEY_HERE

.github/workflows/test.yml

@@ -23,6 +23,7 @@ jobs:
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: npm ci

.gitignore

@@ -1,3 +1,4 @@
+.env
 node_modules
 lib
 dist

src/index.ts

@@ -1,4 +1,5 @@
 import { BaseContract, Contract } from './classes/Contract';
+import { AlchemyProvider } from './providers/AlchemyProvider';
 import {
   ConstructorOptions,
   FallthroughProvider,
@@ -47,6 +48,7 @@ export {
   jsonRpcProvider,
   JsonRpcProvider,
   FallthroughProvider,
+  AlchemyProvider,
   tinyBig,
   toChecksumAddress,
   weiToEther,

src/providers/AlchemyProvider.ts

@@ -0,0 +1,8 @@
+import { JsonRpcProvider } from './JsonRpcProvider';
+
+export class AlchemyProvider extends JsonRpcProvider {
+  constructor(apiKey: string, network = 'mainnet') {
+    const alchemyUrl = `https://eth-${network}.alchemyapi.io/v2/${apiKey}`;
+    super(alchemyUrl);
+  }
+}

src/providers/test/json-rpc-provider/get-block-number.test.ts

@@ -11,11 +11,9 @@ const mockPostResponse = JSON.stringify({
 describe('provider.getBlockNumber', () => {
   it('should get number integer', async () => {
     const essentialEthProvider = new JsonRpcProvider();
-    mockOf(unfetch).mockReturnValueOnce(
-      Promise.resolve({
-        text: () => mockPostResponse,
-      } as unknown as Response),
-    );
+    mockOf(unfetch).mockResolvedValueOnce({
+      text: () => Promise.resolve(mockPostResponse),
+    } as Response);
     const essentialEthBlockNumber = await essentialEthProvider.getBlockNumber();
     expect(essentialEthBlockNumber).toBe(10);
   });

src/providers/test/json-rpc-provider/get-gas-price.test.ts

@@ -17,11 +17,9 @@ const rpcUrl = rpcUrls.mainnet;
 describe('provider.getGasPrice', () => {
   it('should get TinyBig integer', async () => {
     const provider = new JsonRpcProvider(rpcUrl);
-    mockOf(unfetch).mockReturnValueOnce(
-      Promise.resolve({
-        text: () => mockPostResponse,
-      } as unknown as Response),
-    );
+    mockOf(unfetch).mockResolvedValueOnce({
+      text: () => Promise.resolve(mockPostResponse),
+    } as Response);
 
     const gasPrice = await provider.getGasPrice();
     expect(z.instanceof(TinyBig).safeParse(gasPrice).success).toBe(true);

src/providers/test/rpc-urls.ts

@@ -1,12 +1,18 @@
+import z from 'zod';
 export const fakeUrls = {
   notRPCButRealHttp: 'https://httpstat.us/200',
 } as const;
 
+const RPC_ORIGIN = process.env.RPC_ORIGIN;
+if (!z.string().url().safeParse(RPC_ORIGIN).success) {
+  throw new Error('RPC_ORIGIN is not defined or is invalid URL');
+}
+
 export const rpcUrls = {
-  mainnet: `${process.env.RPC_ORIGIN}/api/eth`,
-  matic: `${process.env.RPC_ORIGIN}/api/MATIC`,
-  gno: `${process.env.RPC_ORIGIN}/api/gno`,
-  bnb: `${process.env.RPC_ORIGIN}/api/bnb`,
-  arb1: `${process.env.RPC_ORIGIN}/api/arb1`,
-  gor: `${process.env.RPC_ORIGIN}/api/gor`,
+  mainnet: `${RPC_ORIGIN}/api/eth`,
+  matic: `${RPC_ORIGIN}/api/MATIC`,
+  gno: `${RPC_ORIGIN}/api/gno`,
+  bnb: `${RPC_ORIGIN}/api/bnb`,
+  arb1: `${RPC_ORIGIN}/api/arb1`,
+  gor: `${RPC_ORIGIN}/api/gor`,
 };

src/providers/test/test-alchemy-provider.test.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { AlchemyProvider, TinyBig } from '../../index';
+
+const ALCHEMY_API_KEY = process.env.ALCHEMY_API_KEY;
+
+if (!ALCHEMY_API_KEY) {
+  throw new Error(
+    'ALCHEMY_API_KEY is not defined in the environment variables.',
+  );
+}
+
+const provider = new AlchemyProvider(ALCHEMY_API_KEY);
+
+describe('alchemyProvider.getGasPrice', () => {
+  it('should return the current gas price', async () => {
+    const gasPrice = await provider.getGasPrice();
+    expect(z.instanceof(TinyBig).safeParse(gasPrice).success).toBe(true);
+  });
+});