@zerodev/sdk 4.6.1 → 5.0.0

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

@@ -1,129 +0,0 @@
-import {
-  type AbiParameter,
-  type AbiParameterKind,
-  type AbiParameterToPrimitiveType,
-  type AbiFunction,
-  type ExtractAbiFunction,
-} from "abitype";
-import { type Pretty } from "abitype/src/types.js";
-import type {
-  ECDSAValidator,
-  ECDSAValidatorParams,
-} from "./ecdsa-validator.js";
-import type {
-  ERC165SessionKeyValidator,
-  ERC165SessionKeyValidatorParams,
-} from "./erc165-session-key-validator.js";
-
-import type {
-  KillSwitchValidator,
-  KillSwitchValidatorParams,
-} from "./kill-switch-validator.js";
-import type {
-  RecoveryValidator,
-  RecoveryValidatorParams,
-} from "./recovery-validator.js";
-import type {
-  SessionKeyValidator,
-  SessionKeyValidatorParams,
-  ParamRules,
-  Permission,
-  SessionKeyData,
-  SessionKeyParams,
-  ParamOperator,
-} from "./session-key-validator.js";
-import type { Abi, InferFunctionName, Narrow } from "viem";
-
-export type SupportedValidators =
-  | "ECDSA"
-  | "KILL_SWITCH"
-  | "ERC165_SESSION_KEY"
-  | "SESSION_KEY"
-  | "RECOVERY";
-
-export type ValidatorTypeMap = {
-  ECDSA: ECDSAValidator;
-  KILL_SWITCH: KillSwitchValidator;
-  ERC165_SESSION_KEY: ERC165SessionKeyValidator;
-  SESSION_KEY: SessionKeyValidator;
-  RECOVERY: RecoveryValidator;
-};
-
-export type ValidatorParamsMap = {
-  ECDSA: ECDSAValidatorParams;
-  KILL_SWITCH: KillSwitchValidatorParams;
-  ERC165_SESSION_KEY: ERC165SessionKeyValidatorParams;
-  SESSION_KEY: SessionKeyValidatorParams;
-  RECOVERY: RecoveryValidatorParams;
-};
-
-export type ValidatorMap = {
-  [V in SupportedValidators]: new (
-    params: ValidatorParamsMap[V]
-  ) => ValidatorTypeMap[V];
-};
-
-export type EthereumProvider = { request(...args: any): Promise<any> };
-
-export type { ParamRules, Permission, SessionKeyData, SessionKeyParams };
-
-// Session Key types
-export type AbiParametersToPrimitiveTypes<
-  TAbiParameters extends readonly AbiParameter[],
-  TAbiParameterKind extends AbiParameterKind = AbiParameterKind
-> = Pretty<{
-  [K in keyof TAbiParameters]: AbiParameterToPrimitiveType<
-    TAbiParameters[K],
-    TAbiParameterKind
-  >;
-}>;
-
-export type AbiParametersToConditons<
-  TAbiParameters extends readonly AbiParameter[]
-> = Pretty<{
-  [K in keyof TAbiParameters]: ParamOperator;
-}>;
-
-export type CombinedArgs<
-  TAbiParameters extends readonly AbiParameter[],
-  TAbiParameterKind extends AbiParameterKind = AbiParameterKind
-> = {
-  [K in keyof TAbiParameters]: {
-    operator: ParamOperator;
-    value: AbiParameterToPrimitiveType<TAbiParameters[K], TAbiParameterKind>;
-  } | null;
-};
-
-export type GetFunctionArgs<
-  TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string,
-  TAbiFunction extends AbiFunction = TAbi extends Abi
-    ? ExtractAbiFunction<TAbi, TFunctionName>
-    : AbiFunction,
-  TArgs = CombinedArgs<TAbiFunction["inputs"]>,
-  FailedToParseArgs =
-    | ([TArgs] extends [never] ? true : false)
-    | (readonly unknown[] extends TArgs ? true : false)
-> = true extends FailedToParseArgs
-  ? {
-      args?: readonly unknown[];
-    }
-  : TArgs extends readonly []
-  ? { args?: never }
-  : {
-      args?: TArgs;
-    };
-
-export type GeneratePermissionFromArgsParameters<
-  TAbi extends Abi | readonly unknown[],
-  TFunctionName extends string | undefined = string,
-  _FunctionName = TAbi extends Abi
-    ? InferFunctionName<TAbi, TFunctionName>
-    : never
-> = Pick<Permission, "target" | "valueLimit" | "operation"> & {
-  functionName?: _FunctionName;
-} & (TFunctionName extends string
-    ? { abi: Narrow<TAbi> } & GetFunctionArgs<TAbi, TFunctionName>
-    : _FunctionName extends string
-    ? { abi: [Narrow<TAbi[number]>] } & GetFunctionArgs<TAbi, _FunctionName>
-    : never);

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

@@ -1,178 +0,0 @@
-import { type Hex, type SendUserOperationResult } 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;
-  bundlerProvider?: PaymasterAndBundlerProviders;
-  opts?: ValidatorProviderParamsOpts<P>;
-  usePaymaster?: boolean;
-  defaultProvider?: ValidatorProvider<
-    KernelBaseValidator,
-    KernelBaseValidatorParams
-  >;
-}
-
-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<
-  V extends KernelBaseValidator,
-  P extends KernelBaseValidatorParams
-> extends ZeroDevProvider {
-  protected defaultProvider?: ValidatorProvider<
-    KernelBaseValidator,
-    KernelBaseValidatorParams
-  >;
-  constructor(
-    params: ExtendedValidatorProviderParams<P>,
-    validator: KernelBaseValidator
-  ) {
-    let bundlerProvider = params.bundlerProvider;
-    const shouldUsePaymaster =
-      (params.usePaymaster === undefined || params.usePaymaster) &&
-      bundlerProvider !== "GELATO";
-    if (
-      params.opts?.paymasterConfig &&
-      params.opts?.paymasterConfig.policy === "TOKEN_PAYMASTER" &&
-      shouldUsePaymaster
-    ) {
-      bundlerProvider = "STACKUP";
-    }
-    super({
-      ...params.opts?.providerConfig,
-      chain: params.opts?.providerConfig?.chain ?? polygonMumbai,
-      rpcUrl: params.opts?.providerConfig?.rpcUrl,
-      projectId: params.projectId,
-      bundlerProvider,
-    });
-    this.defaultProvider = params.defaultProvider;
-    if (
-      (typeof params.opts?.providerConfig?.chain === "number" &&
-        typeof params.defaultProvider?.chain === "number" &&
-        params.opts?.providerConfig?.chain !== params.defaultProvider?.chain) ||
-      (typeof params.opts?.providerConfig?.chain === "object" &&
-        typeof params.defaultProvider?.chain === "object" &&
-        params.opts?.providerConfig?.chain.id !==
-          params.defaultProvider?.chain.id)
-    ) {
-      throw new Error(
-        "chainId mismatch between default provider and current provider - check projectIds"
-      );
-    }
-    this.connect(
-      () =>
-        new KernelSmartContractAccount({
-          projectId: params.projectId,
-          validator,
-          defaultValidator: params.defaultProvider?.getValidator(),
-          rpcClient: this.rpcClient,
-          bundlerProvider,
-          index: params.defaultProvider?.getAccount().getIndex(),
-          ...params.opts?.accountConfig,
-        })
-    );
-    if (shouldUsePaymaster) {
-      let paymasterConfig = params.opts?.paymasterConfig ?? {
-        policy: "VERIFYING_PAYMASTER",
-      };
-      paymasterConfig = {
-        ...paymasterConfig,
-        paymasterProvider:
-          params.opts?.paymasterConfig?.paymasterProvider ?? bundlerProvider,
-      };
-      withZeroDevPaymasterAndData(this, paymasterConfig);
-    }
-  }
-
-  getValidator = (): V => {
-    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() as unknown as V;
-  };
-
-  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 = "0x"): 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 = "0x"
-  ): 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?"
-      );
-    }
-    if (!this.defaultProvider) {
-      throw Error("Default Validator provider unintialized");
-    }
-
-    return await this.defaultProvider.sendUserOperation({
-      target: this.account.validator.validatorAddress,
-      data: encodedDisableData,
-    });
-  };
-}

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

@@ -1,65 +0,0 @@
-import {
-  ValidatorProvider,
-  type ExtendedValidatorProviderParams,
-} from "./base.js";
-import {
-  ECDSAValidator,
-  type ECDSAValidatorParams,
-} from "../validator/ecdsa-validator.js";
-import { getChainId } from "../api/index.js";
-import { polygonMumbai } from "viem/chains";
-import { getChain } from "../utils.js";
-
-export class ECDSAProvider extends ValidatorProvider<
-  ECDSAValidator,
-  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,
-      rpcUrl: params.opts?.providerConfig?.rpcUrl,
-      ...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

@@ -1,72 +0,0 @@
-import {
-  ValidatorProvider,
-  type ExtendedValidatorProviderParams,
-} from "./base.js";
-import {
-  ERC165SessionKeyValidator,
-  type ERC165SessionKeyValidatorParams,
-} from "../validator/erc165-session-key-validator.js";
-import { getChainId } from "../api/index.js";
-import { polygonMumbai } from "viem/chains";
-import { ERC165_SESSION_KEY_VALIDATOR_ADDRESS } from "../constants.js";
-import { getChain } from "../utils.js";
-
-export class ERC165SessionKeyProvider extends ValidatorProvider<
-  ERC165SessionKeyValidator,
-  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,
-      rpcUrl: params.opts?.providerConfig?.rpcUrl,
-      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

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

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

@@ -1,72 +0,0 @@
-import {
-  ValidatorProvider,
-  type ExtendedValidatorProviderParams,
-} from "./base.js";
-import {
-  KillSwitchValidator,
-  type KillSwitchValidatorParams,
-} from "../validator/kill-switch-validator.js";
-import { getChainId } from "../api/index.js";
-import { polygonMumbai } from "viem/chains";
-import { KILL_SWITCH_VALIDATOR_ADDRESS } from "../constants.js";
-import { getChain } from "../utils.js";
-
-export class KillSwitchProvider extends ValidatorProvider<
-  KillSwitchValidator,
-  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,
-      rpcUrl: params.opts?.providerConfig?.rpcUrl,
-      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;
-}