Custom_Chain (#63)

Author: vignesha22

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [5.1.2] - 2025-05-07
+### Fix
+- Added ability to use custom chain
+
 ## [5.1.1] - 2025-03-19
 ### Fix
 - Removed multiple estimations when paymaster is set in the userOp

examples/basics/custom-chain.ts

@@ -0,0 +1,89 @@
+import { printOp } from '../../src/sdk/common/OperationUtils';
+import * as dotenv from 'dotenv';
+import { sleep } from '../../src/sdk/common';
+import { defineChain, parseEther } from 'viem';
+import { EtherspotBundler, ModularSdk } from '../../src';
+
+dotenv.config();
+
+const recipient = '0x80a1874E1046B1cc5deFdf4D3153838B72fF94Ac'; // recipient wallet address
+const value = '0.0000001'; // transfer value
+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
+
+// 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",
+    nativeCurrency: {
+      decimals: 18,
+      name: 'ETH',
+      symbol: 'ETH'
+    },
+    rpcUrls: {
+      default: {
+        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,
+    })
+
+
+  // get address of EtherspotWallet...
+  const address: string = await modularSdk.getCounterFactualAddress();
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet address: ${address}`);
+
+  // clear the transaction batch
+  await modularSdk.clearUserOpsFromBatch();
+
+  // add transactions to the batch
+  const transactionBatch = await modularSdk.addUserOpsToBatch({ to: recipient, value: parseEther(value) });
+  console.log('transactions: ', transactionBatch);
+
+  // get balance of the account address
+  const balance = await modularSdk.getNativeBalance();
+
+  console.log('balances: ', balance);
+
+  // estimate transactions added to the batch and get the fee data for the UserOp
+  const op = await modularSdk.estimate();
+  console.log(`Estimate UserOp: ${await printOp(op)}`);
+
+  // sign the UserOp and sending to the bundler...
+  const uoHash = await modularSdk.send(op);
+  console.log(`UserOpHash: ${uoHash}`);
+
+  // get transaction hash...
+  console.log('Waiting for transaction...');
+  let userOpsReceipt: string | null = 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());

package.json

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

src/sdk/base/BaseAccountAPI.ts

@@ -68,6 +68,7 @@ export abstract class BaseAccountAPI {
     const optionsLike = params.optionsLike;
 
     const {
+      chain,
       chainId, //
       rpcProviderUrl,
       factoryWallet,
@@ -78,7 +79,7 @@ export abstract class BaseAccountAPI {
       networkService: new NetworkService(chainId),
       walletService: new WalletService(
         params.wallet,
-        { provider: rpcProviderUrl},
+        { provider: rpcProviderUrl, chain},
         bundlerProvider.url,
         chainId
       ),
@@ -94,7 +95,7 @@ export abstract class BaseAccountAPI {
     this.accountAddress = params.accountAddress;
     this.factoryAddress = params.factoryAddress;
     this.publicClient = params.publicClient;
-    this.validatorAddress = Networks[params.optionsLike.chainId]?.contracts?.multipleOwnerECDSAValidator ?? DEFAULT_MULTIPLE_OWNER_ECDSA_VALIDATOR_ADDRESS;
+    this.validatorAddress =  params.optionsLike?.multipleOwnerECDSAValidatorAddress ?? Networks[params.optionsLike.chainId]?.contracts?.multipleOwnerECDSAValidator ?? DEFAULT_MULTIPLE_OWNER_ECDSA_VALIDATOR_ADDRESS;
   }
 
   get error$(): ErrorSubject {

src/sdk/base/EtherspotWalletAPI.ts

@@ -54,7 +54,7 @@ export class EtherspotWalletAPI extends BaseAccountAPI {
     this.index = params.index ?? 0;
     this.predefinedAccountAddress = params.predefinedAccountAddress ?? null;
     if (params?.optionsLike) {
-      this.bootstrapAddress = Networks[params.optionsLike.chainId]?.contracts?.bootstrap ?? DEFAULT_BOOTSTRAP_ADDRESS;
+      this.bootstrapAddress = params.optionsLike?.bootstrapAddress ?? Networks[params.optionsLike.chainId]?.contracts?.bootstrap ?? DEFAULT_BOOTSTRAP_ADDRESS;
     } else {
       this.bootstrapAddress = DEFAULT_BOOTSTRAP_ADDRESS;
     }

src/sdk/common/utils/viem-utils.ts

@@ -26,6 +26,14 @@ export const getPublicClient = ({ chainId, transport }: { chainId: number, trans
   return publicClient;
 }
 
+export const getPublicClientByChain = ({ chain, transport }: { chain: Chain, transport: Transport }) => {
+  const publicClient = createPublicClient({
+    chain: chain,
+    transport: transport
+  });
+  return publicClient;
+}
+
 export const getWalletClientFromPrivateKey = ({ rpcUrl, chainId, privateKey }: { rpcUrl: string, chainId: number, privateKey: string }): ReturnType<typeof createWalletClient> => {
   return createWalletClient({
     account: privateKeyToAccount(privateKey as Hex),

src/sdk/interfaces.ts

@@ -1,3 +1,4 @@
+import { Chain } from 'viem';
 import { BundlerProviderLike } from './bundler/index.js';
 
 export interface PaymasterApi {
@@ -11,11 +12,14 @@ export enum Factory {
 
 export interface SdkOptions {
   chainId: number;
+  chain?: Chain;
   bundlerProvider?: BundlerProviderLike;
   rpcProviderUrl?: string;
   factoryWallet?: Factory;
   walletFactoryAddress?: string;
   entryPointAddress?: string;
   accountAddress?: string;
   index?: number;
+  bootstrapAddress?: string;
+  multipleOwnerECDSAValidatorAddress?: string;
 }

src/sdk/sdk.ts

@@ -3,7 +3,8 @@ import { Network } from "./network/index.js";
 import {
   BatchUserOpsRequest, Exception, getGasFee,
   getViemAddress, MODULE_TYPE,
-  UserOperation, UserOpsRequest, getPublicClient
+  UserOperation, UserOpsRequest, getPublicClient,
+  getPublicClientByChain
 } from "./common/index.js";
 import {
   EthereumProvider,
@@ -52,6 +53,7 @@ export class ModularSdk {
       chainId,
       rpcProviderUrl,
       accountAddress,
+      chain,
     } = optionsLike;
 
     this.chainId = chainId;
@@ -72,12 +74,24 @@ export class ModularSdk {
 
     this.providerUrl = viemClientUrl;
 
-    this.publicClient = getPublicClient({
-      chainId: chainId,
-      transport: http(
-        viemClientUrl
-      )
-    }) as PublicClient;
+    if (Networks[chainId] == undefined) {
+      if (chain == undefined) {
+        throw new Exception('chain needs to be set when chainId is not in default Networks'); 
+      }
+      this.publicClient = getPublicClientByChain({
+        chain: chain,
+        transport: http(
+          viemClientUrl
+        )
+      }) as PublicClient;
+    } else {
+      this.publicClient = getPublicClient({
+        chainId: chainId,
+        transport: http(
+          viemClientUrl
+        )
+      }) as PublicClient;
+    }
 
     let entryPointAddress = '', walletFactoryAddress = '';
     if (Networks[chainId]) {

src/sdk/wallet/interfaces.ts

@@ -1,8 +1,11 @@
+import { Chain } from "viem";
+
 export interface Wallet {
   address: string;
   providerType: string;
 }
 
 export interface WalletOptions {
   provider?: string;
+  chain?: Chain;
 }

src/sdk/wallet/providers/key.wallet-provider.ts

@@ -1,4 +1,4 @@
-import { Hash, Hex, TransactionRequest, WalletClient, createWalletClient, http, concat, Address, encodeAbiParameters, parseAbiParameters, hashMessage, toBytes } from 'viem';
+import { Hash, Hex, TransactionRequest, WalletClient, createWalletClient, http, concat, Address, encodeAbiParameters, parseAbiParameters, hashMessage, toBytes, Chain } from 'viem';
 import { MessagePayload, WalletProvider } from './interfaces.js';
 import { privateKeyToAccount } from 'viem/accounts';
 import { Networks } from '../../network/index.js';
@@ -10,10 +10,10 @@ export class KeyWalletProvider implements WalletProvider {
 
   readonly wallet: WalletClient;
 
-  constructor(chainId: number, privateKey: string) {
+  constructor(chainId: number, privateKey: string, chain?: Chain) {
     this.wallet = createWalletClient({
       account: privateKeyToAccount(privateKey as Hex),
-      chain: Networks[chainId].chain,
+      chain: Networks[chainId]?.chain ?? chain,
       transport: http()
     });
 

src/sdk/wallet/wallet.service.ts

@@ -1,6 +1,7 @@
 import { map, Subscription } from 'rxjs';
 import {
   Address,
+  Chain,
   Hash,
   Hex,
   TransactionRequest,
@@ -14,6 +15,7 @@ export class WalletService extends Service {
   readonly wallet$ = new ObjectSubject<Wallet>();
   readonly rpcBundlerUrl: string;
   readonly chainId: number;
+  readonly chainObject: Chain | undefined;
 
   provider: WalletProvider;
 
@@ -26,6 +28,7 @@ export class WalletService extends Service {
     super();
     this.rpcBundlerUrl = rpcUrl;
     this.chainId = chain;
+    this.chainObject = options.chain;
   }
 
   get wallet(): Wallet {
@@ -77,15 +80,15 @@ export class WalletService extends Service {
           const walletLike = providerLike as WalletClient;
           const isNotViemClient = walletLike?.account.address === undefined;
           if (privateKey && isNotViemClient) {
-            provider = new KeyWalletProvider(this.chainId, privateKey);
+            provider = new KeyWalletProvider(this.chainId, privateKey, this.chainObject);
           } else {
             provider = new WalletClientProvider(walletLike);
           }
           break;
         }
 
         case 'string':
-          provider = new KeyWalletProvider(this.chainId, providerLike);
+          provider = new KeyWalletProvider(this.chainId, providerLike, this.chainObject);
           break;
       }
     }