@account-kit/smart-contracts 4.7.0 → 4.9.0

package/src/msca/client/client.ts

@@ -1,6 +1,7 @@
 import {
   createSmartAccountClient,
   smartAccountClientActions,
+  type NotType,
   type SmartAccountClient,
   type SmartAccountClientRpcSchema,
   type SmartAccountSigner,
@@ -35,8 +36,16 @@ import {
   type MultisigUserOperationContext,
 } from "../plugins/multisig/index.js";
 import { multisigSignatureMiddleware } from "../plugins/multisig/middleware.js";
+import type { AlchemyModularAccountClientConfig } from "./alchemyClient.js";
+import {
+  createAlchemySmartAccountClient,
+  isAlchemyTransport,
+  type AlchemySmartAccountClient,
+  type AlchemyTransport,
+} from "@account-kit/infra";
+import type { AlchemyMultisigAccountClientConfig } from "./multiSigAlchemyClient.js";
 
-export type CreateMultiOwnerModularAccountClientParams<
+export type CreateMultiOwnerModularAccountClientWithoutAlchemyParams<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TSigner extends SmartAccountSigner = SmartAccountSigner
@@ -45,8 +54,19 @@ export type CreateMultiOwnerModularAccountClientParams<
   "transport" | "chain"
 > &
   Omit<CreateLightAccountClientParams<TTransport, TChain, TSigner>, "account">;
+export type CreateMultiOwnerModularAccountClientParams<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> =
+  | CreateMultiOwnerModularAccountClientWithoutAlchemyParams<
+      TTransport,
+      TChain,
+      TSigner
+    >
+  | AlchemyModularAccountClientConfig<TSigner>;
 
-export type CreateMultisigModularAccountClientParams<
+export type CreateMultisigModularAccountClientWithoutAlchemyParams<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TSigner extends SmartAccountSigner = SmartAccountSigner
@@ -56,11 +76,45 @@ export type CreateMultisigModularAccountClientParams<
 > &
   Omit<CreateLightAccountClientParams<TTransport, TChain, TSigner>, "account">;
 
+export type CreateMultisigModularAccountClientParams<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> =
+  | CreateMultisigModularAccountClientWithoutAlchemyParams<
+      TTransport,
+      TChain,
+      TSigner
+    >
+  | AlchemyMultisigAccountClientConfig<TSigner>;
+
+export function createMultiOwnerModularAccountClient<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  params: AlchemyModularAccountClientConfig<TSigner> & {
+    transport: AlchemyTransport;
+  }
+): Promise<
+  AlchemySmartAccountClient<
+    Chain | undefined,
+    MultiOwnerModularAccount<TSigner>,
+    MultiOwnerPluginActions<MultiOwnerModularAccount<TSigner>> &
+      PluginManagerActions<MultiOwnerModularAccount<TSigner>> &
+      AccountLoupeActions<MultiOwnerModularAccount<TSigner>>
+  >
+>;
+
 export function createMultiOwnerModularAccountClient<
+  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TSigner extends SmartAccountSigner = SmartAccountSigner
 >(
-  args: CreateMultiOwnerModularAccountClientParams<Transport, TChain, TSigner>
+  args: CreateMultiOwnerModularAccountClientParams<
+    TTransport,
+    TChain,
+    TSigner
+  > &
+    NotType<TTransport, AlchemyTransport>
 ): Promise<
   SmartAccountClient<
     CustomTransport,
@@ -89,6 +143,19 @@ export function createMultiOwnerModularAccountClient<
  *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
  * });
  * ```
+ * @example
+ * ```ts
+ * import { createMultiOwnerModularAccountClient } from "@account-kit/smart-contracts";
+ * import { sepolia, alchemy } from "@account-kit/infra";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { generatePrivateKey } from "viem"
+ *
+ * const alchemyAccountClient = await createMultiOwnerModularAccountClient({
+ *  transport: alchemy({ apiKey: "your-api-key" }),
+ *  chain: sepolia,
+ *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey())
+ * });
+ * ```
  *
  * @param {CreateMultiOwnerModularAccountClientParams} config The parameters for creating the multi-owner modular account client
  * @returns {Promise<SmartAccountClient>} A promise that resolves to a `SmartAccountClient` instance with extended plugin actions
@@ -97,12 +164,28 @@ export async function createMultiOwnerModularAccountClient({
   transport,
   chain,
   ...params
-}: CreateMultiOwnerModularAccountClientParams): Promise<SmartAccountClient> {
+}: CreateMultiOwnerModularAccountClientParams): Promise<
+  SmartAccountClient | AlchemySmartAccountClient
+> {
   const modularAccount = await createMultiOwnerModularAccount({
     ...params,
     transport,
     chain,
   });
+  if (isAlchemyTransport(transport, chain)) {
+    const { opts } = params;
+
+    return createAlchemySmartAccountClient({
+      ...params,
+      account: modularAccount,
+      transport,
+      chain,
+      opts,
+    })
+      .extend(multiOwnerPluginActions)
+      .extend(pluginManagerActions)
+      .extend(accountLoupeActions);
+  }
 
   return createSmartAccountClient({
     ...params,
@@ -116,10 +199,27 @@ export async function createMultiOwnerModularAccountClient({
 }
 
 export function createMultisigModularAccountClient<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  params: AlchemyMultisigAccountClientConfig<TSigner>
+): Promise<
+  AlchemySmartAccountClient<
+    Chain | undefined,
+    MultisigModularAccount<TSigner>,
+    MultisigPluginActions<MultisigModularAccount<TSigner>> &
+      PluginManagerActions<MultisigModularAccount<TSigner>> &
+      AccountLoupeActions<MultisigModularAccount<TSigner>>,
+    MultisigUserOperationContext
+  >
+>;
+
+export function createMultisigModularAccountClient<
+  TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TSigner extends SmartAccountSigner = SmartAccountSigner
 >(
-  args: CreateMultisigModularAccountClientParams<Transport, TChain, TSigner>
+  args: CreateMultisigModularAccountClientParams<TTransport, TChain, TSigner> &
+    NotType<TTransport, AlchemyTransport>
 ): Promise<
   SmartAccountClient<
     CustomTransport,
@@ -152,6 +252,21 @@ export function createMultisigModularAccountClient<
  *  threshold: 2, // 2 of N signatures
  * });
  * ```
+ * @example
+ * ```ts
+ * import { createMultisigModularAccountClient } from "@account-kit/smart-contracts";
+ * import { sepolia } from "@account-kit/infra";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { generatePrivateKey } from "viem"
+ *
+ * const alchemyAccountClient = await createMultisigModularAccountClient({
+ *  transport: alchemy({ apiKey: "your-api-key" }),
+ *  chain: sepolia,
+ *  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()),
+ *  owners: [...], // other owners on the account
+ *  threshold: 2, // 2 of N signatures
+ * });
+ * ```
  *
  * @param {CreateMultisigModularAccountClientParams} config the parameters for configuring the multisig modular account client
  * @returns {Promise<SmartAccountClient<Transport, Chain, MultisigModularAccount<SmartAccountSigner>, {}, SmartAccountClientRpcSchema, MultisigUserOperationContext>>} a promise that resolves to a `SmartAccountClient` object extended with the multisig modular account and additional actions
@@ -161,20 +276,49 @@ export async function createMultisigModularAccountClient({
   chain,
   ...params
 }: CreateMultisigModularAccountClientParams): Promise<
-  SmartAccountClient<
-    Transport,
-    Chain,
-    MultisigModularAccount<SmartAccountSigner>,
-    {},
-    SmartAccountClientRpcSchema,
-    MultisigUserOperationContext
-  >
+  | SmartAccountClient<
+      Transport,
+      Chain,
+      MultisigModularAccount<SmartAccountSigner>,
+      {},
+      SmartAccountClientRpcSchema,
+      MultisigUserOperationContext
+    >
+  | AlchemySmartAccountClient<
+      Chain | undefined,
+      MultisigModularAccount<SmartAccountSigner>,
+      MultisigPluginActions<MultisigModularAccount<SmartAccountSigner>> &
+        PluginManagerActions<MultisigModularAccount<SmartAccountSigner>> &
+        AccountLoupeActions<MultisigModularAccount<SmartAccountSigner>>,
+      MultisigUserOperationContext
+    >
 > {
   const modularAccount = await createMultisigModularAccount({
     ...params,
     transport,
     chain,
   });
+  if (isAlchemyTransport(transport, chain)) {
+    // Need to fit the type into this since the previous multiSigAlchemyClient had it at this point, but without an Value as Type should be safe
+    // And the createAlchemySmartAccountClient signUserOperation could not infer without this
+    let config: AlchemyMultisigAccountClientConfig = {
+      ...params,
+      chain,
+      transport,
+    };
+    const { opts } = config;
+
+    return createAlchemySmartAccountClient({
+      ...config,
+      account: modularAccount,
+      opts,
+      signUserOperation: multisigSignatureMiddleware,
+    })
+      .extend(smartAccountClientActions)
+      .extend(multisigPluginActions)
+      .extend(pluginManagerActions)
+      .extend(accountLoupeActions);
+  }
 
   const client = createSmartAccountClient({
     ...params,

package/src/msca/client/multiSigAlchemyClient.ts

@@ -1,18 +1,11 @@
+import { type SmartAccountSigner } from "@aa-sdk/core";
 import {
-  smartAccountClientActions,
-  type SmartAccountSigner,
-} from "@aa-sdk/core";
-import {
-  createAlchemySmartAccountClient,
   type AlchemySmartAccountClient,
   type AlchemySmartAccountClientConfig,
+  type AlchemyTransport,
 } from "@account-kit/infra";
 import {
-  accountLoupeActions,
-  createMultisigModularAccount,
-  multisigPluginActions,
-  multisigSignatureMiddleware,
-  pluginManagerActions,
+  createMultisigModularAccountClient,
   type AccountLoupeActions,
   type CreateMultisigModularAccountParams,
   type LightAccount,
@@ -38,7 +31,7 @@ export type AlchemyMultisigAccountClientConfig<
       MultisigUserOperationContext
     >,
     "account"
-  >;
+  > & { transport: AlchemyTransport };
 
 export function createMultisigAccountAlchemyClient<
   TSigner extends SmartAccountSigner = SmartAccountSigner
@@ -74,6 +67,7 @@ export function createMultisigAccountAlchemyClient<
  * });
  * ```
  *
+ * @deprecated Use createModularAccountClient instead of this function, we are switching based on the transport
  * @param {AlchemyMultisigAccountClientConfig} config The configuration for the Alchemy multisig account client
  * @returns {Promise<AlchemySmartAccountClient<Transport, Chain | undefined, MultisigModularAccount<SmartAccountSigner>, MultisigPluginActions<MultisigModularAccount<SmartAccountSigner>> & PluginManagerActions<MultisigModularAccount<SmartAccountSigner>> & AccountLoupeActions<MultisigModularAccount<SmartAccountSigner>>, MultisigUserOperationContext>>} A promise that resolves to an Alchemy Smart Account Client for multisig accounts with extended functionalities.
  */
@@ -89,22 +83,5 @@ export async function createMultisigAccountAlchemyClient(
     MultisigUserOperationContext
   >
 > {
-  const { transport, opts, chain } = config;
-
-  const account = await createMultisigModularAccount({
-    ...config,
-    transport,
-    chain,
-  });
-
-  return createAlchemySmartAccountClient({
-    ...config,
-    account,
-    opts,
-    signUserOperation: multisigSignatureMiddleware,
-  })
-    .extend(smartAccountClientActions)
-    .extend(multisigPluginActions)
-    .extend(pluginManagerActions)
-    .extend(accountLoupeActions);
+  return createMultisigModularAccountClient(config);
 }