feat: add support for overriding the initCode for an account

.eslintignore

@@ -1,2 +1,3 @@
 **/dist/*
 examples/alchemy-daapp/*
+site/.vitepress/cache/**/*

packages/core/src/account/__tests__/simple.test.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import { polygonMumbai, type Chain } from "viem/chains";
+import { polygonMumbai, sepolia, type Chain } from "viem/chains";
 import { describe, it } from "vitest";
 import { getDefaultSimpleAccountFactoryAddress } from "../../index.js";
 import { SmartAccountProvider } from "../../provider/base.js";
@@ -102,29 +102,49 @@ describe("Account Simple Tests", () => {
       ]"
     `);
   });
-});
 
-const givenConnectedProvider = ({
-  owner,
-  chain,
-}: {
-  owner: SmartAccountSigner;
-  chain: Chain;
-}) =>
-  new SmartAccountProvider({
-    rpcProvider: `${chain.rpcUrls.alchemy.http[0]}/${"test"}`,
-    chain,
-  }).connect((provider) => {
+  it("should correctly use the account init code override", async () => {
     const account = new SimpleSmartContractAccount({
-      chain,
-      owner,
-      factoryAddress: getDefaultSimpleAccountFactoryAddress(chain),
-      rpcClient: provider,
+      chain: sepolia,
+      owner: owner,
+      factoryAddress: getDefaultSimpleAccountFactoryAddress(sepolia),
+      rpcClient: `${sepolia.rpcUrls.alchemy.http[0]}/${"test"}`,
+      // override the account address here so we don't have to resolve the address from the entrypoint
+      accountAddress: "0x1234567890123456789012345678901234567890",
+      initCode: "0xdeadbeef",
     });
 
-    account.getAddress = vi.fn(
-      async () => "0xb856DBD4fA1A79a46D426f537455e7d3E79ab7c4"
-    );
+    // @ts-expect-error this object is protected
+    vi.spyOn(account.rpcProvider, "getBytecode").mockImplementation(() => {
+      return Promise.resolve("0x");
+    });
 
-    return account;
+    const initCode = await account.getInitCode();
+    expect(initCode).toMatchInlineSnapshot('"0xdeadbeef"');
   });
+
+  const givenConnectedProvider = ({
+    owner,
+    chain,
+  }: {
+    owner: SmartAccountSigner;
+    chain: Chain;
+  }) =>
+    new SmartAccountProvider({
+      rpcProvider: `${chain.rpcUrls.alchemy.http[0]}/${"test"}`,
+      chain,
+    }).connect((provider) => {
+      const account = new SimpleSmartContractAccount({
+        chain,
+        owner,
+        factoryAddress: getDefaultSimpleAccountFactoryAddress(chain),
+        rpcClient: provider,
+      });
+
+      account.getAddress = vi.fn(
+        async () => "0xb856DBD4fA1A79a46D426f537455e7d3E79ab7c4"
+      );
+
+      return account;
+    });
+});

packages/core/src/account/base.ts

@@ -40,6 +40,7 @@ export abstract class BaseSmartContractAccount<
   protected factoryAddress: Address;
   protected deploymentState: DeploymentState = DeploymentState.UNDEFINED;
   protected accountAddress?: Address;
+  protected accountInitCode?: Hex;
   protected owner: SmartAccountSigner | undefined;
   protected entryPoint: GetContractReturnType<
     typeof EntryPointAbi,
@@ -51,8 +52,9 @@ export abstract class BaseSmartContractAccount<
     | PublicErc4337Client<TTransport>
     | PublicErc4337Client<HttpTransport>;
 
-  constructor(params: BaseSmartAccountParams<TTransport>) {
-    createBaseSmartAccountParamsSchema<TTransport>().parse(params);
+  constructor(params_: BaseSmartAccountParams<TTransport>) {
+    const params =
+      createBaseSmartAccountParamsSchema<TTransport>().parse(params_);
 
     this.entryPointAddress =
       params.entryPointAddress ?? getDefaultEntryPointAddress(params.chain);
@@ -95,6 +97,7 @@ export abstract class BaseSmartContractAccount<
     this.accountAddress = params.accountAddress;
     this.factoryAddress = params.factoryAddress;
     this.owner = params.owner;
+    this.accountInitCode = params.initCode;
 
     this.entryPoint = getContract({
       address: this.entryPointAddress,
@@ -138,7 +141,7 @@ export abstract class BaseSmartContractAccount<
 
   /**
    * this should return the init code that will be used to create an account if one does not exist.
-   * Usually this is the concatenation of the account's factory address and the abi encoded function data of the account factory's `createAccount` method.
+   * This is the concatenation of the account's factory address and the abi encoded function data of the account factory's `createAccount` method.
    */
   protected abstract getAccountInitCode(): Promise<Hash>;
 
@@ -189,29 +192,6 @@ export abstract class BaseSmartContractAccount<
     return this.create6492Signature(isDeployed, signature);
   }
 
-  private async create6492Signature(
-    isDeployed: boolean,
-    signature: Hash
-  ): Promise<Hash> {
-    if (isDeployed) {
-      return signature;
-    }
-
-    const [factoryAddress, factoryCalldata] =
-      await this.parseFactoryAddressFromAccountInitCode();
-
-    Logger.debug(
-      `[BaseSmartContractAccount](create6492Signature)\
-        factoryAddress: ${factoryAddress}, factoryCalldata: ${factoryCalldata}`
-    );
-
-    return wrapSignatureWith6492({
-      factoryAddress,
-      factoryCalldata,
-      signature,
-    });
-  }
-
   /**
    * Not all contracts support batch execution.
    * If your contract does, this method should encode a list of
@@ -227,6 +207,7 @@ export abstract class BaseSmartContractAccount<
   }
   // #endregion optional-methods
 
+  // Extra implementations
   async getNonce(): Promise<bigint> {
     if (!(await this.isAccountDeployed())) {
       return 0n;
@@ -250,12 +231,12 @@ export abstract class BaseSmartContractAccount<
       this.deploymentState = DeploymentState.NOT_DEPLOYED;
     }
 
-    return this.getAccountInitCode();
+    return this._getAccountInitCode();
   }
 
   async getAddress(): Promise<Address> {
     if (!this.accountAddress) {
-      const initCode = await this.getAccountInitCode();
+      const initCode = await this._getAccountInitCode();
       Logger.debug(
         "[BaseSmartContractAccount](getAddress) initCode: ",
         initCode
@@ -291,7 +272,6 @@ export abstract class BaseSmartContractAccount<
     return this.entryPointAddress;
   }
 
-  // Extra implementations
   async isAccountDeployed(): Promise<boolean> {
     return (await this.getDeploymentState()) === DeploymentState.DEPLOYED;
   }
@@ -316,9 +296,36 @@ export abstract class BaseSmartContractAccount<
   protected async parseFactoryAddressFromAccountInitCode(): Promise<
     [Address, Hex]
   > {
-    const initCode = await this.getAccountInitCode();
+    const initCode = await this._getAccountInitCode();
     const factoryAddress = `0x${initCode.substring(2, 42)}` as Address;
     const factoryCalldata = `0x${initCode.substring(42)}` as Hex;
     return [factoryAddress, factoryCalldata];
   }
+
+  private async _getAccountInitCode(): Promise<Hash> {
+    return this.accountInitCode ?? this.getAccountInitCode();
+  }
+
+  private async create6492Signature(
+    isDeployed: boolean,
+    signature: Hash
+  ): Promise<Hash> {
+    if (isDeployed) {
+      return signature;
+    }
+
+    const [factoryAddress, factoryCalldata] =
+      await this.parseFactoryAddressFromAccountInitCode();
+
+    Logger.debug(
+      `[BaseSmartContractAccount](create6492Signature)\
+        factoryAddress: ${factoryAddress}, factoryCalldata: ${factoryCalldata}`
+    );
+
+    return wrapSignatureWith6492({
+      factoryAddress,
+      factoryCalldata,
+      signature,
+    });
+  }
 }

packages/core/src/account/schema.ts

@@ -1,5 +1,5 @@
 import { Address } from "abitype/zod";
-import type { Transport } from "viem";
+import { isHex, type Transport } from "viem";
 import z from "zod";
 import { createPublicErc4337ClientSchema } from "../client/schema.js";
 import type { SupportedTransports } from "../client/types";
@@ -18,5 +18,12 @@ export const createBaseSmartAccountParamsSchema = <
     owner: SignerSchema.optional(),
     entryPointAddress: Address.optional(),
     chain: ChainSchema,
-    accountAddress: Address.optional(),
+    accountAddress: Address.optional().describe(
+      "Optional override for the account address."
+    ),
+    initCode: z
+      .string()
+      .refine(isHex, "initCode must be a valid hex.")
+      .optional()
+      .describe("Optional override for the account init code."),
   });