SDK upgrade with the ModularEtherspotWalletFactory contracts (on all chains) with latest IHook

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [6.1.0] - 2025-05-28
+### Breaking Changes
+- Changed contract address for Wallet Factory from `0x2A40091f044e48DEB5C0FCbc442E443F3341B451` to `0x38CC0EDdD3a944CA17981e0A19470d2298B8d43a`.
+- Changed contract address for Bootstrap from `0x0D5154d7751b6e2fDaa06F0cC9B400549394C8AA` to `0xCF2808eA7d131d96E5C73Eb0eCD8Dc84D33905C7`.
+- Changed contract address for Multiple Owner ECDSA Validator from `0x0740Ed7c11b9da33d9C80Bd76b826e4E90CC1906` to `0x0eA25BF9F313344d422B513e1af679484338518E`.
+- Added support for HookMultiPlexer at address `0xDcA918dd23456d321282DF9507F6C09A50522136`.
+- Results in a change of precomputed modular account address.
+
 ## [6.0.1] - 2025-05-28
 ### Fix
 - revert 6.0.0 to the older version of the sdk

examples/basics/custom-chain.ts

@@ -12,42 +12,39 @@ const bundlerApiKey = 'etherspot_public_key';
 const bundlerUrl = 'https://testnet-rpc.etherspot.io/v2/84532'; // bundler url
 const chainId = 84532; // chain id
 const entryPointAddress = '0x0000000071727De22E5E9d8BAf0edAc6f37da032'; // entry point address
-const walletFactoryAddress = '0x2A40091f044e48DEB5C0FCbc442E443F3341B451'; // wallet factory address
-const bootstrapAddress = '0x0D5154d7751b6e2fDaa06F0cC9B400549394C8AA'; // bootstrap address
-const multipleOwnerECDSAValidatorAddress = '0x0740Ed7c11b9da33d9C80Bd76b826e4E90CC1906'; // multi owner ECDSA validator factory address
+const walletFactoryAddress = '0x38CC0EDdD3a944CA17981e0A19470d2298B8d43a'; // wallet factory address
+const bootstrapAddress = '0xCF2808eA7d131d96E5C73Eb0eCD8Dc84D33905C7'; // bootstrap address
+const multipleOwnerECDSAValidatorAddress = '0x0eA25BF9F313344d422B513e1af679484338518E'; // multi owner ECDSA validator factory address
 
 // tsx examples/basics/custom-chain.ts
 async function main() {
   // for custom chains, you can use the following code to create a chain object
   const chain = defineChain({
     id: chainId,
-    name: "Base sepolia Testnet",
+    name: 'Base sepolia Testnet',
     nativeCurrency: {
       decimals: 18,
       name: 'ETH',
-      symbol: 'ETH'
+      symbol: 'ETH',
     },
     rpcUrls: {
       default: {
-        http: ['https://sepolia.base.org'] // RPC URL
-      }
-    }
-  })
+        http: ['https://sepolia.base.org'], // RPC URL
+      },
+    },
+  });
   // initializating sdk...
-  const modularSdk = new ModularSdk(
-    process.env.WALLET_PRIVATE_KEY as string,
-    {
-      chain: chain,
-      chainId: chainId,
-      bundlerProvider: new EtherspotBundler(chainId, bundlerApiKey, bundlerUrl),
-      index: 0,
-      entryPointAddress,
-      walletFactoryAddress,
-      bootstrapAddress,
-      multipleOwnerECDSAValidatorAddress,
-      rpcProviderUrl: bundlerUrl,
-    })
-
+  const modularSdk = new ModularSdk(process.env.WALLET_PRIVATE_KEY as string, {
+    chain: chain,
+    chainId: chainId,
+    bundlerProvider: new EtherspotBundler(chainId, bundlerApiKey, bundlerUrl),
+    index: 0,
+    entryPointAddress,
+    walletFactoryAddress,
+    bootstrapAddress,
+    multipleOwnerECDSAValidatorAddress,
+    rpcProviderUrl: bundlerUrl,
+  });
 
   // get address of EtherspotWallet...
   const address: string = await modularSdk.getCounterFactualAddress();
@@ -77,7 +74,7 @@ async function main() {
   console.log('Waiting for transaction...');
   let userOpsReceipt: string | null = null;
   const timeout = Date.now() + 1200000; // 1 minute timeout
-  while ((userOpsReceipt == null) && (Date.now() < timeout)) {
+  while (userOpsReceipt == null && Date.now() < timeout) {
     await sleep(2);
     userOpsReceipt = await modularSdk.getUserOpReceipt(uoHash);
   }
@@ -86,4 +83,4 @@ async function main() {
 
 main()
   .catch(console.error)
-  .finally(() => process.exit());
+  .finally(() => process.exit());

examples/basics/get-address.ts

@@ -6,7 +6,6 @@ dotenv.config();
 // tsx examples/basics/get-address.ts
 async function main() {
   const bundlerApiKey = 'etherspot_public_key';
-  const customBundlerUrl = '';
 
   // initializating sdk...
   const modularSdk = generateModularSDKInstance(

examples/basics/transfer-erc20.ts

@@ -13,7 +13,7 @@ dotenv.config();
 // add/change these values
 const recipient = '0x80a1874E1046B1cc5deFdf4D3153838B72fF94Ac'; // recipient wallet address
 const value = '0.1'; // transfer value
-const tokenAddress = process.env.TOKEN_ADDRESS as string; // token address
+const tokenAddress = '0xDeDf3B40f8c44b1fF195F37F35c6b8199C7ee443'; // token address
 const bundlerApiKey = 'etherspot_public_key';
 
 // tsx examples/basics/transfer-erc20.ts

examples/modules/install-hook.ts

@@ -0,0 +1,70 @@
+import { printOp } from '../../src/sdk/common/OperationUtils';
+import * as dotenv from 'dotenv';
+import { MODULE_TYPE, sleep } from '../../src/sdk/common';
+import { encodeAbiParameters, encodeFunctionData, Hex, parseAbi } from 'viem';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+import { getHookMultiPlexerInitData } from '../pulse/utils';
+import { accountAbi } from '../../src/sdk/common/abis';
+
+dotenv.config();
+
+const bundlerApiKey = 'etherspot_public_key';
+const CHAIN_ID = '1';
+const HOOK_MULTIPLEXER_ADDRESS = '0xDcA918dd23456d321282DF9507F6C09A50522136'; 
+
+// tsx examples/modules/install-hook.ts
+async function main() {
+  // Init SDK
+  const modularSdk = generateModularSDKInstance(
+    process.env.WALLET_PRIVATE_KEY as string,
+    Number(CHAIN_ID),
+    bundlerApiKey,
+  );
+
+  // Get counterfactual of ModularEtherspotWallet...
+  const address: Hex = (await modularSdk.getCounterFactualAddress()) as Hex;
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+  // Get native balance
+  const balance = await modularSdk.getNativeBalance();
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet native balance: ${balance}`);
+  // Clear existing UserOps from batch
+  await modularSdk.clearUserOpsFromBatch();
+
+  /*//////////////////////////////////////////////////////////////
+  INSTALL HOOK MULTIPLEXER WITH CREDIBLE ACCOUNT MODULE - AS HOOK
+  //////////////////////////////////////////////////////////////*/
+
+  //Get HookMultiPlexer init data with CredibleAccountHook as global subhook
+  let hmpInitData = getHookMultiPlexerInitData([]);
+  const hmpInstallCalldata = encodeFunctionData({
+    abi: parseAbi(accountAbi),
+    functionName: 'installModule',
+    args: [BigInt(MODULE_TYPE.HOOK), HOOK_MULTIPLEXER_ADDRESS, hmpInitData],
+  });
+  // // Add UserOp to batch
+  await modularSdk.addUserOpsToBatch({ to: address, data: hmpInstallCalldata });
+
+  /*//////////////////////////////////////////////////////////////
+                      ESTIMATE/SEND USER OP
+  //////////////////////////////////////////////////////////////*/
+
+  // Estimate UserOp
+  const op = await modularSdk.estimate();
+  console.log(`Estimate UserOp: ${await printOp(op)}`);
+  // Send UserOp
+  const uoHash = await modularSdk.send(op);
+  console.log(`UserOpHash: ${uoHash}`);
+  // Await transaction hash
+  console.log('Waiting for transaction...');
+  let userOpsReceipt = null;
+  const timeout = Date.now() + 1200000; // 1 minute timeout
+  while (userOpsReceipt == null && Date.now() < timeout) {
+    await sleep(2);
+    userOpsReceipt = await modularSdk.getUserOpReceipt(uoHash);
+  }
+  console.log('\x1b[33m%s\x1b[0m', `Transaction Receipt: `, userOpsReceipt);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/modules/is-module-initialised.ts

@@ -0,0 +1,31 @@
+import * as dotenv from 'dotenv';
+import { MODULE_TYPE } from '../../src/sdk/common';
+import { generateModularSDKInstance } from '../helpers/sdk-helper';
+
+dotenv.config();
+
+// tsx examples/modules/is-module-installed.ts
+async function main() {
+  const bundlerApiKey = 'etherspot_public_key';
+
+  console.log(`inside is-module-installed script:`);
+
+  // 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
+
+  // get address of EtherspotWallet
+  const address: string = await modularSdk.getCounterFactualAddress();
+
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  const isModuleInstalled = await modularSdk.isModuleInstalled(MODULE_TYPE.VALIDATOR, '0xFE14F6d4e407850b24D160B9ACfBb042D32BE492');
+  console.log(`isModuleInstalled: ${isModuleInstalled}`);
+}
+
+main()
+  .catch(console.error)
+  .finally(() => process.exit());

examples/modules/uninstall-module.ts

@@ -27,7 +27,7 @@ async function main() {
   //generate deinit data...
   const deInitData = await modularSdk.generateModuleDeInitData(
       MODULE_TYPE.VALIDATOR,
-     '0xF4CDE8B11500ca9Ea108c5838DD26Ff1a4257a0c', 
+     '0x9509aae8990bfA12BE09130BB822C37F3086863E', 
      deInitDataDefault);
 
   console.log(`deinitData: ${deInitData}`);
@@ -36,7 +36,7 @@ async function main() {
   // 0x22A55192a663591586241D42E603221eac49ed09
   // 0xF4CDE8B11500ca9Ea108c5838DD26Ff1a4257a0c
   const uoHash = await modularSdk.uninstallModule(MODULE_TYPE.VALIDATOR, 
-    '0xF4CDE8B11500ca9Ea108c5838DD26Ff1a4257a0c', deInitData);
+    '0x9509aae8990bfA12BE09130BB822C37F3086863E', deInitData);
   console.log(`UserOpHash: ${uoHash}`);
 
   // get transaction hash...

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherspot/modular-sdk",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Etherspot Modular SDK - build with ERC-7579 smart accounts modules",
   "keywords": [
     "ether",

src/sdk/base/BaseAccountAPI.ts

@@ -1,6 +1,6 @@
 import { TransactionDetailsForUserOp } from './TransactionDetailsForUserOp.js';
 import { PaymasterAPI } from './PaymasterAPI.js';
-import { ErrorSubject, Exception, getUserOpHash, NotPromise, packUserOp, UserOperation } from '../common/index.js';
+import { AddressZero, ErrorSubject, Exception, getUserOpHash, NotPromise, packUserOp, UserOperation } from '../common/index.js';
 import { calcPreVerificationGas, GasOverheads } from './calcPreVerificationGas.js';
 import { Factory, Network, NetworkNames, NetworkService, SdkOptions, SignMessageDto, validateDto } from '../index.js';
 import { Context } from '../context.js';
@@ -56,6 +56,7 @@ export abstract class BaseAccountAPI {
   factoryUsed: Factory;
   factoryAddress?: string;
   validatorAddress?: string;
+  hookMultiplexerAddress?: string;
   wallet: WalletProviderLike;
   publicClient: PublicClient;
 
@@ -96,6 +97,7 @@ export abstract class BaseAccountAPI {
     this.factoryAddress = params.factoryAddress;
     this.publicClient = params.publicClient;
     this.validatorAddress =  params.optionsLike?.multipleOwnerECDSAValidatorAddress ?? Networks[params.optionsLike.chainId]?.contracts?.multipleOwnerECDSAValidator ?? DEFAULT_MULTIPLE_OWNER_ECDSA_VALIDATOR_ADDRESS;
+    this.hookMultiplexerAddress = Networks[params.optionsLike.chainId]?.contracts?.hookMultiPlexer || AddressZero;  
   }
 
   get error$(): ErrorSubject {

src/sdk/base/EtherspotWalletAPI.ts

@@ -76,6 +76,18 @@ export class EtherspotWalletAPI extends BaseAccountAPI {
     return response as boolean;
   }
 
+  async isModuleInitialised(moduleTypeId: MODULE_TYPE, module: string, initData = '0x'): Promise<boolean> {
+    const accountAddress = await this.getAccountAddress();
+    if (!accountAddress) throw new Error('Account address not found');
+    const response = await this.publicClient.readContract({
+      address: accountAddress as Hex,
+      abi: parseAbi(accountAbi),
+      functionName: 'isModuleInstalled',
+      args: [moduleTypeId, module, initData]
+    });
+    return response as boolean;
+  }
+
   async installModule(moduleTypeId: MODULE_TYPE, module: string, initData = '0x'): Promise<string> {
     const accountAddress = await this.getAccountAddress();
     if (!accountAddress) throw new Error('Account address not found');