replaced addressTemplate implementation with accountTemplate, added test

etherspot · Oct 25, 2023 · f38974e · f38974e
1 parent 74474ba
commit f38974e
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 23 deletions.
diff --git a/__mocks__/@etherspot/prime-sdk.js b/__mocks__/@etherspot/prime-sdk.js
@@ -1,20 +1,26 @@
 import * as EtherspotPrime from '@etherspot/prime-sdk';
 import { ethers } from 'ethers';
 
-const defaultAccountAddress = '0x7F30B1960D5556929B03a0339814fE903c55a347';
-const otherAccountAddress = '0xAb4C67d8D7B248B2fA6B638C645466065fE8F1F1'
+export const defaultAccountAddress = '0x7F30B1960D5556929B03a0339814fE903c55a347';
+export const otherFactoryDefaultAccountAddress = '0xe383724e3bDC4753746dEC781809f8CD82010914';
+export const otherAccountAddress = '0xAb4C67d8D7B248B2fA6B638C645466065fE8F1F1'
 
 export class PrimeSdk {
   sdkChainId;
   userOps = [];
   nonce = ethers.BigNumber.from(1);
+  factoryWallet;
 
   constructor (provider, config) {
     this.sdkChainId = config.chainId;
+    this.factoryWallet = config.factoryWallet;
   }
 
   getCounterFactualAddress() {
-    return defaultAccountAddress;
+    if (this.factoryWallet === Factory.ETHERSPOT) {
+      return defaultAccountAddress;
+    }
+    return otherFactoryDefaultAccountAddress;
   }
 
   getAccountBalances({ chainId, account }) {
@@ -260,7 +266,8 @@ export class PrimeSdk {
     return userOpHash;
   }
 }
-
 export const isWalletProvider = EtherspotPrime.isWalletProvider;
 
+export const Factory = EtherspotPrime.Factory;
+
 export default EtherspotPrime;
diff --git a/__tests__/hooks/useWalletAddress.test.js b/__tests__/hooks/useWalletAddress.test.js
@@ -1,13 +1,17 @@
 import { renderHook, waitFor } from '@testing-library/react';
 import { ethers } from 'ethers';
+import { Factory } from '@etherspot/prime-sdk';
 
 // hooks
 import { EtherspotTransactionKit, useWalletAddress } from '../../src';
+import {
+  defaultAccountAddress,
+  otherFactoryDefaultAccountAddress,
+} from '../../__mocks__/@etherspot/prime-sdk';
 
 const ethersProvider = new ethers.providers.JsonRpcProvider('http://localhost:8545', 'goerli'); // replace with your node's RPC URL
 const provider = new ethers.Wallet.createRandom().connect(ethersProvider);
 
-const etherspotPrimeAddress = '0x7F30B1960D5556929B03a0339814fE903c55a347';
 const providerWalletAddress = provider.address;
 
 describe('useWalletAddress()', () => {
@@ -21,7 +25,7 @@ describe('useWalletAddress()', () => {
     const { result } = renderHook(() => useWalletAddress(), { wrapper });
 
     await waitFor(() => expect(result.current).not.toBe(undefined));
-    expect(result.current).toEqual(etherspotPrimeAddress);
+    expect(result.current).toEqual(defaultAccountAddress);
   });
 
   it('returns wallet address by type', async () => {
@@ -37,10 +41,10 @@ describe('useWalletAddress()', () => {
     });
 
     await waitFor(() => expect(result.current).not.toBe(undefined));
-    expect(result.current).toEqual(etherspotPrimeAddress);
+    expect(result.current).toEqual(defaultAccountAddress);
 
     rerender({ providerType: 'provider' });
-    await waitFor(() => expect(result.current).not.toBe(etherspotPrimeAddress));
+    await waitFor(() => expect(result.current).not.toBe(defaultAccountAddress));
     expect(result.current).toEqual(providerWalletAddress);
   });
 
@@ -57,9 +61,31 @@ describe('useWalletAddress()', () => {
     });
 
     await waitFor(() => expect(result.current).not.toBe(undefined));
-    expect(result.current).toEqual(etherspotPrimeAddress);
+    expect(result.current).toEqual(defaultAccountAddress);
 
     rerender({ providerType: 'whatever' });
     await waitFor(() => expect(result.current).toBe(undefined));
   });
+
+  it('returns different wallet address when account template provided', async () => {
+    const createWrapper = ({ accountTemplate } = {}) => ({ children }) => (
+      <EtherspotTransactionKit provider={provider} accountTemplate={accountTemplate}>
+        {children}
+      </EtherspotTransactionKit>
+    );
+
+    const { result: resultNoAccountTemplate } = renderHook(() => useWalletAddress(), {
+      wrapper: createWrapper(),
+    });
+
+    await waitFor(() => expect(resultNoAccountTemplate.current).not.toBe(undefined));
+    expect(resultNoAccountTemplate.current).toEqual(defaultAccountAddress);
+
+    const { result: resultWithAccountTemplate } = renderHook(() => useWalletAddress(), {
+      wrapper: createWrapper({ accountTemplate: Factory.SIMPLE_ACCOUNT }),
+    });
+
+    await waitFor(() => expect(resultWithAccountTemplate.current).not.toBe(undefined));
+    expect(resultWithAccountTemplate.current).toEqual(otherFactoryDefaultAccountAddress);
+  });
 })
diff --git a/src/components/EtherspotBatches.tsx b/src/components/EtherspotBatches.tsx
@@ -27,7 +27,6 @@ const EtherspotBatches = (props: EtherspotBatchesProps) => {
     onSent,
     id: batchesId,
     paymaster,
-    addressTemplate
   } = props;
 
   const context = useContext(EtherspotTransactionKitContext);
@@ -57,7 +56,6 @@ const EtherspotBatches = (props: EtherspotBatchesProps) => {
       onEstimated,
       onSent,
       paymaster,
-      addressTemplate,
     };
 
     context.setGroupedBatchesPerId((current) => ({ ...current, [componentId]: groupedBatch }));
@@ -68,7 +66,7 @@ const EtherspotBatches = (props: EtherspotBatchesProps) => {
         return current;
       });
     }
-  }, [componentId, batchesPerId, skip, batchesId, paymaster, addressTemplate]);
+  }, [componentId, batchesPerId, skip, batchesId, paymaster]);
 
   return (
     <EtherspotBatchesContext.Provider value={{ setBatchesPerId }}>

diff --git a/src/components/EtherspotTransactionKit.tsx b/src/components/EtherspotTransactionKit.tsx
@@ -1,18 +1,28 @@
 import React from 'react';
-import { WalletProviderLike } from '@etherspot/prime-sdk';
+import { WalletProviderLike, Factory } from '@etherspot/prime-sdk';
 import EtherspotContextProvider from '../providers/EtherspotContextProvider';
 
 // providers
 import EtherspotTransactionKitContextProvider from '../providers/EtherspotTransactionKitContextProvider';
 import ProviderWalletContextProvider from '../providers/ProviderWalletContextProvider';
 
 interface EtherspotTransactionKitProps extends React.PropsWithChildren {
-  provider?: WalletProviderLike | null | undefined;
-  chainId?: number | undefined;
+  provider: WalletProviderLike;
+  chainId?: number;
+  accountTemplate?: Factory;
 }
 
-const EtherspotTransactionKit = ({ children, provider, chainId = 1 }: EtherspotTransactionKitProps) => (
-  <EtherspotContextProvider provider={provider} chainId={chainId}>
+const EtherspotTransactionKit = ({
+  children,
+  provider,
+  chainId = 1,
+  accountTemplate = Factory.ETHERSPOT,
+}: EtherspotTransactionKitProps) => (
+  <EtherspotContextProvider
+    provider={provider}
+    chainId={chainId}
+    accountTemplate={accountTemplate}
+  >
     <EtherspotTransactionKitContextProvider>
       <ProviderWalletContextProvider>
         {children}

diff --git a/src/providers/EtherspotContextProvider.tsx b/src/providers/EtherspotContextProvider.tsx
@@ -1,7 +1,8 @@
 import {
   PrimeSdk,
   WalletProviderLike,
-  isWalletProvider
+  isWalletProvider,
+  Factory,
 } from '@etherspot/prime-sdk';
 import React, {
   ReactNode,
@@ -19,11 +20,13 @@ let sdkPerChain: { [chainId: number]: PrimeSdk } = {};
 const EtherspotContextProvider = ({
   children,
   provider,
-  chainId = 1,
+  chainId,
+  accountTemplate,
 }: {
   children: ReactNode;
   provider: WalletProviderLike;
-  chainId?: number;
+  chainId: number;
+  accountTemplate: Factory;
 }) => {
   const context = useContext(EtherspotContext);
 
@@ -46,6 +49,7 @@ const EtherspotContextProvider = ({
     const sdkForChain = new PrimeSdk(provider, {
       chainId: sdkChainId,
       projectKey: '__ETHERSPOT_PROJECT_KEY__' || undefined,
+      factoryWallet: accountTemplate,
     });
 
     sdkPerChain = {
@@ -57,7 +61,7 @@ const EtherspotContextProvider = ({
     await sdkForChain.getCounterFactualAddress();
 
     return sdkForChain;
-  }, [provider, chainId]);
+  }, [provider, chainId, accountTemplate]);
 
   const contextData = useMemo(() => ({
     getSdk,

diff --git a/src/types/EtherspotTransactionKit.ts b/src/types/EtherspotTransactionKit.ts
@@ -1,7 +1,7 @@
 import { Fragment, JsonFragment } from '@ethersproject/abi';
 import { BigNumber, BigNumberish, BytesLike } from 'ethers';
 import { Route } from '@lifi/types';
-import { PaymasterApi, ExchangeOffer, Factory } from '@etherspot/prime-sdk';
+import { PaymasterApi, ExchangeOffer } from '@etherspot/prime-sdk';
 
 export interface ITransaction {
   id?: string;
@@ -45,7 +45,6 @@ export interface IBatches {
   onSent?: (sent: SentBatch[]) => void;
   skip?: boolean;
   paymaster?: PaymasterApi,
-  addressTemplate?: Factory;
 }
 
 export type IEstimatedBatches = IBatches & {