1168: Add test setup

.gitignore

@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+coverage
 
 # Editor directories and files
 .vscode/*

jest.config.ts

@@ -0,0 +1,28 @@
+import type { Config } from 'jest';
+
+// https://jestjs.io/docs/configuration
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  testPathIgnorePatterns: ['<rootDir>/dist/'],
+  collectCoverageFrom: ['lib/**/*.{ts,js}'],
+  collectCoverage: true,
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 90,
+      lines: 90,
+      statements: 90,
+    },
+  },
+  // Coverage is not collected for these.
+  coveragePathIgnorePatterns: ['lib/errors', 'lib/main.ts'],
+  // Global APIs not available in the test environment by default.
+  globals: {
+    TextEncoder,
+    TextDecoder,
+    Uint8Array,
+  },
+};
+
+export default config;

lib/api/puffer-client.test.ts

@@ -0,0 +1,53 @@
+import { Chain } from '../chains/constants';
+import { AccountError } from '../errors/validation-errors';
+import {
+  setupMockPublicClient,
+  setupMockWalletClient,
+} from '../../test/mocks/setup-mock-clients';
+import { PufferClient } from './puffer-client';
+import { mockRpcRequest } from '../../test/mocks/mock-request';
+
+describe('PufferClient', () => {
+  it('should throw error if the environment is invalid', async () => {
+    expect(() => new PufferClient(Chain.Anvil)).toThrow(AccountError);
+  });
+
+  describe('PufferClient Valid Environment', () => {
+    it('should request addresses', async () => {
+      const mockAddress = '0xEB77D02f8122B32273444a1b544C147Fb559CB41';
+
+      const walletRequest = mockRpcRequest({
+        eth_requestAccounts: [mockAddress],
+      });
+      const walletClient = setupMockWalletClient(walletRequest);
+
+      const pufferClient = new PufferClient(Chain.Anvil, walletClient);
+      const [address] = await pufferClient.requestAddresses();
+
+      expect(address).toBe(mockAddress);
+      expect(walletRequest).toHaveBeenCalled();
+    });
+
+    it('should deposit ETH', async () => {
+      const mockAddress = '0xEB77D02f8122B32273444a1b544C147Fb559CB41';
+      const mockGas = BigInt(1);
+
+      const walletRequest = mockRpcRequest({
+        eth_sendTransaction: mockAddress,
+      });
+      const walletClient = setupMockWalletClient(walletRequest);
+      const publicRequest = mockRpcRequest({ eth_estimateGas: mockGas });
+      const publicClient = setupMockPublicClient(publicRequest);
+
+      const pufferClient = new PufferClient(
+        Chain.Anvil,
+        walletClient,
+        publicClient,
+      );
+      const { transact, estimate } = pufferClient.depositETH(mockAddress);
+
+      expect(await transact(BigInt(1))).toBe(mockAddress);
+      expect(await estimate()).toBe(mockGas);
+    });
+  });
+});

lib/api/puffer-client.ts

@@ -22,21 +22,31 @@ export class PufferClient {
   private walletClient: WalletClient;
   private publicClient: PublicClient;
 
-  constructor(chain: Chain) {
-    this.validateEnvironment();
+  constructor(
+    chain: Chain,
+    walletClient?: WalletClient,
+    publicClient?: PublicClient,
+  ) {
+    if (!walletClient) {
+      this.validateEnvironment();
+    }
 
     this.chainAddresses = CHAIN_ADDRESSES[chain];
     this.chainAbis = CHAIN_ABIS[chain];
     this.viemChain = VIEM_CHAINS[chain];
 
-    this.walletClient = createWalletClient({
-      chain: this.viemChain,
-      transport: custom(window.ethereum!),
-    });
-    this.publicClient = createPublicClient({
-      chain: this.viemChain,
-      transport: http(),
-    });
+    this.walletClient =
+      walletClient ??
+      createWalletClient({
+        chain: this.viemChain,
+        transport: custom(window.ethereum!),
+      });
+    this.publicClient =
+      publicClient ??
+      createPublicClient({
+        chain: this.viemChain,
+        transport: http(),
+      });
   }
 
   public async requestAddresses() {

lib/contracts/abis/abis.ts

@@ -1,11 +1,11 @@
 import { Chain } from '../../chains/constants';
-import { PufferVaultV2 as MainNetPufferVaultV2 } from './mainnet/PufferVaultV2';
+import { PufferVaultV2 as MainnetPufferVaultV2 } from './mainnet/PufferVaultV2';
 import { PufferVaultV2 as HoleskyPufferVaultV2 } from './holesky/PufferVaultV2';
 import { PufferVaultV2 as AnvilPufferVaultV2 } from './anvil/PufferVaultV2';
 
 export const CHAIN_ABIS = {
   [Chain.Mainnet]: {
-    PufferVaultV2: MainNetPufferVaultV2,
+    PufferVaultV2: MainnetPufferVaultV2,
   },
   [Chain.Holesky]: {
     PufferVaultV2: HoleskyPufferVaultV2,

lib/errors/base-error.ts

@@ -12,12 +12,16 @@ export abstract class BaseError<
   }
 
   protected compileMessage(message: string, params: T) {
+    const hasParams = params && Object.keys(params).length > 0;
+
     return [
       message,
-      ...(params ? [''] : []),
-      ...(params
+      // New Line
+      ...(hasParams ? [''] : []),
+      ...(hasParams
         ? Object.entries(params).map(([key, value]) => `${key}: ${value}`)
         : []),
+      // New Line
       '',
       `v${version}`,
     ].join('\n');

package.json

@@ -29,29 +29,26 @@
     "dev": "pnpm build --watch",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "test": "echo 'No tests'",
+    "test": "jest",
     "format": "prettier --write .",
     "release": "release-it"
   },
   "dependencies": {
-    "@chainsafe/bls": "^8.1.0",
-    "@chainsafe/ssz": "^0.16.0",
-    "ethers": "^6.12.1",
-    "viem": "^2.10.8",
-    "web3": "^4.8.0"
-  },
-  "peerDependencies": {
-    "react": ">= 16"
+    "viem": "^2.10.8"
   },
   "devDependencies": {
     "@eslint/js": "^9.2.0",
+    "@types/jest": "^29.5.12",
     "@types/node": "^20.12.11",
-    "@types/react": "^18.3.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "prettier": "^3.2.5",
     "release-it": "^17.2.1",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.8.0",
     "vite": "^5.2.11",