@alchemy/smart-accounts 0.0.0-alpha.0

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@alchemy/smart-accounts",
+  "version": "0.0.0-alpha.0",
+  "description": "This package contains all of the viem interfaces for Alchemy's Smart Contract Accounts",
+  "author": "Alchemy",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "main": "./dist/esm/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src/**/*.ts",
+    "!dist/**/*.tsbuildinfo",
+    "!vitest.config.ts",
+    "!.env",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/__tests__/**/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "prebuild": "tsx ./inject-version.ts",
+    "build": "yarn clean && yarn build:esm && yarn build:types",
+    "build:esm": "tsc --project tsconfig.build.json --outDir ./dist/esm",
+    "build:types": "tsc --project tsconfig.build.json --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "clean": "rm -rf ./dist",
+    "test": "vitest",
+    "test:run": "vitest run"
+  },
+  "devDependencies": {
+    "@alchemy/aa-infra": "0.0.0-alpha.0",
+    "typescript-template": "*"
+  },
+  "dependencies": {
+    "@alchemy/common": "0.0.0-alpha.0",
+    "ox": "^0.9.6",
+    "viem": "^2.32.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alchemyplatform/aa-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/alchemyplatform/aa-sdk/issues"
+  },
+  "homepage": "https://github.com/alchemyplatform/aa-sdk#readme",
+  "gitHead": "c0301f7bb5f4499fe35b5850293be6170057fae6"
+}

package/src/errors/EntityIdOverrideError.ts

@@ -0,0 +1,15 @@
+import { BaseError } from "@alchemy/common";
+
+/**
+ * Error class denoting that the provided entity id is invalid because it's overriding the native entity id.
+ */
+export class EntityIdOverrideError extends BaseError {
+  override name = "EntityIdOverrideError";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that the nonce key is invalid.
+   */
+  constructor() {
+    super(`EntityId of 0 is reserved for the owner and cannot be used`);
+  }
+}

package/src/errors/InvalidDeferredActionNonceError.ts

@@ -0,0 +1,15 @@
+import { BaseError } from "@alchemy/common";
+
+/**
+ * Error class denoting that the deferred action nonce used is invalid.
+ */
+export class InvalidDeferredActionNonceError extends BaseError {
+  override name = "InvalidDeferredActionNonce";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that the provided deferred action nonce is invalid.
+   */
+  constructor() {
+    super(`The provided deferred action nonce is invalid`);
+  }
+}

package/src/errors/InvalidEntityIdError.ts

@@ -0,0 +1,19 @@
+import { BaseError } from "@alchemy/common";
+
+/**
+ * Error class denoting that the provided entity id is invalid because it's too large.
+ */
+export class InvalidEntityIdError extends BaseError {
+  override name = "InvalidEntityIdError";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that the entity id is invalid because it's too large.
+   *
+   * @param {number} entityId the invalid entityId used
+   */
+  constructor(entityId: number) {
+    super(
+      `Entity ID used is ${entityId}, but must be less than or equal to uint32.max`,
+    );
+  }
+}

package/src/errors/InvalidNonceKeyError.ts

@@ -0,0 +1,19 @@
+import { BaseError } from "@alchemy/common";
+
+/**
+ * Error class denoting that the nonce key is invalid because its too large.
+ */
+export class InvalidNonceKeyError extends BaseError {
+  override name = "InvalidNonceKeyError";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that the nonce key is invalid.
+   *
+   * @param {bigint} nonceKey the invalid nonceKey used
+   */
+  constructor(nonceKey: bigint) {
+    super(
+      `Nonce key is ${nonceKey} but has to be less than or equal to 2**152`,
+    );
+  }
+}

package/src/errors/InvalidOwnerError.ts

@@ -0,0 +1,17 @@
+import { BaseError } from "@alchemy/common";
+
+/**
+ * Error class denoting that the owner for an account is invalid
+ */
+export class InvalidOwnerError extends BaseError {
+  override name = "InvalidOwnerError";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that the owner is invalid
+   *
+   * @param {string} reason the reason the owner is invalid
+   */
+  constructor(reason: string) {
+    super(`Owner is invalid (${reason}).`);
+  }
+}

package/src/errors/permissionBuilderErrors.ts

@@ -0,0 +1,212 @@
+import { BaseError } from "@alchemy/common";
+import type { Permission } from "../ma-v2/permissionBuilder.js";
+import type { Address } from "viem";
+
+/**
+ * Abstract class representing a Permission Builder Error, subclassed by all permission builder errors.
+ */
+export abstract class PermissionBuilderError extends BaseError {}
+
+/**
+ * Error class for when a root permission is added to a permission builder.
+ */
+export class RootPermissionOnlyError extends PermissionBuilderError {
+  override name = "PermissionBuilder: RootPermissionOnlyError";
+
+  /**
+   * Constructor for initializing an error message indicating that the root permission cannot be combined with other permissions.
+   *
+   * @param {Permission} permission The permission trying to be added atop the root permission
+   */
+  constructor(permission: Permission) {
+    super(
+      `Adding ${permission.type}: Cannot add permissions with ROOT permission`,
+    );
+  }
+}
+
+/**
+ * Error class for when an account address is used as target.
+ */
+export class AccountAddressAsTargetError extends PermissionBuilderError {
+  override name = "PermissionBuilder: AccountAddressAsTargetError";
+
+  /**
+   * Constructor for initializing an error message indicating that account address is used as target.
+   *
+   * @param {Permission} permission The permission with account address as target
+   */
+  constructor(permission: Permission) {
+    super(
+      `${permission.type}: Account address as target, use ACCOUNT_FUNCTIONS for account address`,
+    );
+  }
+}
+
+/**
+ * Error class for when a duplicate target address is added to a permission builder.
+ */
+export class DuplicateTargetAddressError extends PermissionBuilderError {
+  override name = "PermissionBuilder: DuplicateTargetAddressError";
+
+  /**
+   * Constructor for initializing an error message indicating duplicate target address in permissions.
+   *
+   * @param {Permission} permission The permission with duplicate target address
+   * @param {Address} targetAddress The duplicate target address
+   */
+  constructor(permission: Permission, targetAddress: Address) {
+    super(
+      `${permission.type}: Address ${targetAddress} already has a permission. Cannot add multiple CONTRACT_ACCESS or FUNCTIONS_ON_CONTRACT permissions for the same target address.`,
+    );
+  }
+}
+
+/**
+ * Error class for when no functions are provided to a permission builder.
+ */
+export class NoFunctionsProvidedError extends PermissionBuilderError {
+  override name = "PermissionBuilder: NoFunctionsProvidedError";
+
+  /**
+   * Constructor for initializing an error message indicating no functions were provided.
+   *
+   * @param {Permission} permission The permission missing functions
+   */
+  constructor(permission: Permission) {
+    super(`${permission.type}: No functions provided`);
+  }
+}
+
+/**
+ * Error class for when a deadline is expired.
+ */
+export class ExpiredDeadlineError extends PermissionBuilderError {
+  override name = "PermissionBuilder: ExpiredDeadlineError";
+
+  /**
+   * Constructor for initializing an error message indicating the deadline has expired.
+   *
+   * @param {number} deadline The expired deadline timestamp
+   * @param {number} currentTime The current timestamp
+   */
+  constructor(deadline: number, currentTime: number) {
+    super(
+      `compileDeferred(): deadline ${deadline} cannot be before now (${currentTime})`,
+    );
+  }
+}
+
+/**
+ * Error class for when a deadline is over the limit.
+ */
+export class DeadlineOverLimitError extends PermissionBuilderError {
+  override name = "PermissionBuilder: DeadlineOverLimitError";
+
+  /**
+   * Constructor for initializing an error message indicating the deadline has expired.
+   *
+   * @param {number} deadline The expired deadline timestamp
+   */
+  constructor(deadline: number) {
+    super(
+      `compileDeferred(): deadline ${deadline} cannot be > max uint48 (2^48 - 1)`,
+    );
+  }
+}
+
+/**
+ * Error class for when a validation config is unset.
+ */
+export class ValidationConfigUnsetError extends PermissionBuilderError {
+  override name = "PermissionBuilder: ValidationConfigUnsetError";
+
+  /**
+   * Constructor for initializing an error message indicating the validation config is unset.
+   */
+  constructor() {
+    super(
+      "Missing permission among: functions on contract, functions on all contracts, account functions, contract access, or erc20 token transfer",
+    );
+  }
+}
+
+/**
+ * Error class for when a multiple native token transfer permission is added to a permission builder.
+ */
+export class MultipleNativeTokenTransferError extends PermissionBuilderError {
+  override name = "PermissionBuilder: MultipleNativeTokenTransferError";
+
+  /**
+   * Constructor for initializing an error message indicating multiple native token transfer permissions.
+   *
+   * @param {Permission} permission The duplicate native token transfer permission
+   */
+  constructor(permission: Permission) {
+    super(
+      `${permission.type}: Must have at most ONE native token transfer permission`,
+    );
+  }
+}
+
+/**
+ * Error class for when a zero address is provided to a permission builder.
+ */
+export class ZeroAddressError extends PermissionBuilderError {
+  override name = "PermissionBuilder: ZeroAddressError";
+
+  /**
+   * Constructor for initializing an error message indicating zero address was provided.
+   *
+   * @param {Permission} permission The permission with zero address
+   */
+  constructor(permission: Permission) {
+    super(`${permission.type}: Zero address provided`);
+  }
+}
+
+/**
+ * Error class for when a multiple gas limit permission is added to a permission builder.
+ */
+export class MultipleGasLimitError extends PermissionBuilderError {
+  override name = "PermissionBuilder: MultipleGasLimitError";
+
+  /**
+   * Constructor for initializing an error message indicating multiple gas limit permissions.
+   *
+   * @param {Permission} permission The duplicate gas limit permission
+   */
+  constructor(permission: Permission) {
+    super(`${permission.type}: Must have at most ONE gas limit permission`);
+  }
+}
+
+/**
+ * Error class for when an unsupported permission type is added to a permission builder.
+ */
+export class UnsupportedPermissionTypeError extends PermissionBuilderError {
+  override name = "PermissionBuilder: UnsupportedPermissionTypeError";
+
+  /**
+   * Constructor for initializing an error message indicating an unsupported permission type.
+   */
+  constructor() {
+    super(`Unsupported permission type`);
+  }
+}
+
+/**
+ * Error class for when a selector is not allowed.
+ */
+export class SelectorNotAllowed extends PermissionBuilderError {
+  override name = "SelectorNotAllowed";
+
+  /**
+   * Constructor for initializing an error message indicating that the selector being added is not allowed.
+   *
+   * @param {string} functionName The function name of the selector that is being added.
+   */
+  constructor(functionName: string) {
+    super(`Cannot add ${functionName} on the account`);
+  }
+}

package/src/index.ts

@@ -0,0 +1,152 @@
+// LightAccount
+export type * from "./light-account/accounts/account.js";
+export { toLightAccount } from "./light-account/accounts/account.js";
+
+export type * from "./light-account/accounts/multi-owner-account.js";
+export { toMultiOwnerLightAccount } from "./light-account/accounts/multi-owner-account.js";
+
+// TODO(v5): Something to consider for v5 - can we cut the exports for the account-specific actions
+// from the public interface, and just consume these internally with account + rely on the standard
+// bundlerClient actions for performing state writes (i.e. rotating owners)? I'm not sure it's useful
+// to consumers outside of attaching to instances of a client with the right action.
+export type * from "./light-account/decorators/singleOwner.js";
+export { singleOwnerLightAccountActions } from "./light-account/decorators/singleOwner.js";
+
+export type * from "./light-account/decorators/multiOwner.js";
+export { multiOwnerLightAccountActions } from "./light-account/decorators/multiOwner.js";
+
+export type * from "./light-account/predictAddress.js";
+export {
+  predictLightAccountAddress,
+  predictMultiOwnerLightAccountAddress,
+} from "./light-account/predictAddress.js";
+
+export { AccountVersionRegistry } from "./light-account/registry.js";
+export type * from "./light-account/registry.js";
+export {
+  defaultLightAccountVersion,
+  getLightAccountImplAddress,
+  LightAccountUnsupported1271Factories,
+  LightAccountUnsupported1271Impls,
+} from "./light-account/utils.js";
+
+export {
+  lightAccountStaticImplV1_0_1,
+  lightAccountStaticImplV1_0_2,
+  lightAccountStaticImplV1_1_0,
+  lightAccountStaticImplV2_0_0,
+  multiOwnerLightAccountStaticImplV2_0_0,
+} from "./light-account/lightAccountStaticImpl.js";
+
+// ModularAccountV1
+export type * from "./ma-v1/accounts/base.js";
+export { toModularAccountV1Base } from "./ma-v1/accounts/base.js";
+
+export type * from "./ma-v1/accounts/multi-owner-account.js";
+export { toMultiOwnerModularAccountV1 } from "./ma-v1/accounts/multi-owner-account.js";
+
+export type * from "./ma-v1/decorators/multiOwner.js";
+export { multiOwnerModularAccountV1Actions } from "./ma-v1/decorators/multiOwner.js";
+
+export type * from "./ma-v1/predictAddress.js";
+export { predictMultiOwnerModularAccountV1Address } from "./ma-v1/predictAddress.js";
+
+export { multiOwnerModularAccountStaticImpl } from "./ma-v1/mav1StaticImpl.js";
+
+export {
+  DefaultMaV1Address,
+  DefaultMaV1PluginAddress,
+} from "./ma-v1/account.js";
+
+// ModularAccountV2
+export type * from "./ma-v2/accounts/account.js";
+export { toModularAccountV2 } from "./ma-v2/accounts/account.js";
+
+export type * from "./ma-v2/accounts/base.js";
+export { toModularAccountV2Base } from "./ma-v2/accounts/base.js";
+
+export type * from "./ma-v2/decorators/deferralActions.js";
+export { deferralActions } from "./ma-v2/decorators/deferralActions.js";
+
+export type * from "./ma-v2/decorators/installValidation.js";
+export { installValidationActions } from "./ma-v2/decorators/installValidation.js";
+
+export {
+  semiModularAccountV2StaticImpl,
+  semiModularAccount7702StaticImpl,
+  webAuthnModularAccountV2StaticImpl,
+} from "./ma-v2/mav2StaticImpl.js";
+export type * from "./ma-v2/mav2StaticImpl.js";
+
+// Modules
+export { AllowlistModule } from "./ma-v2/modules/allowlist-module/module.js";
+export { NativeTokenLimitModule } from "./ma-v2/modules/native-token-limit-module/module.js";
+export { PaymasterGuardModule } from "./ma-v2/modules/paymaster-guard-module/module.js";
+export { SingleSignerValidationModule } from "./ma-v2/modules/single-signer-validation/module.js";
+export { TimeRangeModule } from "./ma-v2/modules/time-range-module/module.js";
+export { WebAuthnValidationModule } from "./ma-v2/modules/webauthn-validation/module.js";
+
+export type * from "./ma-v2/permissionBuilder.js";
+export {
+  PermissionBuilder,
+  PermissionType,
+} from "./ma-v2/permissionBuilder.js";
+
+export type * from "./ma-v2/predictAddress.js";
+export { predictModularAccountV2Address } from "./ma-v2/predictAddress.js";
+
+export type * from "./ma-v2/types.js";
+
+export type * from "./ma-v2/utils/account.js";
+export {
+  DefaultAddress,
+  DefaultModuleAddress,
+  DEFAULT_OWNER_ENTITY_ID,
+  EXECUTE_USER_OP_SELECTOR,
+  getMAV2UpgradeToData,
+  buildFullNonceKey,
+  serializeModuleEntity,
+  isModularAccountV2,
+} from "./ma-v2/utils/account.js";
+
+export type * from "./ma-v2/utils/deferredActions.js";
+export {
+  parseDeferredAction,
+  buildDeferredActionDigest,
+} from "./ma-v2/utils/deferredActions.js";
+
+export type * from "./ma-v2/utils/hooks.js";
+export {
+  serializeValidationConfig,
+  serializeHookConfig,
+} from "./ma-v2/utils/hooks.js";
+
+export type * from "./ma-v2/utils/signature.js";
+export {
+  packUOSignature,
+  pack1271Signature,
+  toReplaySafeTypedData,
+  toWebAuthnSignature,
+} from "./ma-v2/utils/signature.js";
+
+// Errors
+export { EntityIdOverrideError } from "./errors/EntityIdOverrideError.js";
+export { InvalidDeferredActionNonceError } from "./errors/InvalidDeferredActionNonceError.js";
+export { InvalidEntityIdError } from "./errors/InvalidEntityIdError.js";
+export { InvalidNonceKeyError } from "./errors/InvalidNonceKeyError.js";
+export { InvalidOwnerError } from "./errors/InvalidOwnerError.js";
+export {
+  PermissionBuilderError,
+  RootPermissionOnlyError,
+  AccountAddressAsTargetError,
+  DuplicateTargetAddressError,
+  NoFunctionsProvidedError,
+  ExpiredDeadlineError,
+  DeadlineOverLimitError,
+  ValidationConfigUnsetError,
+  MultipleNativeTokenTransferError,
+  ZeroAddressError,
+  MultipleGasLimitError,
+  UnsupportedPermissionTypeError,
+  SelectorNotAllowed,
+} from "./errors/permissionBuilderErrors.js";