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

package/src/light-account/types.ts

@@ -0,0 +1,210 @@
+import {
+  type EntryPointVersion,
+  type GetAccountParameter,
+  type OneOf,
+  type SmartAccountSigner,
+  type SmartContractAccount,
+} from "@aa-sdk/core";
+import { type Address, type Chain } from "viem";
+import type { LightAccountBase } from "./accounts/base";
+
+/**
+ * Light account types supported: LightAccount, MultiOwnerLightAccount
+ *
+ */
+export type LightAccountType = keyof IAccountVersionRegistry;
+
+/**
+ * Account version definition, which is the base type defining the LightAccountVersionDef interface
+ *
+ * @template {LightAccountType} TLightAccountType type
+ * @template {GetLightAccountVersion<TLightAccountType>} TLightAccountVersion version
+ * @template {EntryPointVersion} TEntryPointVersion entryPointVersion
+ */
+export type AccountVersionDef<
+  TLightAccountType extends LightAccountType = LightAccountType,
+  TLightAccountVersion extends GetLightAccountVersion<TLightAccountType> = GetLightAccountVersion<TLightAccountType>,
+  TEntryPointVersion extends EntryPointVersion = EntryPointVersion
+> = {
+  type: TLightAccountType;
+  version: TLightAccountVersion;
+  entryPointVersion: TEntryPointVersion;
+  address: Record<
+    Chain["id"],
+    {
+      factory: Address;
+      impl: Address;
+    }
+  >;
+};
+
+/**
+ * Light account version type defs for tightly coupled types for smart accounts
+ *
+ */
+export type LightAccountVersion =
+  | keyof IAccountVersionRegistry["LightAccount"]
+  | keyof IAccountVersionRegistry["MultiOwnerLightAccount"];
+
+/**
+ * Get the light account versions available for the given light account type
+ *
+ * @template {LightAccountType} TLightAccountType
+ */
+export type GetLightAccountVersion<
+  TLightAccountType extends LightAccountType = LightAccountType
+> = keyof IAccountVersionRegistry[TLightAccountType];
+
+/**
+ * Light account version definition type based on the light account type and version
+ *
+ * @template {LightAccountType} TLightAccountType
+ * @template {GetLightAccountVersion<TLightAccountType>} TLightAccountVersion
+ */
+export type LightAccountVersionDef<
+  TLightAccountType extends LightAccountType = LightAccountType,
+  TLightAccountVersion extends GetLightAccountVersion<TLightAccountType> = GetLightAccountVersion<TLightAccountType>
+> = IAccountVersionRegistry[TLightAccountType][TLightAccountVersion];
+
+/**
+ * Light account version registry interface defining the supported light account versions
+ *
+ */
+export interface IAccountVersionRegistry {
+  LightAccount: {
+    /** @deprecated This version does not support 1271 signature validation */
+    "v1.0.1": AccountVersionDef<"LightAccount", "v1.0.1", "0.6.0">;
+    /** @deprecated This version has a known issue with 1271 validation */
+    "v1.0.2": AccountVersionDef<"LightAccount", "v1.0.2", "0.6.0">;
+    "v1.1.0": AccountVersionDef<"LightAccount", "v1.1.0", "0.6.0">;
+    /**
+     * LightAccount v2 Changelog.
+     * It is recommended to use v2.0.0
+     * https://alchemotion.notion.site/External-Light-Account-v2-Changelog-725b306ab1e04eb0a3e596521dd8f0bd
+     */
+    "v2.0.0": AccountVersionDef<"LightAccount", "v2.0.0", "0.7.0">;
+  };
+  MultiOwnerLightAccount: {
+    /**
+     * MultiOwnerLightAccount v2 Changelog
+     * It is recommended to use v2.0.0
+     * https://alchemotion.notion.site/External-Light-Account-v2-Changelog-725b306ab1e04eb0a3e596521dd8f0bd
+     */
+    "v2.0.0": AccountVersionDef<"MultiOwnerLightAccount", "v2.0.0", "0.7.0">;
+  };
+}
+
+/**
+ * Get the light account version definitions available for the given light account type
+ *
+ * @template {LightAccountType} TLightAccountType
+ *
+ * @example
+ * type T1 = GetLightAccountVersionsForType<"LightAccount">;
+ * const t1: T1 = AccountVersionRegistry.LightAccount["v1.0.2"];
+ */
+export type GetLightAccountVersionDefsForType<TType extends LightAccountType> =
+  Extract<
+    IAccountVersionRegistry[TType][keyof IAccountVersionRegistry[TType]],
+    { type: TType }
+  >;
+
+/**
+ * Get the light account version definition for the given light account type and version
+ *
+ * @template {LightAccountType} TType
+ * @template {GetLightAccountVersion<TType>} TLightAccountVersion
+ */
+export type GetLightAccountVersionDef<
+  TType extends LightAccountType,
+  TLightAccountVersion extends GetLightAccountVersion<TType>
+> = IAccountVersionRegistry[TType][TLightAccountVersion];
+
+/**
+ * @example
+ * type T = GetLightAccountVersionDefsForEntryPoint<"LightAccount", "0.6.0">;
+ * const t_1: T = AccountVersionRegistry.LightAccount["v1.0.2"]; // compiles
+ * const t_2: T = AccountVersionRegistry.LightAccount["v2.0.0"]; // errors
+ */
+export type GetLightAccountVersionDefsForEntryPoint<
+  TType extends LightAccountType,
+  TEntryPointVersion extends EntryPointVersion
+> = Extract<
+  GetLightAccountVersionDefsForType<TType>,
+  { entryPointVersion: TEntryPointVersion }
+>;
+
+/**
+ * Get the light account type for the given light account by inferring from its type definition
+ *
+ * @template {SmartContractAccount | undefined} TAccount
+ * @template {SmartContractAccount} TAccountOverride
+ */
+export type GetLightAccountType<
+  TAccount extends SmartContractAccount | undefined,
+  TAccountOverride extends SmartContractAccount = SmartContractAccount
+> = GetAccountParameter<TAccount, TAccountOverride> extends LightAccountBase<
+  SmartAccountSigner,
+  infer TLightAccountType
+>
+  ? OneOf<TLightAccountType, LightAccountType>
+  : LightAccountType;
+
+/**
+ * Get the light account version for the given light account by inferring from its type definition
+ *
+ * @template {LightAccountBase | undefined} TAccount
+ * @template {LightAccountBase} TAccountOverride
+ */
+export type GetLightAccountVersionFromAccount<
+  TAccount extends LightAccountBase | undefined,
+  TAccountOverride extends LightAccountBase = LightAccountBase
+> = GetAccountParameter<TAccount, TAccountOverride> extends LightAccountBase<
+  SmartAccountSigner,
+  LightAccountType,
+  infer TLightAccountVersion
+>
+  ? OneOf<TLightAccountVersion, LightAccountVersion>
+  : LightAccountVersion;
+
+/**
+ * Get the entry point version supported for the given light account type and version
+ *
+ * @template {LightAccountType} TLightAccountType
+ * @template {GetLightAccountVersion<TLightAccountType>} TLightAccountVersion
+ */
+export type GetEntryPointForLightAccountVersion<
+  TLightAccountType extends LightAccountType = LightAccountType,
+  TLightAccountVersion extends GetLightAccountVersion<TLightAccountType> = GetLightAccountVersion<TLightAccountType>
+> = GetLightAccountVersionDef<
+  TLightAccountType,
+  TLightAccountVersion
+> extends AccountVersionDef<
+  TLightAccountType,
+  TLightAccountVersion,
+  infer TEntryPointVersion
+>
+  ? TEntryPointVersion
+  : EntryPointVersion;
+
+/**
+ * Get the light account type for the given light account version by inferring from its type definition
+ *
+ * @template {LightAccountVersion} TLightAccountVersion
+ */
+export type GetLightAccountTypesForVersion<
+  TLightAccountVersion extends LightAccountVersion = LightAccountVersion
+> = TLightAccountVersion extends GetLightAccountVersion<infer TLightAccountType>
+  ? TLightAccountType
+  : LightAccountType;
+
+/**
+ * Get default light account version for the given light account type
+ *
+ * @template {LightAccountType} TLightAccountType
+ */
+export type GetDefaultLightAccountVersion<
+  TLightAccountType extends LightAccountType = LightAccountType
+> = TLightAccountType extends "MultiOwnerLightAccount"
+  ? "v2.0.0" & LightAccountVersion
+  : "v1.1.0" & LightAccountVersion;

package/src/light-account/utils.ts

@@ -0,0 +1,339 @@
+import {
+  DefaultFactoryNotDefinedError,
+  arbitrum,
+  arbitrumGoerli,
+  arbitrumSepolia,
+  base,
+  baseGoerli,
+  baseSepolia,
+  fraxtal,
+  fraxtalSepolia,
+  goerli,
+  mainnet,
+  optimism,
+  optimismGoerli,
+  optimismSepolia,
+  polygon,
+  polygonAmoy,
+  polygonMumbai,
+  sepolia,
+  toRecord,
+  zora,
+  zoraSepolia,
+} from "@aa-sdk/core";
+import { fromHex, type Address, type Chain } from "viem";
+import type { LightAccountBase } from "./accounts/base";
+import type {
+  AccountVersionDef,
+  GetLightAccountType,
+  GetLightAccountVersion,
+  GetLightAccountVersionFromAccount,
+  IAccountVersionRegistry,
+  LightAccountType,
+  LightAccountVersion,
+  LightAccountVersionDef,
+} from "./types";
+
+/**
+ * Light account deployed chains
+ *
+ */
+export const supportedChains: Chain[] = [
+  mainnet,
+  sepolia,
+  goerli,
+  polygon,
+  polygonAmoy,
+  polygonMumbai,
+  optimism,
+  optimismGoerli,
+  optimismSepolia,
+  arbitrum,
+  arbitrumGoerli,
+  arbitrumSepolia,
+  base,
+  baseGoerli,
+  baseSepolia,
+  fraxtal,
+  fraxtalSepolia,
+  zora,
+  zoraSepolia,
+];
+
+/**
+ * Account version registry interface that defines the light account versions
+ * and the version definition for each light account type
+ *
+ */
+export const AccountVersionRegistry: IAccountVersionRegistry = {
+  LightAccount: {
+    "v1.0.1": {
+      type: "LightAccount",
+      version: "v1.0.1",
+      address: toRecord<Chain, "id", { factory: Address; impl: Address }>(
+        supportedChains,
+        "id",
+        () => ({
+          factory:
+            "0x000000893A26168158fbeaDD9335Be5bC96592E2".toLowerCase() as Address,
+          impl: "0xc1b2fc4197c9187853243e6e4eb5a4af8879a1c0".toLowerCase() as Address,
+        })
+      ),
+      entryPointVersion: "0.6.0",
+    },
+    "v1.0.2": {
+      type: "LightAccount",
+      version: "v1.0.2",
+      address: toRecord<Chain, "id", { factory: Address; impl: Address }>(
+        supportedChains,
+        "id",
+        () => ({
+          factory:
+            "0x00000055C0b4fA41dde26A74435ff03692292FBD".toLowerCase() as Address,
+          impl: "0x5467b1947F47d0646704EB801E075e72aeAe8113".toLowerCase() as Address,
+        })
+      ),
+      entryPointVersion: "0.6.0",
+    },
+    "v1.1.0": {
+      type: "LightAccount",
+      version: "v1.1.0",
+      address: toRecord<Chain, "id", { factory: Address; impl: Address }>(
+        supportedChains,
+        "id",
+        () => ({
+          factory:
+            "0x00004EC70002a32400f8ae005A26081065620D20".toLowerCase() as Address,
+          impl: "0xae8c656ad28F2B59a196AB61815C16A0AE1c3cba".toLowerCase() as Address,
+        })
+      ),
+      entryPointVersion: "0.6.0",
+    },
+    "v2.0.0": {
+      type: "LightAccount",
+      version: "v2.0.0",
+      address: toRecord<Chain, "id", { factory: Address; impl: Address }>(
+        supportedChains,
+        "id",
+        () => ({
+          factory:
+            "0x0000000000400CdFef5E2714E63d8040b700BC24".toLowerCase() as Address,
+          impl: "0x8E8e658E22B12ada97B402fF0b044D6A325013C7".toLowerCase() as Address,
+        })
+      ),
+      entryPointVersion: "0.7.0",
+    },
+  },
+  MultiOwnerLightAccount: {
+    "v2.0.0": {
+      type: "MultiOwnerLightAccount",
+      version: "v2.0.0",
+      address: toRecord<Chain, "id", { factory: Address; impl: Address }>(
+        supportedChains,
+        "id",
+        () => ({
+          factory:
+            "0x000000000019d2Ee9F2729A65AfE20bb0020AefC".toLowerCase() as Address,
+          impl: "0xd2c27F9eE8E4355f71915ffD5568cB3433b6823D".toLowerCase() as Address,
+        })
+      ),
+      entryPointVersion: "0.7.0",
+    },
+  },
+};
+
+/**
+ * Get the default light account version for the given light account type
+ *
+ * @template {LightAccountType} TLightAccountType
+ * @param type - the light account type to get the default version for
+ * @returns the default version for the given light account type
+ */
+export const defaultLightAccountVersion = <
+  TLightAccountType extends LightAccountType
+>(
+  type: TLightAccountType
+): GetLightAccountVersion<TLightAccountType> =>
+  (type === "LightAccount"
+    ? "v1.1.0"
+    : "v2.0.0") as GetLightAccountVersion<TLightAccountType>;
+
+/**
+ * Utility method returning the default light account factory address given a {@link Chain} object
+ *
+ * @param chain - a {@link Chain} object
+ * @param version - the version of the light account to get the factory address for
+ * @returns a {@link Address} for the given chain
+ * @throws if the chain doesn't have an address currently deployed
+ */
+export const getDefaultLightAccountFactoryAddress = (
+  chain: Chain,
+  version: LightAccountVersion = "v1.1.0"
+): Address => {
+  const address =
+    AccountVersionRegistry.LightAccount[version].address[chain.id];
+  if (!address)
+    throw new DefaultFactoryNotDefinedError("LightAccount", chain, "0.6.0");
+  return address.factory;
+};
+
+/**
+ * Can be used to check if the account with one of the following implementation addresses
+ * to not support 1271 signing.
+ *
+ * Light accounts with versions v1.0.1 and v1.0.2 do not support 1271 signing.
+ *
+ */
+export const LightAccountUnsupported1271Impls = [
+  AccountVersionRegistry.LightAccount["v1.0.1"],
+  AccountVersionRegistry.LightAccount["v1.0.2"],
+];
+
+/**
+ * Can be used to check if the account with one of the following factory addresses
+ * to not support 1271 signing.
+ *
+ * Light accounts with versions v1.0.1 and v1.0.2 do not support 1271 signing.
+ *
+ */
+export const LightAccountUnsupported1271Factories = new Set(
+  LightAccountUnsupported1271Impls.map((x) =>
+    Object.values(x.address).map((addr) => addr.factory)
+  ).flat()
+);
+
+/**
+ * Get the light account version definition for the given light account and chain
+ *
+ * @template {LightAccountBase} TAccount
+ * @template {GetLightAccountType<TAccount>} TLightAccountType
+ * @template {GetLightAccountVersion<TLightAccountType>} TLightAccountVersion
+ * @param account - the light account to get the version for
+ * @param chain - the chain to get the version for
+ * @returns the light account version definition for the given light account and chain
+ */
+export async function getLightAccountVersionDef<
+  TAccount extends LightAccountBase,
+  TLightAccountType extends GetLightAccountType<TAccount> = GetLightAccountType<TAccount>,
+  TLightAccountVersion extends GetLightAccountVersion<TLightAccountType> = GetLightAccountVersion<TLightAccountType>
+>(
+  account: TAccount,
+  chain: Chain
+): Promise<LightAccountVersionDef<TLightAccountType, TLightAccountVersion>>;
+
+/**
+ * Get the light account version definition for the given light account and chain
+ *
+ * @template {LightAccountBase} TAccount
+ * @template {GetLightAccountType<TAccount>} TLightAccountType
+ * @param account - the light account to get the version for
+ * @param chain - the chain to get the version for
+ * @returns the light account version definition for the given light account and chain
+ */
+export async function getLightAccountVersionDef<
+  TAccount extends LightAccountBase,
+  TLightAccountType extends GetLightAccountType<TAccount> = GetLightAccountType<TAccount>
+>(
+  account: TAccount,
+  chain: Chain
+): Promise<
+  AccountVersionDef<
+    TLightAccountType,
+    GetLightAccountVersion<TLightAccountType>
+  >
+>;
+
+/**
+ * Get the light account version definition for the given light account and chain
+ *
+ * @template {LightAccountBase} TAccount
+ * @param account - the light account to get the version for
+ * @param chain - the chain to get the version for
+ * @returns the light account version definition for the given light account and chain
+ */
+export async function getLightAccountVersionDef<
+  TAccount extends LightAccountBase
+>(account: TAccount, chain: Chain): Promise<AccountVersionDef> {
+  const accountType = account.source as LightAccountType;
+  const factoryAddress = await account.getFactoryAddress();
+  const implAddress = await account.getImplementationAddress();
+  const implToVersion = new Map(
+    Object.entries(AccountVersionRegistry[accountType])
+      .map((pair) => {
+        const [version, def] = pair as [
+          GetLightAccountVersionFromAccount<TAccount>,
+          LightAccountVersionDef
+        ];
+        return chain.id in def.address
+          ? [def.address[chain.id].impl, version]
+          : [null, version];
+      })
+      .filter(([impl]) => impl !== null) as [
+      Address,
+      keyof IAccountVersionRegistry[typeof accountType]
+    ][]
+  );
+
+  const factoryToVersion = new Map(
+    Object.entries(AccountVersionRegistry[accountType])
+      .map((pair) => {
+        const [version, def] = pair as [
+          keyof IAccountVersionRegistry[typeof accountType],
+          LightAccountVersionDef
+        ];
+        return chain.id in def.address
+          ? [def.address[chain.id].factory, version]
+          : [null, version];
+      })
+      .filter(([impl]) => impl !== null) as [
+      Address,
+      keyof IAccountVersionRegistry[typeof accountType]
+    ][]
+  );
+
+  const version =
+    fromHex(implAddress, "bigint") === 0n
+      ? factoryToVersion.get(factoryAddress.toLowerCase() as Address)
+      : implToVersion.get(implAddress.toLowerCase() as Address);
+
+  if (!version) {
+    throw new Error(
+      `Could not determine ${account.source} version for chain ${chain.id}`
+    );
+  }
+
+  return AccountVersionRegistry[accountType][version];
+}
+
+/**
+ * @param account - the light account to get the version for
+ * @param chain - the chain to get the version for
+ *
+ * @deprecated don't use this function as this function is replaced with getLightAccountVersionDef.
+ *             Migrate to using getLightAccountVersionDef instead
+ *
+ * @returns the light account version for the given light account and chain
+ */
+export async function getLightAccountVersion<
+  TAccount extends LightAccountBase,
+  TLightAccountType extends GetLightAccountType<TAccount> = GetLightAccountType<TAccount>
+>(
+  account: TAccount,
+  chain?: Chain
+): Promise<GetLightAccountVersion<TLightAccountType>>;
+
+/**
+ * Get the light account version for the given light account and chain
+ *
+ * @deprecated don't use this function as this function is replaced with getLightAccountVersionDef.
+ *
+ * @param account - the light account to get the version for
+ * @param chain - the chain to get the version for
+ * @returns the light account version for the given light account and chain
+ */
+export async function getLightAccountVersion(
+  account: LightAccountBase,
+  chain: Chain = supportedChains[0]
+): Promise<LightAccountVersion> {
+  return (await getLightAccountVersionDef(account, chain)).version;
+}

package/src/msca/abis/IAccountLoupe.ts

@@ -0,0 +1,78 @@
+export const IAccountLoupeAbi = [
+  {
+    type: "function",
+    name: "getExecutionFunctionConfig",
+    inputs: [{ name: "selector", type: "bytes4", internalType: "bytes4" }],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct IAccountLoupe.ExecutionFunctionConfig",
+        components: [
+          { name: "plugin", type: "address", internalType: "address" },
+          {
+            name: "userOpValidationFunction",
+            type: "bytes21",
+            internalType: "FunctionReference",
+          },
+          {
+            name: "runtimeValidationFunction",
+            type: "bytes21",
+            internalType: "FunctionReference",
+          },
+        ],
+      },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getExecutionHooks",
+    inputs: [{ name: "selector", type: "bytes4", internalType: "bytes4" }],
+    outputs: [
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct IAccountLoupe.ExecutionHooks[]",
+        components: [
+          {
+            name: "preExecHook",
+            type: "bytes21",
+            internalType: "FunctionReference",
+          },
+          {
+            name: "postExecHook",
+            type: "bytes21",
+            internalType: "FunctionReference",
+          },
+        ],
+      },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getInstalledPlugins",
+    inputs: [],
+    outputs: [{ name: "", type: "address[]", internalType: "address[]" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getPreValidationHooks",
+    inputs: [{ name: "selector", type: "bytes4", internalType: "bytes4" }],
+    outputs: [
+      {
+        name: "preUserOpValidationHooks",
+        type: "bytes21[]",
+        internalType: "FunctionReference[]",
+      },
+      {
+        name: "preRuntimeValidationHooks",
+        type: "bytes21[]",
+        internalType: "FunctionReference[]",
+      },
+    ],
+    stateMutability: "view",
+  },
+] as const;