refactor: switch alchemy client configs to use alchemy transport

aa-sdk/core/src/client/smartAccountClient.test.ts

@@ -1,6 +1,6 @@
 import { custom, type Transaction } from "viem";
 import { polygonMumbai } from "viem/chains";
-import type { SpyInstance } from "vitest";
+import type { MockInstance } from "vitest";
 import * as receiptActions from "../actions/bundler/getUserOperationReceipt.js";
 import type { UserOperationReceipt } from "../types.js";
 import {
@@ -110,10 +110,7 @@ describe("SmartAccountClient Tests", async () => {
   const thenExpectRetriesToBe = async (
     expectedRetryMsDelays: number[],
     expectedMockCalls: number,
-    getUserOperationReceiptMock: SpyInstance<
-      any,
-      Promise<UserOperationReceipt | null>
-    >
+    getUserOperationReceiptMock: MockInstance
   ) => {
     expect(retryMsDelays).toEqual(expectedRetryMsDelays);
     expect(getUserOperationReceiptMock).toHaveBeenCalledTimes(

account-kit/core/src/actions/getAlchemyTransport.ts

@@ -0,0 +1,8 @@
+import type { AlchemyTransport } from "@account-kit/infra";
+import type { AlchemyAccountsConfig } from "../types";
+
+export function getAlchemyTransport(
+  config: AlchemyAccountsConfig
+): AlchemyTransport {
+  return config.store.getState().transport;
+}

account-kit/core/src/actions/getSmartAccountClient.ts

@@ -1,5 +1,5 @@
 import {
-  createAlchemySmartAccountClientFromExisting,
+  createAlchemySmartAccountClient,
   type AlchemySmartAccountClient,
   type AlchemySmartAccountClientConfig,
 } from "@account-kit/infra";
@@ -19,7 +19,7 @@ import {
   type MultiOwnerPluginActions,
   type PluginManagerActions,
 } from "@account-kit/smart-contracts";
-import type { Address, Chain, Transport } from "viem";
+import type { Address, Chain } from "viem";
 import type {
   AlchemyAccountsConfig,
   Connection,
@@ -29,21 +29,16 @@ import type {
 } from "../types";
 import { createAccount } from "./createAccount.js";
 import { getAccount, type GetAccountParams } from "./getAccount.js";
-import { getBundlerClient } from "./getBundlerClient.js";
+import { getAlchemyTransport } from "./getAlchemyTransport.js";
 import { getConnection } from "./getConnection.js";
 import { getSignerStatus } from "./getSignerStatus.js";
 
 export type GetSmartAccountClientParams<
-  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends SupportedAccountTypes = SupportedAccountTypes
 > = Omit<
-  AlchemySmartAccountClientConfig<
-    TTransport,
-    TChain,
-    SupportedAccount<TAccount>
-  >,
-  "rpcUrl" | "chain" | "apiKey" | "jwt" | "account"
+  AlchemySmartAccountClientConfig<TChain, SupportedAccount<TAccount>>,
+  "transport" | "account"
 > &
   GetAccountParams<TAccount>;
 
@@ -60,29 +55,22 @@ export type ClientActions<
   : never;
 
 export type GetSmartAccountClientResult<
-  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends SupportedAccounts = SupportedAccounts
 > = {
-  client?: AlchemySmartAccountClient<
-    TTransport,
-    TChain,
-    TAccount,
-    ClientActions<TAccount>
-  >;
+  client?: AlchemySmartAccountClient<TChain, TAccount, ClientActions<TAccount>>;
   address?: Address;
   isLoadingClient: boolean;
   error?: Error;
 };
 
 export function getSmartAccountClient<
-  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends SupportedAccountTypes = SupportedAccountTypes
 >(
-  params: GetSmartAccountClientParams<TTransport, TChain, TAccount>,
+  params: GetSmartAccountClientParams<TChain, TAccount>,
   config: AlchemyAccountsConfig
-): GetSmartAccountClientResult<TTransport, TChain, SupportedAccount<TAccount>>;
+): GetSmartAccountClientResult<TChain, SupportedAccount<TAccount>>;
 
 /**
  * Obtains a smart account client based on the provided parameters and configuration. Supports creating any of the SupportAccountTypes in Account Kit.
@@ -116,7 +104,7 @@ export function getSmartAccountClient(
     config
   );
   const signerStatus = getSignerStatus(config);
-  const bundlerClient = getBundlerClient(config);
+  const transport = getAlchemyTransport(config);
   const connection = getConnection(config);
   const clientState =
     config.store.getState().smartAccountClients[connection.chain.id]?.[type];
@@ -189,8 +177,8 @@ export function getSmartAccountClient(
     switch (account.source) {
       case "LightAccount":
         return {
-          client: createAlchemySmartAccountClientFromExisting({
-            client: bundlerClient,
+          client: createAlchemySmartAccountClient({
+            transport,
             account: account,
             policyId: connection.policyId,
             ...clientParams,
@@ -200,8 +188,8 @@ export function getSmartAccountClient(
         };
       case "MultiOwnerLightAccount":
         return {
-          client: createAlchemySmartAccountClientFromExisting({
-            client: bundlerClient,
+          client: createAlchemySmartAccountClient({
+            transport,
             account: account,
             policyId: connection.policyId,
             ...clientParams,
@@ -211,8 +199,8 @@ export function getSmartAccountClient(
         };
       case "MultiOwnerModularAccount":
         return {
-          client: createAlchemySmartAccountClientFromExisting({
-            client: bundlerClient,
+          client: createAlchemySmartAccountClient({
+            transport,
             account: account,
             policyId: connection.policyId,
             ...clientParams,

account-kit/core/src/actions/setChain.ts

@@ -1,4 +1,4 @@
-import { createAlchemyPublicRpcClient } from "@account-kit/infra";
+import { alchemy, createAlchemyPublicRpcClient } from "@account-kit/infra";
 import { switchChain } from "@wagmi/core";
 import type { Chain } from "viem";
 import { ChainNotFoundError } from "../errors.js";
@@ -27,12 +27,14 @@ export async function setChain(config: AlchemyAccountsConfig, chain: Chain) {
   }
 
   await switchChain(config._internal.wagmiConfig, { chainId: chain.id });
+  const transport = alchemy(connection);
 
   config.store.setState(() => ({
     chain,
+    transport,
     bundlerClient: createAlchemyPublicRpcClient({
+      transport,
       chain,
-      connectionConfig: connection,
     }),
   }));
 }

account-kit/core/src/actions/watchSmartAccountClient.ts

@@ -1,4 +1,4 @@
-import type { Chain, Transport } from "viem";
+import type { Chain } from "viem";
 import { ClientOnlyPropertyError } from "../errors.js";
 import type {
   AlchemyAccountsConfig,
@@ -27,24 +27,19 @@ import {
  * @template TTransport extends Transport = Transport
  * @template TChain extends Chain | undefined = Chain | undefined
  *
- * @param {GetSmartAccountClientParams<TTransport, TChain, TAccount>} params the parameters needed to get the smart account client
+ * @param {GetSmartAccountClientParams<TChain, TAccount>} params the parameters needed to get the smart account client
  * @param {AlchemyAccountsConfig} config the configuration containing the client store and other settings
- * @returns {(onChange: (client: GetSmartAccountClientResult<TTransport, TChain, SupportedAccount<TAccount>>) => void) => (() => void)} a function that accepts a callback to be called when the client changes and returns a function to unsubscribe from the store
+ * @returns {(onChange: (client: GetSmartAccountClientResult<TChain, SupportedAccount<TAccount>>) => void) => (() => void)} a function that accepts a callback to be called when the client changes and returns a function to unsubscribe from the store
  */ export function watchSmartAccountClient<
   TAccount extends SupportedAccountTypes,
-  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined
 >(
-  params: GetSmartAccountClientParams<TTransport, TChain, TAccount>,
+  params: GetSmartAccountClientParams<TChain, TAccount>,
   config: AlchemyAccountsConfig
 ) {
   return (
     onChange: (
-      client: GetSmartAccountClientResult<
-        TTransport,
-        TChain,
-        SupportedAccount<TAccount>
-      >
+      client: GetSmartAccountClientResult<TChain, SupportedAccount<TAccount>>
     ) => void
   ) => {
     const accounts = config.store.getState().accounts;

account-kit/core/src/index.ts

@@ -77,7 +77,6 @@ export {
 export type * from "@account-kit/infra";
 export {
   createAlchemySmartAccountClient,
-  createAlchemySmartAccountClientFromExisting,
   type AlchemySmartAccountClient,
   type AlchemySmartAccountClientConfig,
 } from "@account-kit/infra";

account-kit/core/src/store/store.ts

@@ -1,5 +1,5 @@
 import type { NoUndefined } from "@aa-sdk/core";
-import { createAlchemyPublicRpcClient } from "@account-kit/infra";
+import { alchemy, createAlchemyPublicRpcClient } from "@account-kit/infra";
 import { AlchemySignerStatus, AlchemyWebSigner } from "@account-kit/signer";
 import type { Chain } from "viem";
 import {
@@ -48,17 +48,32 @@ export const createAccountKitStore = (
                     ),
                   };
                 }
+
+                if (key === "transport") {
+                  const transport = value as StoreState["transport"];
+                  return {
+                    connection: connections.find(
+                      (x) => x.chain.id === transport({}).value?.chain.id
+                    ),
+                  };
+                }
+
                 return bigintMapReplacer(key, value);
               },
               reviver: (key, value) => {
                 if (key === "bundlerClient") {
                   const { connection } = value as { connection: Connection };
                   return createAlchemyPublicRpcClient({
+                    transport: alchemy(connection),
                     chain: connection.chain,
-                    connectionConfig: connection,
                   });
                 }
 
+                if (key === "transport") {
+                  const { connection } = value as { connection: Connection };
+                  return alchemy(connection);
+                }
+
                 return bigintMapReviver(key, value);
               },
             }),
@@ -124,13 +139,15 @@ const createInitialStoreState = (
     throw new Error("Chain not found in connections");
   }
 
+  const transport = alchemy(connectionMap.get(chain.id)!);
   const bundlerClient = createAlchemyPublicRpcClient({
+    transport,
     chain,
-    connectionConfig: connectionMap.get(chain.id)!,
   });
   const chains = connections.map((c) => c.chain);
   const accountConfigs = createEmptyAccountConfigState(chains);
   const baseState: StoreState = {
+    transport,
     bundlerClient,
     chain,
     connections: connectionMap,

account-kit/core/src/store/types.ts

@@ -1,4 +1,7 @@
-import type { ClientWithAlchemyMethods } from "@account-kit/infra";
+import type {
+  AlchemyTransport,
+  ClientWithAlchemyMethods,
+} from "@account-kit/infra";
 import type {
   AlchemySignerParams,
   AlchemySignerStatus,
@@ -7,7 +10,7 @@ import type {
   User,
 } from "@account-kit/signer";
 import type { State as WagmiState } from "@wagmi/core";
-import type { Address, Chain, Transport } from "viem";
+import type { Address, Chain } from "viem";
 import type { PartialBy } from "viem/chains";
 import type { Mutate, StoreApi } from "zustand/vanilla";
 import type { AccountConfig } from "../actions/createAccount";
@@ -87,7 +90,6 @@ export type StoreState = {
   smartAccountClients: {
     [chain: number]: Partial<{
       [key in SupportedAccountTypes]: GetSmartAccountClientResult<
-        Transport,
         Chain,
         SupportedAccount<key>
       >;
@@ -96,6 +98,7 @@ export type StoreState = {
   // serializable state
   // NOTE: in some cases this can be serialized to cookie storage
   // be mindful of how big this gets. cookie limit 4KB
+  transport: AlchemyTransport;
   bundlerClient: ClientWithAlchemyMethods;
   config: ClientStoreConfig;
   accountConfigs: {

account-kit/infra/src/alchemyTransport.test.ts

@@ -0,0 +1,49 @@
+import * as AACoreModule from "@aa-sdk/core";
+import { avalanche } from "viem/chains";
+import { alchemy } from "./alchemyTransport.js";
+import { sepolia } from "./chains.js";
+
+describe("Alchemy Transport Tests", () => {
+  it.each([
+    { rpcUrl: "/api" },
+    { jwt: "test" },
+    { apiKey: "key" },
+    { rpcUrl: "/api", jwt: "jwt" },
+  ])("should successfully create a non-split transport", (args) => {
+    expect(() =>
+      alchemy({
+        ...args,
+      })
+    ).not.toThrowError();
+  });
+
+  it.each([
+    { rpcUrl: "/api" },
+    { jwt: "test" },
+    { apiKey: "key" },
+    { rpcUrl: "/api", jwt: "jwt" },
+  ])("should correctly create a split transport", (args) => {
+    const splitSpy = vi.spyOn(AACoreModule, "split");
+    alchemy({
+      alchemyConnection: args,
+      nodeRpcUrl: "/test",
+    })({ chain: sepolia });
+
+    expect(splitSpy.mock.calls.length).toBe(1);
+    expect(splitSpy.mock.calls[0]).toMatchSnapshot();
+  });
+
+  it("should correctly do runtime validation when chain is not supported by Alchemy", () => {
+    expect(() => alchemy({ rpcUrl: "/test" })({ chain: avalanche }))
+      .toThrowErrorMatchingInlineSnapshot(`
+      [ZodError: [
+        {
+          "code": "custom",
+          "message": "chain must include an alchemy rpc url. See \`createAlchemyChain\` or import a chain from \`@account-kit/infra\`.",
+          "fatal": true,
+          "path": []
+        }
+      ]]
+    `);
+  });
+});