@account-kit/smart-contracts 4.0.0-alpha.0

package/src/msca/client/client.ts

@@ -0,0 +1,158 @@
+import {
+  createSmartAccountClient,
+  smartAccountClientActions,
+  type SmartAccountClient,
+  type SmartAccountClientRpcSchema,
+  type SmartAccountSigner,
+} from "@aa-sdk/core";
+import { type Chain, type CustomTransport, type Transport } from "viem";
+import type { CreateLightAccountClientParams } from "../../light-account/clients/client.js";
+import {
+  accountLoupeActions,
+  type AccountLoupeActions,
+} from "../account-loupe/decorator.js";
+import {
+  createMultiOwnerModularAccount,
+  type CreateMultiOwnerModularAccountParams,
+  type MultiOwnerModularAccount,
+} from "../account/multiOwnerAccount.js";
+import {
+  createMultisigModularAccount,
+  type CreateMultisigModularAccountParams,
+  type MultisigModularAccount,
+} from "../account/multisigAccount.js";
+import {
+  pluginManagerActions,
+  type PluginManagerActions,
+} from "../plugin-manager/decorator.js";
+import {
+  multiOwnerPluginActions,
+  type MultiOwnerPluginActions,
+} from "../plugins/multi-owner/index.js";
+import {
+  multisigPluginActions,
+  type MultisigPluginActions,
+  type MultisigUserOperationContext,
+} from "../plugins/multisig/index.js";
+import { multisigSignatureMiddleware } from "../plugins/multisig/middleware.js";
+
+export type CreateMultiOwnerModularAccountClientParams<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = {
+  account: Omit<
+    CreateMultiOwnerModularAccountParams<TTransport, TSigner>,
+    "transport" | "chain"
+  >;
+} & Omit<
+  CreateLightAccountClientParams<TTransport, TChain, TSigner>,
+  "account"
+>;
+
+export type CreateMultisigModularAccountClientParams<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = {
+  account: Omit<
+    CreateMultisigModularAccountParams<TTransport, TSigner>,
+    "transport" | "chain"
+  >;
+} & Omit<
+  CreateLightAccountClientParams<TTransport, TChain, TSigner>,
+  "account"
+>;
+
+export function createMultiOwnerModularAccountClient<
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  args: CreateMultiOwnerModularAccountClientParams<Transport, TChain, TSigner>
+): Promise<
+  SmartAccountClient<
+    CustomTransport,
+    Chain,
+    MultiOwnerModularAccount<TSigner>,
+    MultiOwnerPluginActions<MultiOwnerModularAccount<TSigner>> &
+      PluginManagerActions<MultiOwnerModularAccount<TSigner>> &
+      AccountLoupeActions<MultiOwnerModularAccount<TSigner>>
+  >
+>;
+
+export async function createMultiOwnerModularAccountClient({
+  account,
+  transport,
+  chain,
+  ...clientConfig
+}: CreateMultiOwnerModularAccountClientParams): Promise<SmartAccountClient> {
+  const modularAccount = await createMultiOwnerModularAccount({
+    ...account,
+    transport,
+    chain,
+  });
+
+  return createSmartAccountClient({
+    ...clientConfig,
+    transport,
+    chain,
+    account: modularAccount,
+  })
+    .extend(pluginManagerActions)
+    .extend(multiOwnerPluginActions)
+    .extend(accountLoupeActions);
+}
+
+export function createMultisigModularAccountClient<
+  TChain extends Chain | undefined = Chain | undefined,
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  args: CreateMultisigModularAccountClientParams<Transport, TChain, TSigner>
+): Promise<
+  SmartAccountClient<
+    CustomTransport,
+    Chain,
+    MultisigModularAccount<TSigner>,
+    MultisigPluginActions<MultisigModularAccount<TSigner>> &
+      PluginManagerActions<MultisigModularAccount<TSigner>> &
+      AccountLoupeActions<MultisigModularAccount<TSigner>>,
+    SmartAccountClientRpcSchema,
+    MultisigUserOperationContext
+  >
+>;
+
+export async function createMultisigModularAccountClient({
+  account,
+  transport,
+  chain,
+  ...clientConfig
+}: CreateMultisigModularAccountClientParams): Promise<
+  SmartAccountClient<
+    Transport,
+    Chain,
+    MultisigModularAccount<SmartAccountSigner>,
+    {},
+    SmartAccountClientRpcSchema,
+    MultisigUserOperationContext
+  >
+> {
+  const modularAccount = await createMultisigModularAccount({
+    ...account,
+    transport,
+    chain,
+  });
+
+  const client = createSmartAccountClient({
+    ...clientConfig,
+    transport,
+    chain,
+    account: modularAccount,
+    signUserOperation: multisigSignatureMiddleware,
+  })
+    .extend(smartAccountClientActions)
+    .extend(pluginManagerActions)
+    .extend(multisigPluginActions)
+    .extend(accountLoupeActions);
+
+  return client;
+}

package/src/msca/client/multiSigAlchemyClient.ts

@@ -0,0 +1,109 @@
+import {
+  AlchemyProviderConfigSchema,
+  createAlchemyPublicRpcClient,
+  createAlchemySmartAccountClientFromExisting,
+  type AlchemySmartAccountClient,
+  type AlchemySmartAccountClientConfig,
+} from "@account-kit/infra";
+import {
+  accountLoupeActions,
+  createMultisigModularAccount,
+  multisigPluginActions,
+  multisigSignatureMiddleware,
+  pluginManagerActions,
+  type AccountLoupeActions,
+  type CreateMultisigModularAccountParams,
+  type LightAccount,
+  type MultisigModularAccount,
+  type MultisigPluginActions,
+  type MultisigUserOperationContext,
+  type PluginManagerActions,
+} from "@account-kit/smart-contracts";
+import {
+  smartAccountClientActions,
+  type SmartAccountSigner,
+} from "@aa-sdk/core";
+import {
+  custom,
+  type Chain,
+  type CustomTransport,
+  type HttpTransport,
+  type Transport,
+} from "viem";
+
+// todo: this file seems somewhat duplicated with ./modularAccountClient.ts, but that file has some multi-owner specific fields. Is there a way to refactor these two to de-dupe?
+
+export type AlchemyMultisigAccountClientConfig<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+> = Omit<
+  CreateMultisigModularAccountParams<HttpTransport, TSigner>,
+  "transport" | "chain"
+> &
+  Omit<
+    AlchemySmartAccountClientConfig<
+      Transport,
+      Chain,
+      LightAccount<TSigner>,
+      MultisigUserOperationContext
+    >,
+    "account"
+  >;
+
+export function createMultisigAccountAlchemyClient<
+  TSigner extends SmartAccountSigner = SmartAccountSigner
+>(
+  params: AlchemyMultisigAccountClientConfig<TSigner>
+): Promise<
+  AlchemySmartAccountClient<
+    CustomTransport,
+    Chain | undefined,
+    MultisigModularAccount<TSigner>,
+    MultisigPluginActions<MultisigModularAccount<TSigner>> &
+      PluginManagerActions<MultisigModularAccount<TSigner>> &
+      AccountLoupeActions<MultisigModularAccount<TSigner>>,
+    MultisigUserOperationContext
+  >
+>;
+
+export async function createMultisigAccountAlchemyClient(
+  config: AlchemyMultisigAccountClientConfig
+): Promise<
+  AlchemySmartAccountClient<
+    Transport,
+    Chain | undefined,
+    MultisigModularAccount<SmartAccountSigner>,
+    MultisigPluginActions<MultisigModularAccount<SmartAccountSigner>> &
+      PluginManagerActions<MultisigModularAccount<SmartAccountSigner>> &
+      AccountLoupeActions<MultisigModularAccount<SmartAccountSigner>>,
+    MultisigUserOperationContext
+  >
+> {
+  const { chain, opts, ...connectionConfig } =
+    AlchemyProviderConfigSchema.parse(config);
+
+  const client = createAlchemyPublicRpcClient({
+    chain,
+    connectionConfig,
+  });
+
+  const account = await createMultisigModularAccount({
+    transport: custom(client),
+    ...config,
+  });
+
+  return createAlchemySmartAccountClientFromExisting<
+    Chain | undefined,
+    MultisigModularAccount<SmartAccountSigner>,
+    MultisigUserOperationContext
+  >({
+    ...config,
+    client,
+    account,
+    opts,
+    signUserOperation: multisigSignatureMiddleware,
+  })
+    .extend(smartAccountClientActions)
+    .extend(multisigPluginActions)
+    .extend(pluginManagerActions)
+    .extend(accountLoupeActions);
+}

package/src/msca/e2e-tests/constants.ts

@@ -0,0 +1,3 @@
+export const API_KEY = process.env.API_KEY!;
+export const PAYMASTER_POLICY_ID = process.env.PAYMASTER_POLICY_ID!;
+export const OWNER_MNEMONIC = process.env.OWNER_MNEMONIC!;

package/src/msca/errors.ts

@@ -0,0 +1,29 @@
+import { BaseError } from "@aa-sdk/core";
+
+export class InvalidAggregatedSignatureError extends BaseError {
+  override name = "InvalidAggregatedSignatureError";
+  constructor() {
+    super("Invalid aggregated signature");
+  }
+}
+
+export class InvalidContextSignatureError extends BaseError {
+  override name = "InvalidContextSignatureError";
+  constructor() {
+    super("Expected context.signature to be a hex string");
+  }
+}
+
+export class MultisigAccountExpectedError extends BaseError {
+  override name = "MultisigAccountExpectedError";
+  constructor() {
+    super("Expected account to be a multisig modular account");
+  }
+}
+
+export class MultisigMissingSignatureError extends BaseError {
+  override name = "MultisigMissingSignatureError";
+  constructor() {
+    super("UserOp must have at least one signature already");
+  }
+}

package/src/msca/plugin-manager/decorator.ts

@@ -0,0 +1,41 @@
+import type {
+  GetEntryPointFromAccount,
+  SendUserOperationResult,
+  SmartContractAccount,
+} from "@aa-sdk/core";
+import type { Chain, Client, Transport } from "viem";
+import { installPlugin, type InstallPluginParams } from "./installPlugin.js";
+import {
+  uninstallPlugin,
+  type UninstallPluginParams,
+} from "./uninstallPlugin.js";
+
+export { type InstallPluginParams } from "./installPlugin.js";
+export { type UninstallPluginParams } from "./uninstallPlugin.js";
+
+export type PluginManagerActions<
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined,
+  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
+> = {
+  installPlugin: (
+    params: InstallPluginParams<TAccount>
+  ) => Promise<SendUserOperationResult<TEntryPointVersion>>;
+  uninstallPlugin: (
+    params: UninstallPluginParams<TAccount>
+  ) => Promise<SendUserOperationResult<TEntryPointVersion>>;
+};
+
+export const pluginManagerActions: <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined
+>(
+  client: Client<TTransport, TChain, TAccount>
+) => PluginManagerActions<TAccount> = (client) => ({
+  installPlugin: async (params) => installPlugin(client, params),
+  uninstallPlugin: async (params) => uninstallPlugin(client, params),
+});

package/src/msca/plugin-manager/installPlugin.ts

@@ -0,0 +1,118 @@
+import {
+  AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
+  type GetAccountParameter,
+  type GetContextParameter,
+  type GetEntryPointFromAccount,
+  type SmartAccountClient,
+  type SmartContractAccount,
+  type UserOperationOverridesParameter,
+} from "@aa-sdk/core";
+import {
+  encodeFunctionData,
+  encodeFunctionResult,
+  keccak256,
+  type Address,
+  type Chain,
+  type Client,
+  type Hash,
+  type Transport,
+} from "viem";
+import { IPluginAbi } from "../abis/IPlugin.js";
+import { IPluginManagerAbi } from "../abis/IPluginManager.js";
+import type { FunctionReference } from "../account-loupe/types.js";
+
+export type InstallPluginParams<
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined,
+  TContext extends Record<string, unknown> | undefined =
+    | Record<string, unknown>
+    | undefined,
+  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
+> = {
+  pluginAddress: Address;
+  manifestHash?: Hash;
+  pluginInitData?: Hash;
+  dependencies?: FunctionReference[];
+} & UserOperationOverridesParameter<TEntryPointVersion> &
+  GetAccountParameter<TAccount> &
+  GetContextParameter<TContext>;
+
+export async function installPlugin<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined,
+  TContext extends Record<string, unknown> | undefined =
+    | Record<string, unknown>
+    | undefined
+>(
+  client: Client<TTransport, TChain, TAccount>,
+  {
+    overrides,
+    context,
+    account = client.account,
+    ...params
+  }: InstallPluginParams<TAccount, TContext>
+) {
+  if (!account) {
+    throw new AccountNotFoundError();
+  }
+
+  if (!isSmartAccountClient(client)) {
+    throw new IncompatibleClientError(
+      "SmartAccountClient",
+      "installPlugin",
+      client
+    );
+  }
+
+  const callData = await encodeInstallPluginUserOperation(client, params);
+
+  return client.sendUserOperation({
+    uo: callData,
+    overrides,
+    account,
+    context,
+  });
+}
+
+export async function encodeInstallPluginUserOperation<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined
+>(
+  client: SmartAccountClient<TTransport, TChain, TAccount>,
+  params: Omit<InstallPluginParams, "overrides" | "account" | "context">
+) {
+  const pluginManifest = await client.readContract({
+    abi: IPluginAbi,
+    address: params.pluginAddress,
+    functionName: "pluginManifest",
+  });
+  // use the manifest hash passed in or get it from the plugin
+  const manifestHash: Hash =
+    params.manifestHash ??
+    keccak256(
+      encodeFunctionResult({
+        abi: IPluginAbi,
+        functionName: "pluginManifest",
+        result: pluginManifest,
+      })
+    );
+  return encodeFunctionData({
+    abi: IPluginManagerAbi,
+    functionName: "installPlugin",
+    args: [
+      params.pluginAddress,
+      manifestHash,
+      params.pluginInitData ?? "0x",
+      params.dependencies ?? [],
+    ],
+  });
+}

package/src/msca/plugin-manager/uninstallPlugin.ts

@@ -0,0 +1,90 @@
+import {
+  AccountNotFoundError,
+  IncompatibleClientError,
+  isSmartAccountClient,
+  type GetAccountParameter,
+  type GetContextParameter,
+  type GetEntryPointFromAccount,
+  type SmartContractAccount,
+  type UserOperationContext,
+  type UserOperationOverridesParameter,
+} from "@aa-sdk/core";
+import {
+  encodeFunctionData,
+  type Address,
+  type Chain,
+  type Client,
+  type Hash,
+  type Transport,
+} from "viem";
+import { IPluginManagerAbi } from "../abis/IPluginManager.js";
+
+export type UninstallPluginParams<
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined,
+  TContext extends UserOperationContext | undefined =
+    | UserOperationContext
+    | undefined,
+  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
+> = {
+  pluginAddress: Address;
+  config?: Hash;
+  pluginUninstallData?: Hash;
+} & UserOperationOverridesParameter<TEntryPointVersion> &
+  GetAccountParameter<TAccount> &
+  GetContextParameter<TContext>;
+
+export async function uninstallPlugin<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined,
+  TContext extends UserOperationContext | undefined =
+    | UserOperationContext
+    | undefined
+>(
+  client: Client<TTransport, TChain, TAccount>,
+  {
+    overrides,
+    account = client.account,
+    context,
+    ...params
+  }: UninstallPluginParams<TAccount, TContext>
+) {
+  if (!account) {
+    throw new AccountNotFoundError();
+  }
+
+  if (!isSmartAccountClient(client)) {
+    throw new IncompatibleClientError(
+      "SmartAccountClient",
+      "uninstallPlugin",
+      client
+    );
+  }
+
+  const callData = await encodeUninstallPluginUserOperation(params);
+
+  return client.sendUserOperation({
+    uo: callData,
+    overrides,
+    account,
+    context,
+  });
+}
+
+export async function encodeUninstallPluginUserOperation(
+  params: Omit<UninstallPluginParams, "account" | "overrides" | "context">
+) {
+  return encodeFunctionData({
+    abi: IPluginManagerAbi,
+    functionName: "uninstallPlugin",
+    args: [
+      params.pluginAddress,
+      params.config ?? "0x",
+      params.pluginUninstallData ?? "0x",
+    ],
+  });
+}

package/src/msca/plugins/multi-owner/extension.ts

@@ -0,0 +1,80 @@
+import {
+  AccountNotFoundError,
+  type GetAccountParameter,
+  type IsUndefined,
+  type SmartContractAccount,
+} from "@aa-sdk/core";
+import { type Address, type Chain, type Client, type Transport } from "viem";
+import type { GetPluginAddressParameter } from "../types.js";
+import {
+  MultiOwnerPlugin,
+  multiOwnerPluginActions as multiOwnerPluginActions_,
+  type MultiOwnerPluginActions as MultiOwnerPluginActions_,
+} from "./plugin.js";
+
+export type MultiOwnerPluginActions<
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined
+> = MultiOwnerPluginActions_<TAccount, undefined> & {
+  readOwners: (
+    params: GetPluginAddressParameter & GetAccountParameter<TAccount>
+  ) => Promise<ReadonlyArray<Address>>;
+
+  isOwnerOf: (
+    params: { address: Address } & GetPluginAddressParameter &
+      GetAccountParameter<TAccount>
+  ) => Promise<boolean>;
+} & (IsUndefined<TAccount> extends false
+    ? {
+        readOwners: (
+          params?: GetPluginAddressParameter & GetAccountParameter<TAccount>
+        ) => Promise<ReadonlyArray<Address>>;
+      }
+    : {});
+
+export const multiOwnerPluginActions: <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined
+>(
+  client: Client<TTransport, TChain, TAccount>
+) => MultiOwnerPluginActions<TAccount> = <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends SmartContractAccount | undefined =
+    | SmartContractAccount
+    | undefined
+>(
+  client: Client<TTransport, TChain, TAccount>
+) => ({
+  ...multiOwnerPluginActions_(client),
+  async readOwners(
+    args: GetPluginAddressParameter & GetAccountParameter<TAccount>
+  ) {
+    const account = args?.account ?? client.account;
+    if (!account) {
+      throw new AccountNotFoundError();
+    }
+    // TODO: check if the account actually has the plugin installed
+    // either via account loupe or checking if the supports interface call passes on the account
+    const contract = MultiOwnerPlugin.getContract(client, args?.pluginAddress);
+    return contract.read.ownersOf([account.address]);
+  },
+
+  async isOwnerOf(
+    args: { address: Address } & GetPluginAddressParameter &
+      GetAccountParameter<TAccount>
+  ) {
+    const account = args.account ?? client.account;
+    if (!account) {
+      throw new AccountNotFoundError();
+    }
+    // TODO: check if the account actually has the plugin installed
+    // either via account loupe or checking if the supports interface call passes on the account
+    const contract = MultiOwnerPlugin.getContract(client, args.pluginAddress);
+    return contract.read.isOwnerOf([account.address, args.address]);
+  },
+});

package/src/msca/plugins/multi-owner/index.ts

@@ -0,0 +1,6 @@
+export type * from "./extension.js";
+export { multiOwnerPluginActions } from "./extension.js";
+export {
+  MultiOwnerPluginAbi,
+  MultiOwnerPluginExecutionFunctionAbi,
+} from "./plugin.js";