@zerodev/sdk 4.0.0

package/src/kernel-zerodev/validator-provider/base.ts

@@ -0,0 +1,140 @@
+import {
+  type Hex,
+  type SendUserOperationResult,
+  type SmartAccountSigner,
+} from "@alchemy/aa-core";
+import { ZeroDevProvider, type ZeroDevProviderConfig } from "../provider.js";
+import type {
+  KernelBaseValidator,
+  KernelBaseValidatorParams,
+} from "../validator/base.js";
+import type {
+  PaymasterAndBundlerProviders,
+  PaymasterConfig,
+  PaymasterPolicy,
+} from "../paymaster/types.js";
+import {
+  KernelSmartContractAccount,
+  type KernelSmartAccountParams,
+  isKernelAccount,
+} from "../account.js";
+import { polygonMumbai } from "viem/chains";
+import { withZeroDevPaymasterAndData } from "../middleware/paymaster.js";
+import type { RequiredProps } from "../types.js";
+
+export type ValidatorProviderParamsOpts<P extends KernelBaseValidatorParams> = {
+  paymasterConfig?: PaymasterConfig<PaymasterPolicy>;
+  providerConfig?: Partial<ZeroDevProviderConfig>;
+  accountConfig?: Omit<
+    KernelSmartAccountParams,
+    keyof ExtendedValidatorProviderParams<P>
+  >;
+  validatorConfig?: Omit<P, keyof ExtendedValidatorProviderParams<P>>;
+};
+
+export interface ValidatorProviderParams<P extends KernelBaseValidatorParams> {
+  projectId: string;
+  owner: SmartAccountSigner;
+  bundlerProvider?: PaymasterAndBundlerProviders;
+  opts?: ValidatorProviderParamsOpts<P>;
+  usePaymaster?: boolean;
+}
+
+export type ExtendedValidatorProviderParams<
+  P extends KernelBaseValidatorParams
+> = ValidatorProviderParams<P> & RequiredProps<P>;
+
+// A simple facade abstraction for validator related provider operations
+// Needs to be implemented for each validator plugin
+export abstract class ValidatorProvider<
+  P extends KernelBaseValidatorParams
+> extends ZeroDevProvider {
+  constructor(
+    params: ExtendedValidatorProviderParams<P>,
+    validator: KernelBaseValidator
+  ) {
+    super({
+      ...params.opts?.providerConfig,
+      chain: params.opts?.providerConfig?.chain ?? polygonMumbai,
+      rpcUrl: params.opts?.providerConfig?.rpcUrl,
+      projectId: params.projectId,
+      bundlerProvider: params.bundlerProvider,
+    });
+    this.connect(
+      () =>
+        new KernelSmartContractAccount({
+          projectId: params.projectId,
+          owner: params.owner,
+          validator,
+          rpcClient: this.rpcClient,
+          bundlerProvider: params.bundlerProvider,
+          ...params.opts?.accountConfig,
+        })
+    );
+    if (params.usePaymaster === undefined || params.usePaymaster) {
+      withZeroDevPaymasterAndData(
+        this,
+        params.opts?.paymasterConfig ?? { policy: "VERIFYING_PAYMASTER" }
+      );
+    }
+  }
+
+  getValidator = (): KernelBaseValidator => {
+    if (!isKernelAccount(this.account) || !this.account.validator) {
+      throw new Error(
+        "ValidatorProvider: account with validator is not set, did you call all connects first?"
+      );
+    }
+    return this.account.getValidator();
+  };
+
+  getEncodedEnableData = async (enableData: Hex): Promise<Hex> => {
+    if (!isKernelAccount(this.account) || !this.account.validator) {
+      throw new Error(
+        "ValidatorProvider: account with validator is not set, did you call all connects first?"
+      );
+    }
+    return await this.account.validator.encodeEnable(enableData);
+  };
+
+  getEncodedDisableData = async (disableData: Hex): Promise<Hex> => {
+    if (!isKernelAccount(this.account) || !this.account.validator) {
+      throw new Error(
+        "ValidatorProvider: account with validator is not set, did you call all connects first?"
+      );
+    }
+    return await this.account.validator.encodeDisable(disableData);
+  };
+
+  sendEnableUserOperation = async (
+    enableData: Hex
+  ): Promise<SendUserOperationResult> => {
+    const encodedEnableData = await this.getEncodedEnableData(enableData);
+    if (!isKernelAccount(this.account) || !this.account.validator) {
+      throw new Error(
+        "ValidatorProvider: account with validator is not set, did you call all connects first?"
+      );
+    }
+
+    return await this.sendUserOperation({
+      target: this.account.validator.validatorAddress,
+      data: encodedEnableData,
+    });
+  };
+
+  sendDisableUserOperation = async (
+    disableData: Hex
+  ): Promise<SendUserOperationResult> => {
+    const encodedDisableData = await this.getEncodedDisableData(disableData);
+    if (!isKernelAccount(this.account) || !this.account.validator) {
+      throw new Error(
+        "ValidatorProvider: account with validator is not set, did you call all connects first?"
+      );
+    }
+
+    return await this.sendUserOperation({
+      target: this.account.validator.validatorAddress,
+      data: encodedDisableData,
+    });
+  };
+}

package/src/kernel-zerodev/validator-provider/ecdsa-provider.ts

@@ -0,0 +1,61 @@
+import {
+  ValidatorProvider,
+  type ExtendedValidatorProviderParams,
+} from "./base.js";
+import {
+  ECDSAValidator,
+  type ECDSAValidatorParams,
+} from "../validator/ecdsa-validator.js";
+import { getChain } from "@alchemy/aa-core";
+import { getChainId } from "../api/index.js";
+import { polygonMumbai } from "viem/chains";
+
+export class ECDSAProvider extends ValidatorProvider<ECDSAValidatorParams> {
+  constructor(params: ExtendedValidatorProviderParams<ECDSAValidatorParams>) {
+    const chain =
+      typeof params.opts?.providerConfig?.chain === "number"
+        ? getChain(params.opts.providerConfig.chain)
+        : params.opts?.providerConfig?.chain ?? polygonMumbai;
+    const validator = new ECDSAValidator({
+      projectId: params.projectId,
+      owner: params.owner,
+      chain,
+      ...params.opts?.validatorConfig,
+    });
+    super(
+      {
+        ...params,
+        opts: {
+          ...params.opts,
+          providerConfig: { ...params.opts?.providerConfig, chain },
+        },
+      },
+      validator
+    );
+  }
+
+  public static async init(
+    params: ExtendedValidatorProviderParams<ECDSAValidatorParams>
+  ): Promise<ECDSAProvider> {
+    const chainId = await getChainId(params.projectId);
+    if (!chainId) {
+      throw new Error("ChainId not found");
+    }
+    const chain = getChain(chainId);
+    const instance = new ECDSAProvider({
+      ...params,
+      opts: {
+        ...params.opts,
+        providerConfig: {
+          chain,
+          ...params.opts?.providerConfig,
+        },
+      },
+    });
+    return instance;
+  }
+
+  changeOwner = this.sendEnableUserOperation;
+
+  deleteOwner = this.sendDisableUserOperation;
+}

package/src/kernel-zerodev/validator-provider/erc165-session-key-provider.ts

@@ -0,0 +1,68 @@
+import {
+  ValidatorProvider,
+  type ExtendedValidatorProviderParams,
+} from "./base.js";
+import {
+  ERC165SessionKeyValidator,
+  type ERC165SessionKeyValidatorParams,
+} from "../validator/erc165-session-key-validator.js";
+import { getChain } from "@alchemy/aa-core";
+import { getChainId } from "../api/index.js";
+import { polygonMumbai } from "viem/chains";
+import { ERC165_SESSION_KEY_VALIDATOR_ADDRESS } from "../constants.js";
+
+export class ERC165SessionKeyProvider extends ValidatorProvider<ERC165SessionKeyValidatorParams> {
+  constructor(
+    params: ExtendedValidatorProviderParams<ERC165SessionKeyValidatorParams>
+  ) {
+    const chain =
+      typeof params.opts?.providerConfig?.chain === "number"
+        ? getChain(params.opts.providerConfig.chain)
+        : params.opts?.providerConfig?.chain ?? polygonMumbai;
+    const validator = new ERC165SessionKeyValidator({
+      projectId: params.projectId,
+      sessionKey: params.sessionKey,
+      sessionKeyData: params.sessionKeyData,
+      chain,
+      validatorAddress:
+        params.opts?.validatorConfig?.validatorAddress ??
+        ERC165_SESSION_KEY_VALIDATOR_ADDRESS,
+      ...params.opts?.validatorConfig,
+    });
+    super(
+      {
+        ...params,
+        opts: {
+          ...params.opts,
+          providerConfig: { ...params.opts?.providerConfig, chain },
+        },
+      },
+      validator
+    );
+  }
+
+  public static async init(
+    params: ExtendedValidatorProviderParams<ERC165SessionKeyValidatorParams>
+  ): Promise<ERC165SessionKeyProvider> {
+    const chainId = await getChainId(params.projectId);
+    if (!chainId) {
+      throw new Error("ChainId not found");
+    }
+    const chain = getChain(chainId);
+    const instance = new ERC165SessionKeyProvider({
+      ...params,
+      opts: {
+        ...params.opts,
+        providerConfig: {
+          chain,
+          ...params.opts?.providerConfig,
+        },
+      },
+    });
+    return instance;
+  }
+
+  changeGuardian = this.sendEnableUserOperation;
+
+  deleteERC165SessionKeyData = this.sendDisableUserOperation;
+}

package/src/kernel-zerodev/validator-provider/index.ts

@@ -0,0 +1,12 @@
+import { ECDSAProvider } from "./ecdsa-provider.js";
+import { ERC165SessionKeyProvider } from "./erc165-session-key-provider.js";
+import { KillSwitchProvider } from "./kill-switch-provider.js";
+import type { ValidatorProviderMap } from "./types.js";
+
+export const ValidatorProviders: ValidatorProviderMap = {
+  ECDSA: ECDSAProvider,
+  KILL_SWITCH: KillSwitchProvider,
+  ERC165_SESSION_KEY: ERC165SessionKeyProvider,
+};
+
+export { ECDSAProvider, KillSwitchProvider, ERC165SessionKeyProvider };

package/src/kernel-zerodev/validator-provider/kill-switch-provider.ts

@@ -0,0 +1,68 @@
+import {
+  ValidatorProvider,
+  type ExtendedValidatorProviderParams,
+} from "./base.js";
+import {
+  KillSwitchValidator,
+  type KillSwitchValidatorParams,
+} from "../validator/kill-switch-validator.js";
+import { getChain } from "@alchemy/aa-core";
+import { getChainId } from "../api/index.js";
+import { polygonMumbai } from "viem/chains";
+import { KILL_SWITCH_VALIDATOR_ADDRESS } from "../constants.js";
+
+export class KillSwitchProvider extends ValidatorProvider<KillSwitchValidatorParams> {
+  constructor(
+    params: ExtendedValidatorProviderParams<KillSwitchValidatorParams>
+  ) {
+    const chain =
+      typeof params.opts?.providerConfig?.chain === "number"
+        ? getChain(params.opts.providerConfig.chain)
+        : params.opts?.providerConfig?.chain ?? polygonMumbai;
+    const validator = new KillSwitchValidator({
+      projectId: params.projectId,
+      guardian: params.guardian,
+      delaySeconds: params.delaySeconds,
+      chain,
+      validatorAddress:
+        params.opts?.validatorConfig?.validatorAddress ??
+        KILL_SWITCH_VALIDATOR_ADDRESS,
+      ...params.opts?.validatorConfig,
+    });
+    super(
+      {
+        ...params,
+        opts: {
+          ...params.opts,
+          providerConfig: { ...params.opts?.providerConfig, chain },
+        },
+      },
+      validator
+    );
+  }
+
+  public static async init(
+    params: ExtendedValidatorProviderParams<KillSwitchValidatorParams>
+  ): Promise<KillSwitchProvider> {
+    const chainId = await getChainId(params.projectId);
+    if (!chainId) {
+      throw new Error("ChainId not found");
+    }
+    const chain = getChain(chainId);
+    const instance = new KillSwitchProvider({
+      ...params,
+      opts: {
+        ...params.opts,
+        providerConfig: {
+          chain,
+          ...params.opts?.providerConfig,
+        },
+      },
+    });
+    return instance;
+  }
+
+  changeGuardian = this.sendEnableUserOperation;
+
+  deleteKillSwitchData = this.sendDisableUserOperation;
+}

package/src/kernel-zerodev/validator-provider/types.ts

@@ -0,0 +1,26 @@
+import type { ECDSAValidatorParams } from "../validator/ecdsa-validator.js";
+import type { ERC165SessionKeyValidatorParams } from "../validator/erc165-session-key-validator.js";
+import type { KillSwitchValidatorParams } from "../validator/kill-switch-validator.js";
+import type { SupportedValidators } from "../validator/types.js";
+import type { ExtendedValidatorProviderParams } from "./base.js";
+import type { ECDSAProvider } from "./ecdsa-provider.js";
+import type { ERC165SessionKeyProvider } from "./erc165-session-key-provider.js";
+import type { KillSwitchProvider } from "./kill-switch-provider.js";
+
+export type ValidatorProviderTypeMap = {
+  ECDSA: ECDSAProvider;
+  KILL_SWITCH: KillSwitchProvider;
+  ERC165_SESSION_KEY: ERC165SessionKeyProvider;
+};
+
+export type ValidatorProviderParamsMap = {
+  ECDSA: ExtendedValidatorProviderParams<ECDSAValidatorParams>;
+  KILL_SWITCH: ExtendedValidatorProviderParams<KillSwitchValidatorParams>;
+  ERC165_SESSION_KEY: ExtendedValidatorProviderParams<ERC165SessionKeyValidatorParams>;
+};
+
+export type ValidatorProviderMap = {
+  [V in SupportedValidators]: new (
+    params: ValidatorProviderParamsMap[V]
+  ) => ValidatorProviderTypeMap[V];
+};