Feature: PRO-2373 migrate ethers to viem

CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+
+## [1.2.0] - 2024-07-25
+### New
+- Migrated from `ethers` to `viem`
+- Added helper functions to use `viem`
+- Added support for XDC Mainnet.
+
 ## [1.1.2] - 2024-07-10
 ### New
 - Added `SessionKeyValidator` module for ERC20 SessionKeyValidator.

examples/05-add-guardians.ts → examples/basics/add-guardians.ts

@@ -1,21 +1,21 @@
-import { ethers } from 'ethers';
-import { EtherspotBundler, ModularSdk } from '../src';
-import { printOp } from '../src/sdk/common/OperationUtils';
+import { printOp } from '../../src/sdk/common/OperationUtils';
 import * as dotenv from 'dotenv';
-import { sleep } from '../src/sdk/common';
+import { sleep } from '../../src/sdk/common';
+import { encodeFunctionData, parseAbi } from 'viem';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
 
 dotenv.config();
 
+// tsx examples/basics/add-guardians.ts
 async function main() {
   const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
 
   // initializating sdk...
-  const modularSdk = new ModularSdk(
-    { privateKey: process.env.WALLET_PRIVATE_KEY },
-    { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) },
-  );
-
-  console.log('address: ', modularSdk.state.EOAAddress);
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
 
   // get address of EtherspotWallet
   const address: string = await modularSdk.getCounterFactualAddress();
@@ -29,12 +29,25 @@ async function main() {
 
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
 
-  const addGuardianInterface = new ethers.utils.Interface(['function addGuardian(address _newGuardian)']);
-
-  const addGuardianData1 = addGuardianInterface.encodeFunctionData('addGuardian', [guardianAddresses[0]]);
-  const addGuardianData2 = addGuardianInterface.encodeFunctionData('addGuardian', [guardianAddresses[1]]);
-  const addGuardianData3 = addGuardianInterface.encodeFunctionData('addGuardian', [guardianAddresses[2]]);
+  const addGuardianInterface = ['function addGuardian(address _newGuardian)'];
 
+  const addGuardianData1 =
+    encodeFunctionData({
+      functionName: 'addGuardian',
+      abi: parseAbi(addGuardianInterface),
+      args: [guardianAddresses[0]],
+    });
+  const addGuardianData2 =
+    encodeFunctionData({
+      functionName: 'addGuardian',
+      abi: parseAbi(addGuardianInterface),
+      args: [guardianAddresses[1]],
+    });
+  const addGuardianData3 = encodeFunctionData({
+    functionName: 'addGuardian',
+    abi: parseAbi(addGuardianInterface),
+    args: [guardianAddresses[2]],
+  });
   // clear the transaction batch
   await modularSdk.clearUserOpsFromBatch();
 

examples/07-callGasLimit.ts → examples/basics/callGasLimit.ts

@@ -1,8 +1,8 @@
-import { ethers } from 'ethers';
-import { EtherspotBundler, ModularSdk } from '../src';
-import { printOp } from '../src/sdk/common/OperationUtils';
+import { printOp } from '../../src/sdk/common/OperationUtils';
 import * as dotenv from 'dotenv';
-import { sleep } from '../src/sdk/common';
+import { sleep } from '../../src/sdk/common';
+import { parseEther } from 'viem';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
 
 dotenv.config();
 
@@ -12,12 +12,11 @@ const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxM
 
 async function main() {
   // initializating sdk...
-  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
-  })
-
-  console.log('address: ', modularSdk.state.EOAAddress)
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
 
   // get address of EtherspotWallet...
   const address: string = await modularSdk.getCounterFactualAddress();
@@ -27,7 +26,7 @@ async function main() {
   await modularSdk.clearUserOpsFromBatch();
 
   // add transactions to the batch
-  const transactionBatch = await modularSdk.addUserOpsToBatch({ to: recipient, value: ethers.utils.parseEther(value) });
+  const transactionBatch = await modularSdk.addUserOpsToBatch({ to: recipient, value: parseEther(value) });
   console.log('transactions: ', transactionBatch);
 
   // get balance of the account address

examples/09-concurrent-userops.ts → examples/basics/concurrent-userops.ts

@@ -1,8 +1,10 @@
-import { BigNumber, ethers, providers } from 'ethers';
-import { EtherspotBundler, ModularSdk } from '../src';
-import { printOp } from '../src/sdk/common/OperationUtils';
+import { printOp } from '../../src/sdk/common/OperationUtils';
 import * as dotenv from 'dotenv';
-import { sleep } from '../src/sdk/common';
+import { sleep } from '../../src/sdk/common';
+import { getPublicClient } from '../../src/sdk/common/utils/viem-utils';
+import { Hex, http, parseEther, PublicClient } from 'viem';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+import { BigNumber } from '../../src/sdk/types/bignumber';
 
 dotenv.config();
 
@@ -11,20 +13,28 @@ const value = '0.000001'; // transfer value
 const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
 
 async function main() {
-  const provider = new providers.JsonRpcProvider(process.env.RPC_PROVIDER_URL);
-  // initializating sdk...
-  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
+  // initializating sdk for index 0...
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
+
+  const publicClient = getPublicClient({
     chainId: Number(process.env.CHAIN_ID),
-    bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey)
-  })
-
-  console.log('address: ', modularSdk.state.EOAAddress)
+    transport: http(bundlerApiKey)
+  }) as PublicClient;
 
   // get address of EtherspotWallet...
   const address: string = await modularSdk.getCounterFactualAddress();
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
 
-  if ((await provider.getCode(address)).length <= 2) {
+  // get code
+  const code = await publicClient.getCode({
+    address: address as Hex
+  });
+
+  if (code.length <= 2) {
     console.log("Account must be created first");
     return;
   }
@@ -33,7 +43,7 @@ async function main() {
   await modularSdk.clearUserOpsFromBatch();
 
   // add transactions to the batch
-  const transactionBatch = await modularSdk.addUserOpsToBatch({to: recipient, value: ethers.utils.parseEther(value)});
+  const transactionBatch = await modularSdk.addUserOpsToBatch({to: recipient, value: parseEther(value)});
   console.log('transactions: ', transactionBatch);
 
   // get balance of the account address

examples/01-get-address.ts → examples/basics/get-address.ts

@@ -1,14 +1,19 @@
-import { EtherspotBundler, ModularSdk } from '../src';
 import * as dotenv from 'dotenv';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
 
 dotenv.config();
 
-// npx ts-node examples/01-get-address.ts
+// tsx examples/basics/get-address.ts
 async function main() {
   const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
   const customBundlerUrl = '';
+
   // initializating sdk...
-  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey, customBundlerUrl) }) // Testnets dont need apiKey on bundlerProvider
+    const modularSdk = generateModularSDKInstance(
+      process.env.WALLET_PRIVATE_KEY,
+      Number(process.env.CHAIN_ID),
+      bundlerApiKey
+    );// Testnets dont need apiKey on bundlerProvider
 
   // get EtherspotWallet address...
   const address: string = await modularSdk.getCounterFactualAddress();

examples/10-bundlerApiKey.ts → examples/basics/get-counterfactual-address.ts

@@ -1,16 +1,17 @@
-import { EtherspotBundler, ModularSdk } from '../src';
 import * as dotenv from 'dotenv';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
 
 dotenv.config();
 
-
+// tsx examples/basics/get-counterfactual-address.ts
 async function main() {
   const etherspotBundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
-  // initializating sdk...
-  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), etherspotBundlerApiKey)
-  })
+  // initializating sdk for index 0...
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    etherspotBundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
 
   // get EtherspotWallet address...
   const address: string = await modularSdk.getCounterFactualAddress();

examples/basics/get-gas-fees.ts

@@ -0,0 +1,25 @@
+import * as dotenv from 'dotenv';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+
+dotenv.config();
+
+// tsx examples/basics/get-gas-fees.ts
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+  const customBundlerUrl = '';
+
+  // initializating sdk...
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
+
+  // get EtherspotWallet address...
+  const gasFees: any = await modularSdk.getGasFee();
+  console.log(`gasFees is: ${gasFees}`);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/08-get-multiple-accounts.ts → examples/basics/get-multiple-accounts.ts

@@ -1,26 +1,31 @@
-import { EtherspotBundler, ModularSdk } from '../src';
 import * as dotenv from 'dotenv';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
 
 dotenv.config();
 
 const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
 
+// tsx examples/basics/get-multiple-accounts.ts
 async function main() {
   // initializating sdk for index 0...
-  const modularSdk = new ModularSdk(
-    { privateKey: process.env.WALLET_PRIVATE_KEY },
-    { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) },
-  );
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
+
 
   // get EtherspotWallet address for index 0...
   const address: string = await modularSdk.getCounterFactualAddress();
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address for index 0: ${address}`);
 
   // initializating sdk for index 1...
-  const modularSdk1 = new ModularSdk(
-    { privateKey: process.env.WALLET_PRIVATE_KEY },
-    { chainId: Number(process.env.CHAIN_ID), index: 1, bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) },
-  );
+  const modularSdk1 = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey,
+    1
+  );// Testnets dont need apiKey on bundlerProvider
 
   // get EtherspotWallet address for index 1...
   const address1: string = await modularSdk1.getCounterFactualAddress();

examples/basics/get-nonce.ts

@@ -0,0 +1,25 @@
+import * as dotenv from 'dotenv';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+
+dotenv.config();
+
+// tsx examples/basics/get-nonce.ts
+async function main() {
+  const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
+  const customBundlerUrl = '';
+
+  // initializating sdk...
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
+
+  // get EtherspotWallet nonce...
+  const nonce = await modularSdk.getNonce();
+  console.log(`nonce is: ${nonce}`);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/03-transfer-erc20.ts → examples/basics/transfer-erc20.ts

@@ -1,9 +1,12 @@
-import { ethers } from 'ethers';
-import { EtherspotBundler, ModularSdk } from '../src';
-import { printOp } from '../src/sdk/common/OperationUtils';
-import { ERC20_ABI } from '../src/sdk/helpers/abi/ERC20_ABI';
+import { EtherspotBundler, ModularSdk } from '../../src';
+import { printOp } from '../../src/sdk/common/OperationUtils';
+import { ERC20_ABI } from '../../src/sdk/helpers/abi/ERC20_ABI';
 import * as dotenv from 'dotenv';
-import { sleep } from '../src/sdk/common';
+import { sleep } from '../../src/sdk/common';
+import { getPublicClient, getViemAccount } from '../../src/sdk/common/utils/viem-utils';
+import { encodeFunctionData, Hex, http, parseAbi, parseUnits } from 'viem';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+import { erc20Abi } from '../../src/sdk/common/abis';
 
 dotenv.config();
 
@@ -13,26 +16,41 @@ const value = '0.1'; // transfer value
 const tokenAddress = '0x326C977E6efc84E512bB9C30f76E30c160eD06FB';
 const bundlerApiKey = 'eyJvcmciOiI2NTIzZjY5MzUwOTBmNzAwMDFiYjJkZWIiLCJpZCI6IjMxMDZiOGY2NTRhZTRhZTM4MGVjYjJiN2Q2NDMzMjM4IiwiaCI6Im11cm11cjEyOCJ9';
 
+// tsx examples/basics/transfer-erc20.ts
 async function main() {
   // initializating sdk...
-  const modularSdk = new ModularSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), bundlerProvider: new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey) })
-
-  console.log('address: ', modularSdk.state.EOAAddress)
+  const bundlerProvider = new EtherspotBundler(Number(process.env.CHAIN_ID), bundlerApiKey);
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY,
+    Number(process.env.CHAIN_ID),
+    bundlerApiKey
+  );// Testnets dont need apiKey on bundlerProvider
 
   // get address of EtherspotWallet...
   const address: string = await modularSdk.getCounterFactualAddress();
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
 
-  const provider = new ethers.providers.JsonRpcProvider(process.env.BUNDLER_URL)
-  // get erc20 Contract Interface
-  const erc20Instance = new ethers.Contract(tokenAddress, ERC20_ABI, provider);
+  const publicClient = getPublicClient({
+    chainId: Number(process.env.CHAIN_ID),
+    transport: http(bundlerProvider.url)
+  });
 
   // get decimals from erc20 contract
-  const decimals = await erc20Instance.functions.decimals();
-
+
+  const decimals = await publicClient.readContract({
+    address: tokenAddress as Hex,
+    abi: parseAbi(erc20Abi),
+    functionName: 'decimals',
+    args: []
+  })
+
   // get transferFrom encoded data
-  const transactionData = erc20Instance.interface.encodeFunctionData('transfer', [recipient, ethers.utils.parseUnits(value, decimals)])
-
+  const transactionData = encodeFunctionData({
+    functionName: 'transfer',
+    abi: parseAbi(ERC20_ABI),
+    args: [recipient, parseUnits(value, decimals as number)]
+  });
+
   // clear the transaction batch
   await modularSdk.clearUserOpsFromBatch();