@aa-sdk/core 4.0.0-alpha.9 → 4.0.0-beta.0

package/dist/esm/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,6CAAW,CAAA;IACX,yCAAS,CAAA;IACT,uCAAQ,CAAA;IACR,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,uCAAQ,CAAA;AACV,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAKD,MAAM,OAAO,MAAM;IAejB,MAAM,CAAC,WAAW,CAAC,QAAkB;QACnC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAcD,MAAM,CAAC,YAAY,CAAC,OAAe;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;IAC3B,CAAC;IAeD,MAAM,CAAC,KAAK,CAAC,GAAW,EAAE,GAAG,IAAW;QACtC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAEjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAeD,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,GAAG,IAAW;QACrC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAEhD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAeD,MAAM,CAAC,KAAK,CAAC,GAAW,EAAE,GAAG,IAAW;QACtC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAEjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAeD,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,GAAG,IAAW;QACrC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAEhD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAeD,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,GAAG,IAAW;QACxC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO;QAEnD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,KAAe;QACnD,IAAI,IAAI,CAAC,QAAQ,GAAG,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAElE,OAAO,IAAI,CAAC;IACd,CAAC;;AAtIM;;;;WAAqB,QAAQ,CAAC,IAAI;GAAC","sourcesContent":["export enum LogLevel {\n  VERBOSE = 5,\n  DEBUG = 4,\n  INFO = 3,\n  WARN = 2,\n  ERROR = 1,\n  NONE = 0,\n}\n\n/**\n * Logger class provides static methods for logging at different levels such as error, warn, debug, info, and verbose. This class allows setting log levels and log filters to control the logging behavior.\n */\nexport class Logger {\n  static logLevel: LogLevel = LogLevel.INFO;\n  static logFilter?: string;\n\n  /**\n   * Sets the log level for logging purposes.\n   *\n   * @example\n   * ```ts\n   * import { Logger, LogLevel } from \"@aa-sdk/core\";\n   * Logger.setLogLevel(LogLevel.DEBUG);\n   * ```\n   *\n   * @param {LogLevel} logLevel The desired log level\n   */\n  static setLogLevel(logLevel: LogLevel) {\n    this.logLevel = logLevel;\n  }\n\n  /**\n   * Sets the log filter pattern.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.setLogFilter(\"error\");\n   * ```\n   *\n   * @param {string} pattern The pattern to set as the log filter\n   */\n  static setLogFilter(pattern: string) {\n    this.logFilter = pattern;\n  }\n\n  /**\n   * Logs an error message to the console if the logging condition is met.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.error(\"An error occurred while processing the request\");\n   * ```\n   *\n   * @param {string} msg The primary error message to be logged\n   * @param {...any[]} args Additional arguments to be logged along with the error message\n   */\n  static error(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.ERROR)) return;\n\n    console.error(msg, ...args);\n  }\n\n  /**\n   * Logs a warning message if the logging conditions are met.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.warn(\"Careful...\");\n   * ```\n   *\n   * @param {string} msg The message to log as a warning\n   * @param {...any[]} args Additional parameters to log along with the message\n   */\n  static warn(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.WARN)) return;\n\n    console.warn(msg, ...args);\n  }\n\n  /**\n   * Logs a debug message to the console if the log level allows it.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.debug(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg The message to log\n   * @param {...any[]} args Additional arguments to pass to the console.debug method\n   */\n  static debug(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.DEBUG)) return;\n\n    console.debug(msg, ...args);\n  }\n\n  /**\n   * Logs an informational message to the console if the logging level is set to INFO.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.info(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg the message to log\n   * @param {...any[]} args additional arguments to log alongside the message\n   */\n  static info(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.INFO)) return;\n\n    console.info(msg, ...args);\n  }\n\n  /**\n   * Logs a message with additional arguments if the logging level permits it.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.verbose(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg The message to log\n   * @param {...any[]} args Additional arguments to be logged\n   */\n  static verbose(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.VERBOSE)) return;\n\n    console.log(msg, ...args);\n  }\n\n  private static shouldLog(msg: string, level: LogLevel) {\n    if (this.logLevel < level) return false;\n    if (this.logFilter && !msg.includes(this.logFilter)) return false;\n\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,6CAAW,CAAA;IACX,yCAAS,CAAA;IACT,uCAAQ,CAAA;IACR,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,uCAAQ,CAAA;AACV,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAED;;GAEG;AACH,MAAM,OAAO,MAAM;IAIjB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAAC,QAAkB;QACnC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,YAAY,CAAC,OAAe;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAC,GAAW,EAAE,GAAG,IAAW;QACtC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAEjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,GAAG,IAAW;QACrC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAEhD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAC,GAAW,EAAE,GAAG,IAAW;QACtC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAEjD,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,GAAG,IAAW;QACrC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAEhD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,GAAG,IAAW;QACxC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO;QAEnD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,KAAe;QACnD,IAAI,IAAI,CAAC,QAAQ,GAAG,KAAK;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAElE,OAAO,IAAI,CAAC;IACd,CAAC;;AAtIM;;;;WAAqB,QAAQ,CAAC,IAAI;GAAC","sourcesContent":["export enum LogLevel {\n  VERBOSE = 5,\n  DEBUG = 4,\n  INFO = 3,\n  WARN = 2,\n  ERROR = 1,\n  NONE = 0,\n}\n\n/**\n * Logger class provides static methods for logging at different levels such as error, warn, debug, info, and verbose. This class allows setting log levels and log filters to control the logging behavior.\n */\nexport class Logger {\n  static logLevel: LogLevel = LogLevel.INFO;\n  static logFilter?: string;\n\n  /**\n   * Sets the log level for logging purposes.\n   *\n   * @example\n   * ```ts\n   * import { Logger, LogLevel } from \"@aa-sdk/core\";\n   * Logger.setLogLevel(LogLevel.DEBUG);\n   * ```\n   *\n   * @param {LogLevel} logLevel The desired log level\n   */\n  static setLogLevel(logLevel: LogLevel) {\n    this.logLevel = logLevel;\n  }\n\n  /**\n   * Sets the log filter pattern.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.setLogFilter(\"error\");\n   * ```\n   *\n   * @param {string} pattern The pattern to set as the log filter\n   */\n  static setLogFilter(pattern: string) {\n    this.logFilter = pattern;\n  }\n\n  /**\n   * Logs an error message to the console if the logging condition is met.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.error(\"An error occurred while processing the request\");\n   * ```\n   *\n   * @param {string} msg The primary error message to be logged\n   * @param {...any[]} args Additional arguments to be logged along with the error message\n   */\n  static error(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.ERROR)) return;\n\n    console.error(msg, ...args);\n  }\n\n  /**\n   * Logs a warning message if the logging conditions are met.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.warn(\"Careful...\");\n   * ```\n   *\n   * @param {string} msg The message to log as a warning\n   * @param {...any[]} args Additional parameters to log along with the message\n   */\n  static warn(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.WARN)) return;\n\n    console.warn(msg, ...args);\n  }\n\n  /**\n   * Logs a debug message to the console if the log level allows it.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.debug(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg The message to log\n   * @param {...any[]} args Additional arguments to pass to the console.debug method\n   */\n  static debug(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.DEBUG)) return;\n\n    console.debug(msg, ...args);\n  }\n\n  /**\n   * Logs an informational message to the console if the logging level is set to INFO.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.info(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg the message to log\n   * @param {...any[]} args additional arguments to log alongside the message\n   */\n  static info(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.INFO)) return;\n\n    console.info(msg, ...args);\n  }\n\n  /**\n   * Logs a message with additional arguments if the logging level permits it.\n   *\n   * @example\n   * ```ts\n   * import { Logger } from \"@aa-sdk/core\";\n   *\n   * Logger.verbose(\"Something is happening\");\n   * ```\n   *\n   * @param {string} msg The message to log\n   * @param {...any[]} args Additional arguments to be logged\n   */\n  static verbose(msg: string, ...args: any[]) {\n    if (!this.shouldLog(msg, LogLevel.VERBOSE)) return;\n\n    console.log(msg, ...args);\n  }\n\n  private static shouldLog(msg: string, level: LogLevel) {\n    if (this.logLevel < level) return false;\n    if (this.logFilter && !msg.includes(this.logFilter)) return false;\n\n    return true;\n  }\n}\n"]}

package/dist/esm/middleware/actions.d.ts

@@ -3,10 +3,24 @@ import type { SmartContractAccount } from "../account/smartContractAccount.js";
 import type { BundlerActions, BundlerRpcSchema } from "../client/decorators/bundlerClient.js";
 import type { ClientMiddlewareConfig } from "../client/types.js";
 import type { ClientMiddleware } from "./types.js";
+/**
+ * Middleware client type
+ *
+ * @template {Transport} TTransport
+ * @template {Chain | undefined} TChain
+ * @template {SmartContractAccount | undefined} TAccount
+ */
 export type MiddlewareClient<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined> = Client<TTransport, TChain, TAccount, [
     ...BundlerRpcSchema,
     ...PublicRpcSchema
 ], PublicActions & BundlerActions>;
+/**
+ * function that takes in ClientMiddlewareConfig used during client initiation
+ * and returns the middleware actions object that the smart account client extends with
+ *
+ * @param {ClientMiddlewareConfig} overrides config used during client initiation for overriding default middlewares
+ * @returns {(client: MiddlewareClient<TTransport, TChain, TAccount>) => { middleware: ClientMiddleware }} middleware actions object
+ */
 export declare const middlewareActions: (overrides: ClientMiddlewareConfig) => <TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(client: MiddlewareClient<TTransport, TChain, TAccount>) => {
     middleware: ClientMiddleware;
 };

package/dist/esm/middleware/actions.js

@@ -4,6 +4,13 @@ import { defaultGasEstimator } from "./defaults/gasEstimator.js";
 import { defaultPaymasterAndData } from "./defaults/paymasterAndData.js";
 import { defaultUserOpSigner } from "./defaults/userOpSigner.js";
 import { noopMiddleware } from "./noopMiddleware.js";
+/**
+ * function that takes in ClientMiddlewareConfig used during client initiation
+ * and returns the middleware actions object that the smart account client extends with
+ *
+ * @param {ClientMiddlewareConfig} overrides config used during client initiation for overriding default middlewares
+ * @returns {(client: MiddlewareClient<TTransport, TChain, TAccount>) => { middleware: ClientMiddleware }} middleware actions object
+ */
 export const middlewareActions = (overrides) => (client) => ({
     middleware: {
         customMiddleware: overrides.customMiddleware ?? noopMiddleware,

package/dist/esm/middleware/actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/middleware/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAMN,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AA+BrD,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,SAAiC,EAAE,EAAE,CACtC,CAOE,MAAsD,EACpB,EAAE,CAAC,CAAC;IACtC,UAAU,EAAE;QACV,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,cAAc;QAC9D,qBAAqB,EACnB,SAAS,CAAC,qBAAqB,IAAI,uBAAuB;QAC5D,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,mBAAmB,CAAC,MAAM,CAAC;QACnE,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,mBAAmB,CAAC,MAAM,CAAC;QACnE,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,uBAAuB;QACvE,sBAAsB,EACpB,SAAS,CAAC,sBAAsB,IAAI,cAAc;QACpD,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,IAAI,mBAAmB;KACtE;CACF,CAAC,CAAC","sourcesContent":["import {\n  type Chain,\n  type Client,\n  type PublicActions,\n  type PublicRpcSchema,\n  type Transport,\n} from \"viem\";\nimport type { SmartContractAccount } from \"../account/smartContractAccount.js\";\nimport type {\n  BundlerActions,\n  BundlerRpcSchema,\n} from \"../client/decorators/bundlerClient.js\";\nimport type { ClientMiddlewareConfig } from \"../client/types.js\";\nimport { defaultFeeEstimator } from \"./defaults/feeEstimator.js\";\nimport { defaultGasEstimator } from \"./defaults/gasEstimator.js\";\nimport { defaultPaymasterAndData } from \"./defaults/paymasterAndData.js\";\nimport { defaultUserOpSigner } from \"./defaults/userOpSigner.js\";\nimport { noopMiddleware } from \"./noopMiddleware.js\";\nimport type { ClientMiddleware } from \"./types.js\";\n\n/**\n * Middleware client type\n *\n * @template {Transport} TTransport\n * @template {Chain | undefined} TChain\n * @template {SmartContractAccount | undefined} TAccount\n */\nexport type MiddlewareClient<\n  TTransport extends Transport = Transport,\n  TChain extends Chain | undefined = Chain | undefined,\n  TAccount extends SmartContractAccount | undefined =\n    | SmartContractAccount\n    | undefined\n> = Client<\n  TTransport,\n  TChain,\n  TAccount,\n  [...BundlerRpcSchema, ...PublicRpcSchema],\n  PublicActions & BundlerActions\n>;\n\n/**\n * function that takes in ClientMiddlewareConfig used during client initiation\n * and returns the middleware actions object that the smart account client extends with\n *\n * @param {ClientMiddlewareConfig} overrides config used during client initiation for overriding default middlewares\n * @returns {(client: MiddlewareClient<TTransport, TChain, TAccount>) => { middleware: ClientMiddleware }} middleware actions object\n */\nexport const middlewareActions =\n  (overrides: ClientMiddlewareConfig) =>\n  <\n    TTransport extends Transport = Transport,\n    TChain extends Chain | undefined = Chain | undefined,\n    TAccount extends SmartContractAccount | undefined =\n      | SmartContractAccount\n      | undefined\n  >(\n    client: MiddlewareClient<TTransport, TChain, TAccount>\n  ): { middleware: ClientMiddleware } => ({\n    middleware: {\n      customMiddleware: overrides.customMiddleware ?? noopMiddleware,\n      dummyPaymasterAndData:\n        overrides.dummyPaymasterAndData ?? defaultPaymasterAndData,\n      feeEstimator: overrides.feeEstimator ?? defaultFeeEstimator(client),\n      gasEstimator: overrides.gasEstimator ?? defaultGasEstimator(client),\n      paymasterAndData: overrides.paymasterAndData ?? defaultPaymasterAndData,\n      userOperationSimulator:\n        overrides.userOperationSimulator ?? noopMiddleware,\n      signUserOperation: overrides.signUserOperation ?? defaultUserOpSigner,\n    },\n  });\n"]}
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/middleware/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAMN,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAwBrD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,SAAiC,EAAE,EAAE,CACtC,CAOE,MAAsD,EACpB,EAAE,CAAC,CAAC;IACtC,UAAU,EAAE;QACV,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,cAAc;QAC9D,qBAAqB,EACnB,SAAS,CAAC,qBAAqB,IAAI,uBAAuB;QAC5D,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,mBAAmB,CAAC,MAAM,CAAC;QACnE,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,mBAAmB,CAAC,MAAM,CAAC;QACnE,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,uBAAuB;QACvE,sBAAsB,EACpB,SAAS,CAAC,sBAAsB,IAAI,cAAc;QACpD,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,IAAI,mBAAmB;KACtE;CACF,CAAC,CAAC","sourcesContent":["import {\n  type Chain,\n  type Client,\n  type PublicActions,\n  type PublicRpcSchema,\n  type Transport,\n} from \"viem\";\nimport type { SmartContractAccount } from \"../account/smartContractAccount.js\";\nimport type {\n  BundlerActions,\n  BundlerRpcSchema,\n} from \"../client/decorators/bundlerClient.js\";\nimport type { ClientMiddlewareConfig } from \"../client/types.js\";\nimport { defaultFeeEstimator } from \"./defaults/feeEstimator.js\";\nimport { defaultGasEstimator } from \"./defaults/gasEstimator.js\";\nimport { defaultPaymasterAndData } from \"./defaults/paymasterAndData.js\";\nimport { defaultUserOpSigner } from \"./defaults/userOpSigner.js\";\nimport { noopMiddleware } from \"./noopMiddleware.js\";\nimport type { ClientMiddleware } from \"./types.js\";\n\n/**\n * Middleware client type\n *\n * @template {Transport} TTransport\n * @template {Chain | undefined} TChain\n * @template {SmartContractAccount | undefined} TAccount\n */\nexport type MiddlewareClient<\n  TTransport extends Transport = Transport,\n  TChain extends Chain | undefined = Chain | undefined,\n  TAccount extends SmartContractAccount | undefined =\n    | SmartContractAccount\n    | undefined\n> = Client<\n  TTransport,\n  TChain,\n  TAccount,\n  [...BundlerRpcSchema, ...PublicRpcSchema],\n  PublicActions & BundlerActions\n>;\n\n/**\n * function that takes in ClientMiddlewareConfig used during client initiation\n * and returns the middleware actions object that the smart account client extends with\n *\n * @param {ClientMiddlewareConfig} overrides config used during client initiation for overriding default middlewares\n * @returns {(client: MiddlewareClient<TTransport, TChain, TAccount>) => { middleware: ClientMiddleware }} middleware actions object\n */\nexport const middlewareActions =\n  (overrides: ClientMiddlewareConfig) =>\n  <\n    TTransport extends Transport = Transport,\n    TChain extends Chain | undefined = Chain | undefined,\n    TAccount extends SmartContractAccount | undefined =\n      | SmartContractAccount\n      | undefined\n  >(\n    client: MiddlewareClient<TTransport, TChain, TAccount>\n  ): { middleware: ClientMiddleware } => ({\n    middleware: {\n      customMiddleware: overrides.customMiddleware ?? noopMiddleware,\n      dummyPaymasterAndData:\n        overrides.dummyPaymasterAndData ?? defaultPaymasterAndData,\n      feeEstimator: overrides.feeEstimator ?? defaultFeeEstimator(client),\n      gasEstimator: overrides.gasEstimator ?? defaultGasEstimator(client),\n      paymasterAndData: overrides.paymasterAndData ?? defaultPaymasterAndData,\n      userOperationSimulator:\n        overrides.userOperationSimulator ?? noopMiddleware,\n      signUserOperation: overrides.signUserOperation ?? defaultUserOpSigner,\n    },\n  });\n"]}

package/dist/esm/middleware/defaults/feeEstimator.d.ts

@@ -1,3 +1,23 @@
 import type { MiddlewareClient } from "../actions";
 import type { ClientMiddlewareFn } from "../types";
+/**
+ * Default fee estimator middleware function that estimates the maximum fee per gas and maximum priority fee per gas for a given client and applies the necessary overrides and fee options.
+ *
+ * @example
+ * ```ts
+ * import { createSmartAccountClient, defaultFeeEstimator, createBundlerClient } from "@aa-sdk/core";
+ *
+ * const bundlerClient = createBundlerClient(...);
+ *
+ * // NOTE: this is already provided by the smart account client
+ * const client = createSmartAccountClient({
+ *  feeEstimator: defaultFeeEstimator(bundlerClient),
+ *  ...otherParams
+ * });
+ * ```
+ *
+ * @template {MiddlewareClient} C The type of the client
+ * @param {C} client The client to perform the fee estimation
+ * @returns {ClientMiddlewareFn} A middleware function that takes in the struct and options, estimates the fees, and updates the struct with the estimated fees
+ */
 export declare function defaultFeeEstimator<C extends MiddlewareClient>(client: C): ClientMiddlewareFn;

package/dist/esm/middleware/defaults/feeEstimator.js

@@ -1,6 +1,34 @@
 import { applyUserOpOverrideOrFeeOption } from "../../utils/index.js";
+/**
+ * Default fee estimator middleware function that estimates the maximum fee per gas and maximum priority fee per gas for a given client and applies the necessary overrides and fee options.
+ *
+ * @example
+ * ```ts
+ * import { createSmartAccountClient, defaultFeeEstimator, createBundlerClient } from "@aa-sdk/core";
+ *
+ * const bundlerClient = createBundlerClient(...);
+ *
+ * // NOTE: this is already provided by the smart account client
+ * const client = createSmartAccountClient({
+ *  feeEstimator: defaultFeeEstimator(bundlerClient),
+ *  ...otherParams
+ * });
+ * ```
+ *
+ * @template {MiddlewareClient} C The type of the client
+ * @param {C} client The client to perform the fee estimation
+ * @returns {ClientMiddlewareFn} A middleware function that takes in the struct and options, estimates the fees, and updates the struct with the estimated fees
+ */
 export function defaultFeeEstimator(client) {
     return async (struct, { overrides, feeOptions }) => {
+        // maxFeePerGas must be at least the sum of maxPriorityFeePerGas and baseFee
+        // so we need to accommodate for the fee option applied maxPriorityFeePerGas for the maxFeePerGas
+        //
+        // Note that if maxFeePerGas is not at least the sum of maxPriorityFeePerGas and required baseFee
+        // after applying the fee options, then the transaction will fail
+        //
+        // Refer to https://docs.alchemy.com/docs/maxpriorityfeepergas-vs-maxfeepergas
+        // for more information about maxFeePerGas and maxPriorityFeePerGas
         const feeData = await client.estimateFeesPerGas();
         if (!feeData.maxFeePerGas || feeData.maxPriorityFeePerGas == null) {
             throw new Error("feeData is missing maxFeePerGas or maxPriorityFeePerGas");

package/dist/esm/middleware/defaults/feeEstimator.js.map

@@ -1 +1 @@
-{"version":3,"file":"feeEstimator.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/feeEstimator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAwBtE,MAAM,UAAU,mBAAmB,CACjC,MAAS;IAET,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;QAUjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,oBAAoB,IAAI,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QAED,IAAI,oBAAoB,GACtB,MAAM,MAAM,CAAC,4BAA4B,EAAE,CAAC;QAE9C,oBAAoB,GAAG,8BAA8B,CACnD,oBAAoB,EACpB,SAAS,EAAE,oBAAoB,EAC/B,UAAU,EAAE,oBAAoB,CACjC,CAAC;QAEF,IAAI,YAAY,GACd,OAAO,CAAC,YAAY;YACpB,OAAO,CAAC,oBAAoB;YAC5B,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAE/B,YAAY,GAAG,8BAA8B,CAC3C,YAAY,EACZ,SAAS,EAAE,YAAY,EACvB,UAAU,EAAE,YAAY,CACzB,CAAC;QAEF,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,MAAM,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { BigNumberish } from \"../../types\";\nimport { applyUserOpOverrideOrFeeOption } from \"../../utils/index.js\";\nimport type { MiddlewareClient } from \"../actions\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Default fee estimator middleware function that estimates the maximum fee per gas and maximum priority fee per gas for a given client and applies the necessary overrides and fee options.\n *\n * @example\n * ```ts\n * import { createSmartAccountClient, defaultFeeEstimator, createBundlerClient } from \"@aa-sdk/core\";\n *\n * const bundlerClient = createBundlerClient(...);\n *\n * // NOTE: this is already provided by the smart account client\n * const client = createSmartAccountClient({\n *  feeEstimator: defaultFeeEstimator(bundlerClient),\n *  ...otherParams\n * });\n * ```\n *\n * @template {MiddlewareClient} C The type of the client\n * @param {C} client The client to perform the fee estimation\n * @returns {ClientMiddlewareFn} A middleware function that takes in the struct and options, estimates the fees, and updates the struct with the estimated fees\n */\nexport function defaultFeeEstimator<C extends MiddlewareClient>(\n  client: C\n): ClientMiddlewareFn {\n  return async (struct, { overrides, feeOptions }) => {\n    // maxFeePerGas must be at least the sum of maxPriorityFeePerGas and baseFee\n    // so we need to accommodate for the fee option applied maxPriorityFeePerGas for the maxFeePerGas\n    //\n    // Note that if maxFeePerGas is not at least the sum of maxPriorityFeePerGas and required baseFee\n    // after applying the fee options, then the transaction will fail\n    //\n    // Refer to https://docs.alchemy.com/docs/maxpriorityfeepergas-vs-maxfeepergas\n    // for more information about maxFeePerGas and maxPriorityFeePerGas\n\n    const feeData = await client.estimateFeesPerGas();\n    if (!feeData.maxFeePerGas || feeData.maxPriorityFeePerGas == null) {\n      throw new Error(\n        \"feeData is missing maxFeePerGas or maxPriorityFeePerGas\"\n      );\n    }\n\n    let maxPriorityFeePerGas: BigNumberish =\n      await client.estimateMaxPriorityFeePerGas();\n\n    maxPriorityFeePerGas = applyUserOpOverrideOrFeeOption(\n      maxPriorityFeePerGas,\n      overrides?.maxPriorityFeePerGas,\n      feeOptions?.maxPriorityFeePerGas\n    );\n\n    let maxFeePerGas: BigNumberish =\n      feeData.maxFeePerGas -\n      feeData.maxPriorityFeePerGas +\n      BigInt(maxPriorityFeePerGas);\n\n    maxFeePerGas = applyUserOpOverrideOrFeeOption(\n      maxFeePerGas,\n      overrides?.maxFeePerGas,\n      feeOptions?.maxFeePerGas\n    );\n\n    struct.maxFeePerGas = maxFeePerGas;\n    struct.maxPriorityFeePerGas = maxPriorityFeePerGas;\n    return struct;\n  };\n}\n"]}
+{"version":3,"file":"feeEstimator.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/feeEstimator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAItE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAS;IAET,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;QACjD,4EAA4E;QAC5E,iGAAiG;QACjG,EAAE;QACF,iGAAiG;QACjG,iEAAiE;QACjE,EAAE;QACF,8EAA8E;QAC9E,mEAAmE;QAEnE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,oBAAoB,IAAI,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QAED,IAAI,oBAAoB,GACtB,MAAM,MAAM,CAAC,4BAA4B,EAAE,CAAC;QAE9C,oBAAoB,GAAG,8BAA8B,CACnD,oBAAoB,EACpB,SAAS,EAAE,oBAAoB,EAC/B,UAAU,EAAE,oBAAoB,CACjC,CAAC;QAEF,IAAI,YAAY,GACd,OAAO,CAAC,YAAY;YACpB,OAAO,CAAC,oBAAoB;YAC5B,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAE/B,YAAY,GAAG,8BAA8B,CAC3C,YAAY,EACZ,SAAS,EAAE,YAAY,EACvB,UAAU,EAAE,YAAY,CACzB,CAAC;QAEF,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,MAAM,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { BigNumberish } from \"../../types\";\nimport { applyUserOpOverrideOrFeeOption } from \"../../utils/index.js\";\nimport type { MiddlewareClient } from \"../actions\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Default fee estimator middleware function that estimates the maximum fee per gas and maximum priority fee per gas for a given client and applies the necessary overrides and fee options.\n *\n * @example\n * ```ts\n * import { createSmartAccountClient, defaultFeeEstimator, createBundlerClient } from \"@aa-sdk/core\";\n *\n * const bundlerClient = createBundlerClient(...);\n *\n * // NOTE: this is already provided by the smart account client\n * const client = createSmartAccountClient({\n *  feeEstimator: defaultFeeEstimator(bundlerClient),\n *  ...otherParams\n * });\n * ```\n *\n * @template {MiddlewareClient} C The type of the client\n * @param {C} client The client to perform the fee estimation\n * @returns {ClientMiddlewareFn} A middleware function that takes in the struct and options, estimates the fees, and updates the struct with the estimated fees\n */\nexport function defaultFeeEstimator<C extends MiddlewareClient>(\n  client: C\n): ClientMiddlewareFn {\n  return async (struct, { overrides, feeOptions }) => {\n    // maxFeePerGas must be at least the sum of maxPriorityFeePerGas and baseFee\n    // so we need to accommodate for the fee option applied maxPriorityFeePerGas for the maxFeePerGas\n    //\n    // Note that if maxFeePerGas is not at least the sum of maxPriorityFeePerGas and required baseFee\n    // after applying the fee options, then the transaction will fail\n    //\n    // Refer to https://docs.alchemy.com/docs/maxpriorityfeepergas-vs-maxfeepergas\n    // for more information about maxFeePerGas and maxPriorityFeePerGas\n\n    const feeData = await client.estimateFeesPerGas();\n    if (!feeData.maxFeePerGas || feeData.maxPriorityFeePerGas == null) {\n      throw new Error(\n        \"feeData is missing maxFeePerGas or maxPriorityFeePerGas\"\n      );\n    }\n\n    let maxPriorityFeePerGas: BigNumberish =\n      await client.estimateMaxPriorityFeePerGas();\n\n    maxPriorityFeePerGas = applyUserOpOverrideOrFeeOption(\n      maxPriorityFeePerGas,\n      overrides?.maxPriorityFeePerGas,\n      feeOptions?.maxPriorityFeePerGas\n    );\n\n    let maxFeePerGas: BigNumberish =\n      feeData.maxFeePerGas -\n      feeData.maxPriorityFeePerGas +\n      BigInt(maxPriorityFeePerGas);\n\n    maxFeePerGas = applyUserOpOverrideOrFeeOption(\n      maxFeePerGas,\n      overrides?.maxFeePerGas,\n      feeOptions?.maxFeePerGas\n    );\n\n    struct.maxFeePerGas = maxFeePerGas;\n    struct.maxPriorityFeePerGas = maxPriorityFeePerGas;\n    return struct;\n  };\n}\n"]}

package/dist/esm/middleware/defaults/gasEstimator.d.ts

@@ -1,3 +1,11 @@
 import type { MiddlewareClient } from "../actions.js";
 import type { ClientMiddlewareFn } from "../types.js";
+/**
+ * Description default gas estimator middleware for `SmartAccountClient`
+ * You can override this middleware with your custom gas estimator middleware
+ * by passing it to the client constructor
+ *
+ * @param {MiddlewareClient} client smart account client instance to apply the middleware to
+ * @returns {ClientMiddlewareFn} middleware execution function used to estimate gas for user operations
+ */
 export declare const defaultGasEstimator: <C extends MiddlewareClient>(client: C) => ClientMiddlewareFn;

package/dist/esm/middleware/defaults/gasEstimator.js

@@ -1,5 +1,13 @@
 import { deepHexlify, resolveProperties } from "../../utils/index.js";
 import { applyUserOpOverrideOrFeeOption } from "../../utils/userop.js";
+/**
+ * Description default gas estimator middleware for `SmartAccountClient`
+ * You can override this middleware with your custom gas estimator middleware
+ * by passing it to the client constructor
+ *
+ * @param {MiddlewareClient} client smart account client instance to apply the middleware to
+ * @returns {ClientMiddlewareFn} middleware execution function used to estimate gas for user operations
+ */
 export const defaultGasEstimator = (client) => async (struct, { account, overrides, feeOptions }) => {
     const request = deepHexlify(await resolveProperties(struct));
     const estimates = await client.estimateUserOperationGas(request, account.getEntryPoint().address, overrides?.stateOverride);

package/dist/esm/middleware/defaults/gasEstimator.js.map

@@ -1 +1 @@
-{"version":3,"file":"gasEstimator.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/gasEstimator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAYvE,MAAM,CAAC,MAAM,mBAAmB,GAG9B,CAAC,MAAwB,EAAsB,EAAE,CACjD,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,wBAAwB,CACrD,OAAO,EACP,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,EAC/B,SAAS,EAAE,aAAa,CACzB,CAAC;IAEF,MAAM,YAAY,GAAG,8BAA8B,CACjD,SAAS,CAAC,YAAY,EACtB,SAAS,EAAE,YAAY,EACvB,UAAU,EAAE,YAAY,CACzB,CAAC;IACF,MAAM,oBAAoB,GAAG,8BAA8B,CACzD,SAAS,CAAC,oBAAoB,EAC9B,SAAS,EAAE,oBAAoB,EAC/B,UAAU,EAAE,oBAAoB,CACjC,CAAC;IACF,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,SAAS,CAAC,kBAAkB,EAC5B,SAAS,EAAE,kBAAkB,EAC7B,UAAU,EAAE,kBAAkB,CAC/B,CAAC;IAEF,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,MAAM,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,MAAM,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAE/C,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACnC,MAAM,6BAA6B,GAAG,8BAA8B,CAClE,SAAS,CAAC,6BAA6B,EACtC,SAA6C;YAC5C,EAAE,6BAA6B,EAChC,UAA+C;YAC9C,EAAE,6BAA6B,CAClC,CAAC;QACF,MAAM,KAAK,GAAG,MAAsC,CAAC;QAErD,KAAK,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;QAEpE,KAAK,CAAC,uBAAuB;YAC3B,KAAK,CAAC,uBAAuB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationStruct,\n} from \"../../types.js\";\nimport { deepHexlify, resolveProperties } from \"../../utils/index.js\";\nimport { applyUserOpOverrideOrFeeOption } from \"../../utils/userop.js\";\nimport type { MiddlewareClient } from \"../actions.js\";\nimport type { ClientMiddlewareFn } from \"../types.js\";\n\n/**\n * Description default gas estimator middleware for `SmartAccountClient`\n * You can override this middleware with your custom gas estimator middleware\n * by passing it to the client constructor\n *\n * @param {MiddlewareClient} client smart account client instance to apply the middleware to\n * @returns {ClientMiddlewareFn} middleware execution function used to estimate gas for user operations\n */\nexport const defaultGasEstimator: <C extends MiddlewareClient>(\n  client: C\n) => ClientMiddlewareFn =\n  (client: MiddlewareClient): ClientMiddlewareFn =>\n  async (struct, { account, overrides, feeOptions }) => {\n    const request = deepHexlify(await resolveProperties(struct));\n\n    const estimates = await client.estimateUserOperationGas(\n      request,\n      account.getEntryPoint().address,\n      overrides?.stateOverride\n    );\n\n    const callGasLimit = applyUserOpOverrideOrFeeOption(\n      estimates.callGasLimit,\n      overrides?.callGasLimit,\n      feeOptions?.callGasLimit\n    );\n    const verificationGasLimit = applyUserOpOverrideOrFeeOption(\n      estimates.verificationGasLimit,\n      overrides?.verificationGasLimit,\n      feeOptions?.verificationGasLimit\n    );\n    const preVerificationGas = applyUserOpOverrideOrFeeOption(\n      estimates.preVerificationGas,\n      overrides?.preVerificationGas,\n      feeOptions?.preVerificationGas\n    );\n\n    struct.callGasLimit = callGasLimit;\n    struct.verificationGasLimit = verificationGasLimit;\n    struct.preVerificationGas = preVerificationGas;\n\n    const entryPoint = account.getEntryPoint();\n    if (entryPoint.version === \"0.7.0\") {\n      const paymasterVerificationGasLimit = applyUserOpOverrideOrFeeOption(\n        estimates.paymasterVerificationGasLimit,\n        (overrides as UserOperationOverrides<\"0.7.0\">)\n          ?.paymasterVerificationGasLimit,\n        (feeOptions as UserOperationFeeOptions<\"0.7.0\">)\n          ?.paymasterVerificationGasLimit\n      );\n      const uo_v7 = struct as UserOperationStruct<\"0.7.0\">;\n\n      uo_v7.paymasterVerificationGasLimit = paymasterVerificationGasLimit;\n\n      uo_v7.paymasterPostOpGasLimit =\n        uo_v7.paymasterPostOpGasLimit ?? (uo_v7.paymaster ? \"0x0\" : undefined);\n    }\n\n    return struct;\n  };\n"]}
+{"version":3,"file":"gasEstimator.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/gasEstimator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAIvE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAG9B,CAAC,MAAwB,EAAsB,EAAE,CACjD,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,wBAAwB,CACrD,OAAO,EACP,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,EAC/B,SAAS,EAAE,aAAa,CACzB,CAAC;IAEF,MAAM,YAAY,GAAG,8BAA8B,CACjD,SAAS,CAAC,YAAY,EACtB,SAAS,EAAE,YAAY,EACvB,UAAU,EAAE,YAAY,CACzB,CAAC;IACF,MAAM,oBAAoB,GAAG,8BAA8B,CACzD,SAAS,CAAC,oBAAoB,EAC9B,SAAS,EAAE,oBAAoB,EAC/B,UAAU,EAAE,oBAAoB,CACjC,CAAC;IACF,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,SAAS,CAAC,kBAAkB,EAC5B,SAAS,EAAE,kBAAkB,EAC7B,UAAU,EAAE,kBAAkB,CAC/B,CAAC;IAEF,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,MAAM,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;IACnD,MAAM,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAE/C,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACnC,MAAM,6BAA6B,GAAG,8BAA8B,CAClE,SAAS,CAAC,6BAA6B,EACtC,SAA6C;YAC5C,EAAE,6BAA6B,EAChC,UAA+C;YAC9C,EAAE,6BAA6B,CAClC,CAAC;QACF,MAAM,KAAK,GAAG,MAAsC,CAAC;QAErD,KAAK,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;QAEpE,KAAK,CAAC,uBAAuB;YAC3B,KAAK,CAAC,uBAAuB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationStruct,\n} from \"../../types.js\";\nimport { deepHexlify, resolveProperties } from \"../../utils/index.js\";\nimport { applyUserOpOverrideOrFeeOption } from \"../../utils/userop.js\";\nimport type { MiddlewareClient } from \"../actions.js\";\nimport type { ClientMiddlewareFn } from \"../types.js\";\n\n/**\n * Description default gas estimator middleware for `SmartAccountClient`\n * You can override this middleware with your custom gas estimator middleware\n * by passing it to the client constructor\n *\n * @param {MiddlewareClient} client smart account client instance to apply the middleware to\n * @returns {ClientMiddlewareFn} middleware execution function used to estimate gas for user operations\n */\nexport const defaultGasEstimator: <C extends MiddlewareClient>(\n  client: C\n) => ClientMiddlewareFn =\n  (client: MiddlewareClient): ClientMiddlewareFn =>\n  async (struct, { account, overrides, feeOptions }) => {\n    const request = deepHexlify(await resolveProperties(struct));\n\n    const estimates = await client.estimateUserOperationGas(\n      request,\n      account.getEntryPoint().address,\n      overrides?.stateOverride\n    );\n\n    const callGasLimit = applyUserOpOverrideOrFeeOption(\n      estimates.callGasLimit,\n      overrides?.callGasLimit,\n      feeOptions?.callGasLimit\n    );\n    const verificationGasLimit = applyUserOpOverrideOrFeeOption(\n      estimates.verificationGasLimit,\n      overrides?.verificationGasLimit,\n      feeOptions?.verificationGasLimit\n    );\n    const preVerificationGas = applyUserOpOverrideOrFeeOption(\n      estimates.preVerificationGas,\n      overrides?.preVerificationGas,\n      feeOptions?.preVerificationGas\n    );\n\n    struct.callGasLimit = callGasLimit;\n    struct.verificationGasLimit = verificationGasLimit;\n    struct.preVerificationGas = preVerificationGas;\n\n    const entryPoint = account.getEntryPoint();\n    if (entryPoint.version === \"0.7.0\") {\n      const paymasterVerificationGasLimit = applyUserOpOverrideOrFeeOption(\n        estimates.paymasterVerificationGasLimit,\n        (overrides as UserOperationOverrides<\"0.7.0\">)\n          ?.paymasterVerificationGasLimit,\n        (feeOptions as UserOperationFeeOptions<\"0.7.0\">)\n          ?.paymasterVerificationGasLimit\n      );\n      const uo_v7 = struct as UserOperationStruct<\"0.7.0\">;\n\n      uo_v7.paymasterVerificationGasLimit = paymasterVerificationGasLimit;\n\n      uo_v7.paymasterPostOpGasLimit =\n        uo_v7.paymasterPostOpGasLimit ?? (uo_v7.paymaster ? \"0x0\" : undefined);\n    }\n\n    return struct;\n  };\n"]}

package/dist/esm/middleware/defaults/paymasterAndData.d.ts

@@ -1,2 +1,10 @@
 import type { ClientMiddlewareFn } from "../types";
+/**
+ * Middleware function that sets the `paymasterAndData` field in the given struct based on the entry point version of the account.
+ * This is the default used by `createSmartAccountClient` and is not necessary to be used directly.
+ *
+ * @param {UserOperationStruct} struct the user operation structure to be modified
+ * @param {{ account: Account }} context an object containing the account information
+ * @returns {Promise<UserOperationStruct>} a promise that resolves to the modified user operation structure
+ */
 export declare const defaultPaymasterAndData: ClientMiddlewareFn;

package/dist/esm/middleware/defaults/paymasterAndData.js

@@ -1,3 +1,11 @@
+/**
+ * Middleware function that sets the `paymasterAndData` field in the given struct based on the entry point version of the account.
+ * This is the default used by `createSmartAccountClient` and is not necessary to be used directly.
+ *
+ * @param {UserOperationStruct} struct the user operation structure to be modified
+ * @param {{ account: Account }} context an object containing the account information
+ * @returns {Promise<UserOperationStruct>} a promise that resolves to the modified user operation structure
+ */
 export const defaultPaymasterAndData = async (struct, { account }) => {
     const entryPoint = account.getEntryPoint();
     if (entryPoint.version === "0.6.0") {

package/dist/esm/middleware/defaults/paymasterAndData.js.map

@@ -1 +1 @@
-{"version":3,"file":"paymasterAndData.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/paymasterAndData.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,uBAAuB,GAAuB,KAAK,EAC9D,MAAM,EACN,EAAE,OAAO,EAAE,EACX,EAAE;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAClC,MAAuC,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACnE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import type { UserOperationStruct } from \"../../types\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Middleware function that sets the `paymasterAndData` field in the given struct based on the entry point version of the account.\n * This is the default used by `createSmartAccountClient` and is not necessary to be used directly.\n *\n * @param {UserOperationStruct} struct the user operation structure to be modified\n * @param {{ account: Account }} context an object containing the account information\n * @returns {Promise<UserOperationStruct>} a promise that resolves to the modified user operation structure\n */\nexport const defaultPaymasterAndData: ClientMiddlewareFn = async (\n  struct,\n  { account }\n) => {\n  const entryPoint = account.getEntryPoint();\n  if (entryPoint.version === \"0.6.0\") {\n    (struct as UserOperationStruct<\"0.6.0\">).paymasterAndData = \"0x\";\n  }\n  return struct;\n};\n"]}
+{"version":3,"file":"paymasterAndData.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/paymasterAndData.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAuB,KAAK,EAC9D,MAAM,EACN,EAAE,OAAO,EAAE,EACX,EAAE;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAClC,MAAuC,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACnE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import type { UserOperationStruct } from \"../../types\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Middleware function that sets the `paymasterAndData` field in the given struct based on the entry point version of the account.\n * This is the default used by `createSmartAccountClient` and is not necessary to be used directly.\n *\n * @param {UserOperationStruct} struct the user operation structure to be modified\n * @param {{ account: Account }} context an object containing the account information\n * @returns {Promise<UserOperationStruct>} a promise that resolves to the modified user operation structure\n */\nexport const defaultPaymasterAndData: ClientMiddlewareFn = async (\n  struct,\n  { account }\n) => {\n  const entryPoint = account.getEntryPoint();\n  if (entryPoint.version === \"0.6.0\") {\n    (struct as UserOperationStruct<\"0.6.0\">).paymasterAndData = \"0x\";\n  }\n  return struct;\n};\n"]}

package/dist/esm/middleware/defaults/userOpSigner.d.ts

@@ -1,2 +1,12 @@
 import type { ClientMiddlewareFn } from "../types";
+/**
+ * Provides a default middleware function for signing user operations with a client account. This function validates the request and adds the signature to it.
+ * This is already included in the client returned from `createSmartAccountClient`
+ *
+ * @param {UserOperationStruct} struct The user operation structure to be signed
+ * @param {*} context The middleware context containing the client and account information
+ * @param {Client} context.client The client object, which should include account and chain information
+ * @param {Account} [context.account] Optional, the account used for signing, defaults to the client's account if not provided
+ * @returns {Promise<UserOperationStruct>} A promise that resolves to the signed user operation structure
+ */
 export declare const defaultUserOpSigner: ClientMiddlewareFn;

package/dist/esm/middleware/defaults/userOpSigner.js

@@ -2,6 +2,16 @@ import { AccountNotFoundError } from "../../errors/account.js";
 import { ChainNotFoundError } from "../../errors/client.js";
 import { InvalidUserOperationError } from "../../errors/useroperation.js";
 import { deepHexlify, isValidRequest, resolveProperties, } from "../../utils/index.js";
+/**
+ * Provides a default middleware function for signing user operations with a client account. This function validates the request and adds the signature to it.
+ * This is already included in the client returned from `createSmartAccountClient`
+ *
+ * @param {UserOperationStruct} struct The user operation structure to be signed
+ * @param {*} context The middleware context containing the client and account information
+ * @param {Client} context.client The client object, which should include account and chain information
+ * @param {Account} [context.account] Optional, the account used for signing, defaults to the client's account if not provided
+ * @returns {Promise<UserOperationStruct>} A promise that resolves to the signed user operation structure
+ */
 export const defaultUserOpSigner = async (struct, { client, account = client.account }) => {
     if (!account) {
         throw new AccountNotFoundError();

package/dist/esm/middleware/defaults/userOpSigner.js.map

@@ -1 +1 @@
-{"version":3,"file":"userOpSigner.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/userOpSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACL,WAAW,EACX,cAAc,EACd,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAa9B,MAAM,CAAC,MAAM,mBAAmB,GAAuB,KAAK,EAC1D,MAAM,EACN,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,EACpC,EAAE;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,kBAAkB,EAAE,CAAC;IACjC,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAC5C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,yBAAyB,CAAC,cAAc,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACL,GAAG,cAAc;QACjB,SAAS,EAAE,MAAM,OAAO,CAAC,qBAAqB,CAC5C,OAAO,CAAC,aAAa,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,CACtD;KACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { AccountNotFoundError } from \"../../errors/account.js\";\nimport { ChainNotFoundError } from \"../../errors/client.js\";\nimport { InvalidUserOperationError } from \"../../errors/useroperation.js\";\nimport {\n  deepHexlify,\n  isValidRequest,\n  resolveProperties,\n} from \"../../utils/index.js\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Provides a default middleware function for signing user operations with a client account. This function validates the request and adds the signature to it.\n * This is already included in the client returned from `createSmartAccountClient`\n *\n * @param {UserOperationStruct} struct The user operation structure to be signed\n * @param {*} context The middleware context containing the client and account information\n * @param {Client} context.client The client object, which should include account and chain information\n * @param {Account} [context.account] Optional, the account used for signing, defaults to the client's account if not provided\n * @returns {Promise<UserOperationStruct>} A promise that resolves to the signed user operation structure\n */\nexport const defaultUserOpSigner: ClientMiddlewareFn = async (\n  struct,\n  { client, account = client.account }\n) => {\n  if (!account) {\n    throw new AccountNotFoundError();\n  }\n\n  if (!client?.chain) {\n    throw new ChainNotFoundError();\n  }\n\n  const resolvedStruct = await resolveProperties(struct);\n  const request = deepHexlify(resolvedStruct);\n  if (!isValidRequest(request)) {\n    throw new InvalidUserOperationError(resolvedStruct);\n  }\n\n  return {\n    ...resolvedStruct,\n    signature: await account.signUserOperationHash(\n      account.getEntryPoint().getUserOperationHash(request)\n    ),\n  };\n};\n"]}
+{"version":3,"file":"userOpSigner.js","sourceRoot":"","sources":["../../../../src/middleware/defaults/userOpSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EACL,WAAW,EACX,cAAc,EACd,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAG9B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAuB,KAAK,EAC1D,MAAM,EACN,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,EACpC,EAAE;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,kBAAkB,EAAE,CAAC;IACjC,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAC5C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,yBAAyB,CAAC,cAAc,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACL,GAAG,cAAc;QACjB,SAAS,EAAE,MAAM,OAAO,CAAC,qBAAqB,CAC5C,OAAO,CAAC,aAAa,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,CACtD;KACF,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import { AccountNotFoundError } from \"../../errors/account.js\";\nimport { ChainNotFoundError } from \"../../errors/client.js\";\nimport { InvalidUserOperationError } from \"../../errors/useroperation.js\";\nimport {\n  deepHexlify,\n  isValidRequest,\n  resolveProperties,\n} from \"../../utils/index.js\";\nimport type { ClientMiddlewareFn } from \"../types\";\n\n/**\n * Provides a default middleware function for signing user operations with a client account. This function validates the request and adds the signature to it.\n * This is already included in the client returned from `createSmartAccountClient`\n *\n * @param {UserOperationStruct} struct The user operation structure to be signed\n * @param {*} context The middleware context containing the client and account information\n * @param {Client} context.client The client object, which should include account and chain information\n * @param {Account} [context.account] Optional, the account used for signing, defaults to the client's account if not provided\n * @returns {Promise<UserOperationStruct>} A promise that resolves to the signed user operation structure\n */\nexport const defaultUserOpSigner: ClientMiddlewareFn = async (\n  struct,\n  { client, account = client.account }\n) => {\n  if (!account) {\n    throw new AccountNotFoundError();\n  }\n\n  if (!client?.chain) {\n    throw new ChainNotFoundError();\n  }\n\n  const resolvedStruct = await resolveProperties(struct);\n  const request = deepHexlify(resolvedStruct);\n  if (!isValidRequest(request)) {\n    throw new InvalidUserOperationError(resolvedStruct);\n  }\n\n  return {\n    ...resolvedStruct,\n    signature: await account.signUserOperationHash(\n      account.getEntryPoint().getUserOperationHash(request)\n    ),\n  };\n};\n"]}

package/dist/esm/middleware/erc7677middleware.d.ts

@@ -37,4 +37,25 @@ export type Erc7677MiddlewareParams<TContext extends Record<string, any> | undef
         feeOptions?: UserOperationFeeOptions;
     }) => Promise<TContext>) | TContext;
 };
+/**
+ * Middleware function for interacting with ERC-7677 enabled clients. It supports resolving paymaster and data fields for user operations.
+ * This middleware assumes that your RPC provider supports the ERC-7677 methods (pm_getPaymasterStubData and pm_getPaymasterData).
+ *
+ * @example
+ * ```ts
+ * import { createSmartAccountClient, erc7677Middleware } from "@aa-sdk/core";
+ * import { http } from "viem";
+ * import { sepolia } from "viem/chains";
+ *
+ * const client = createSmartAccountClient({
+ *  transport: http("rpc-url"),
+ *  chain: sepolia,
+ *  // this assumes that your RPC provider supports the ERC-7677 methods AND takes no context
+ *  ...erc7677Middleware(),
+ * })
+ * ```
+ *
+ * @param {Erc7677MiddlewareParams<TContext>} params Middleware parameters including context function or object. Context can be resolved dynamically by passing in a function which takes in the context at the time of sending a user op
+ * @returns {Pick<ClientMiddlewareConfig, "dummyPaymasterAndData" | "paymasterAndData">} An object containing middleware functions `dummyPaymasterAndData` and `paymasterAndData` for processing user operations with the paymaster data
+ */
 export declare function erc7677Middleware<TContext extends Record<string, any> | undefined = Record<string, any> | undefined>(params?: Erc7677MiddlewareParams<TContext>): Pick<ClientMiddlewareConfig, "dummyPaymasterAndData" | "paymasterAndData">;

package/dist/esm/middleware/erc7677middleware.js

@@ -1,9 +1,31 @@
 import { toHex, } from "viem";
 import { ChainNotFoundError } from "../errors/client.js";
 import { deepHexlify, resolveProperties, } from "../utils/index.js";
+/**
+ * Middleware function for interacting with ERC-7677 enabled clients. It supports resolving paymaster and data fields for user operations.
+ * This middleware assumes that your RPC provider supports the ERC-7677 methods (pm_getPaymasterStubData and pm_getPaymasterData).
+ *
+ * @example
+ * ```ts
+ * import { createSmartAccountClient, erc7677Middleware } from "@aa-sdk/core";
+ * import { http } from "viem";
+ * import { sepolia } from "viem/chains";
+ *
+ * const client = createSmartAccountClient({
+ *  transport: http("rpc-url"),
+ *  chain: sepolia,
+ *  // this assumes that your RPC provider supports the ERC-7677 methods AND takes no context
+ *  ...erc7677Middleware(),
+ * })
+ * ```
+ *
+ * @param {Erc7677MiddlewareParams<TContext>} params Middleware parameters including context function or object. Context can be resolved dynamically by passing in a function which takes in the context at the time of sending a user op
+ * @returns {Pick<ClientMiddlewareConfig, "dummyPaymasterAndData" | "paymasterAndData">} An object containing middleware functions `dummyPaymasterAndData` and `paymasterAndData` for processing user operations with the paymaster data
+ */
 export function erc7677Middleware(params) {
     const dummyPaymasterAndData = async (uo, { client, account, feeOptions, overrides }) => {
         const userOp = deepHexlify(await resolveProperties(uo));
+        // Those values will be set after fee estimation.
         userOp.maxFeePerGas = "0x0";
         userOp.maxPriorityFeePerGas = "0x0";
         userOp.callGasLimit = "0x0";
@@ -21,6 +43,7 @@ export function erc7677Middleware(params) {
             throw new ChainNotFoundError();
         }
         const erc7677client = client;
+        // TODO: probably need to handle the sponsor and isFinal fields
         const { paymaster, paymasterAndData, paymasterData, paymasterPostOpGasLimit, paymasterVerificationGasLimit, } = await erc7677client.request({
             method: "pm_getPaymasterStubData",
             params: [userOp, entrypoint.address, toHex(client.chain.id), context],

package/dist/esm/middleware/erc7677middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"erc7677middleware.js","sourceRoot":"","sources":["../../../src/middleware/erc7677middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,GAMN,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAOzD,OAAO,EACL,WAAW,EACX,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAyE3B,MAAM,UAAU,iBAAiB,CAK/B,MAA0C;IAE1C,MAAM,qBAAqB,GAAuB,KAAK,EACrD,EAAE,EACF,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,EAC1C,EAAE;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QAGxD,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACpC,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACpC,MAAM,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAElC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAE3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,MAAM,CAAC,6BAA6B,GAAG,KAAK,CAAC;YAC7C,MAAM,CAAC,uBAAuB,GAAG,KAAK,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GACX,CAAC,OAAO,MAAM,EAAE,OAAO,KAAK,UAAU;YACpC,CAAC,CAAC,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;YAC1D,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,aAAa,GAAG,MAAuB,CAAC;QAE9C,MAAM,EACJ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,6BAA6B,GAC9B,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC;YAC9B,MAAM,EAAE,yBAAyB;YACjC,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;SACtE,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,EAAE;gBACL,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,EAAE;YACL,SAAS;YACT,aAAa;YACb,uBAAuB;YACvB,6BAA6B;SAC9B,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAuB,KAAK,EAChD,EAAE,EACF,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,EAC1C,EAAE;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QACxD,MAAM,OAAO,GACX,CAAC,OAAO,MAAM,EAAE,OAAO,KAAK,UAAU;YACpC,CAAC,CAAC,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;YAC1D,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,aAAa,GAAG,MAAuB,CAAC;QAE9C,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAC3C,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAClD,MAAM,aAAa,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,qBAAqB;YAC7B,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;SACtE,CAAC,CAAC;QAEL,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,EAAE;gBACL,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,EAAE;YACL,SAAS;YACT,aAAa;SACd,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,qBAAqB;QACrB,gBAAgB;KACjB,CAAC;AACJ,CAAC","sourcesContent":["import {\n  toHex,\n  type Address,\n  type Chain,\n  type Client,\n  type Hex,\n  type Transport,\n} from \"viem\";\nimport type { ClientMiddlewareConfig } from \"../client/types\";\nimport type { EntryPointVersion } from \"../entrypoint/types\";\nimport { ChainNotFoundError } from \"../errors/client.js\";\nimport type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationRequest,\n  UserOperationStruct,\n} from \"../types\";\nimport {\n  deepHexlify,\n  resolveProperties,\n  type Deferrable,\n} from \"../utils/index.js\";\nimport type { ClientMiddlewareFn } from \"./types\";\n\nexport type Erc7677RpcSchema = [\n  {\n    Method: \"pm_getPaymasterStubData\";\n    Parameters: [UserOperationRequest, Address, Hex, Record<string, any>];\n    ReturnType: {\n      sponsor?: { name: string; icon?: string }; // Sponsor info\n      paymaster?: Address; // Paymaster address (entrypoint v0.7)\n      paymasterData?: Hex; // Paymaster data (entrypoint v0.7)\n      paymasterVerificationGasLimit?: Hex; // Paymaster validation gas (entrypoint v0.7)\n      paymasterPostOpGasLimit?: Hex; // Paymaster post-op gas (entrypoint v0.7)\n      paymasterAndData?: Hex; // Paymaster and data (entrypoint v0.6)\n      isFinal?: boolean; // Indicates that the caller does not need to call pm_getPaymasterData\n    };\n  },\n  {\n    Method: \"pm_getPaymasterData\";\n    Parameters: [UserOperationRequest, Address, Hex, Record<string, any>];\n    ReturnType: {\n      paymaster?: Address; // Paymaster address (entrypoint v0.7)\n      paymasterData?: Hex; // Paymaster data (entrypoint v0.7)\n      paymasterAndData?: Hex; // Paymaster and data (entrypoint v0.6)\n    };\n  }\n];\n\nexport type Erc7677Client<T extends Transport = Transport> = Client<\n  T,\n  Chain,\n  undefined,\n  Erc7677RpcSchema\n>;\n\nexport type Erc7677MiddlewareParams<\n  TContext extends Record<string, any> | undefined =\n    | Record<string, any>\n    | undefined,\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = {\n  context?:\n    | ((\n        struct: Deferrable<UserOperationStruct<TEntryPointVersion>>,\n        args: {\n          overrides?: UserOperationOverrides<TEntryPointVersion>;\n          feeOptions?: UserOperationFeeOptions;\n        }\n      ) => Promise<TContext>)\n    | TContext;\n};\n\n/**\n * Middleware function for interacting with ERC-7677 enabled clients. It supports resolving paymaster and data fields for user operations.\n * This middleware assumes that your RPC provider supports the ERC-7677 methods (pm_getPaymasterStubData and pm_getPaymasterData).\n *\n * @example\n * ```ts\n * import { createSmartAccountClient, erc7677Middleware } from \"@aa-sdk/core\";\n * import { http } from \"viem\";\n * import { sepolia } from \"viem/chains\";\n *\n * const client = createSmartAccountClient({\n *  transport: http(\"rpc-url\"),\n *  chain: sepolia,\n *  // this assumes that your RPC provider supports the ERC-7677 methods AND takes no context\n *  ...erc7677Middleware(),\n * })\n * ```\n *\n * @param {Erc7677MiddlewareParams<TContext>} params Middleware parameters including context function or object. Context can be resolved dynamically by passing in a function which takes in the context at the time of sending a user op\n * @returns {Pick<ClientMiddlewareConfig, \"dummyPaymasterAndData\" | \"paymasterAndData\">} An object containing middleware functions `dummyPaymasterAndData` and `paymasterAndData` for processing user operations with the paymaster data\n */\nexport function erc7677Middleware<\n  TContext extends Record<string, any> | undefined =\n    | Record<string, any>\n    | undefined\n>(\n  params?: Erc7677MiddlewareParams<TContext>\n): Pick<ClientMiddlewareConfig, \"dummyPaymasterAndData\" | \"paymasterAndData\"> {\n  const dummyPaymasterAndData: ClientMiddlewareFn = async (\n    uo,\n    { client, account, feeOptions, overrides }\n  ) => {\n    const userOp = deepHexlify(await resolveProperties(uo));\n\n    // Those values will be set after fee estimation.\n    userOp.maxFeePerGas = \"0x0\";\n    userOp.maxPriorityFeePerGas = \"0x0\";\n    userOp.callGasLimit = \"0x0\";\n    userOp.verificationGasLimit = \"0x0\";\n    userOp.preVerificationGas = \"0x0\";\n\n    const entrypoint = account.getEntryPoint();\n\n    if (entrypoint.version === \"0.7.0\") {\n      userOp.paymasterVerificationGasLimit = \"0x0\";\n      userOp.paymasterPostOpGasLimit = \"0x0\";\n    }\n\n    const context =\n      (typeof params?.context === \"function\"\n        ? await params?.context(userOp, { overrides, feeOptions })\n        : params?.context) ?? {};\n\n    if (!client.chain) {\n      throw new ChainNotFoundError();\n    }\n\n    const erc7677client = client as Erc7677Client;\n    // TODO: probably need to handle the sponsor and isFinal fields\n    const {\n      paymaster,\n      paymasterAndData,\n      paymasterData,\n      paymasterPostOpGasLimit,\n      paymasterVerificationGasLimit,\n    } = await erc7677client.request({\n      method: \"pm_getPaymasterStubData\",\n      params: [userOp, entrypoint.address, toHex(client.chain.id), context],\n    });\n\n    if (entrypoint.version === \"0.6.0\") {\n      return {\n        ...uo,\n        paymasterAndData,\n      };\n    }\n\n    return {\n      ...uo,\n      paymaster,\n      paymasterData,\n      paymasterPostOpGasLimit,\n      paymasterVerificationGasLimit,\n    };\n  };\n\n  const paymasterAndData: ClientMiddlewareFn = async (\n    uo,\n    { client, account, feeOptions, overrides }\n  ) => {\n    const userOp = deepHexlify(await resolveProperties(uo));\n    const context =\n      (typeof params?.context === \"function\"\n        ? await params?.context(userOp, { overrides, feeOptions })\n        : params?.context) ?? {};\n\n    if (!client.chain) {\n      throw new ChainNotFoundError();\n    }\n\n    const erc7677client = client as Erc7677Client;\n\n    const entrypoint = account.getEntryPoint();\n    const { paymaster, paymasterAndData, paymasterData } =\n      await erc7677client.request({\n        method: \"pm_getPaymasterData\",\n        params: [userOp, entrypoint.address, toHex(client.chain.id), context],\n      });\n\n    if (entrypoint.version === \"0.6.0\") {\n      return {\n        ...uo,\n        paymasterAndData,\n      };\n    }\n\n    return {\n      ...uo,\n      paymaster,\n      paymasterData,\n    };\n  };\n\n  return {\n    dummyPaymasterAndData,\n    paymasterAndData,\n  };\n}\n"]}
+{"version":3,"file":"erc7677middleware.js","sourceRoot":"","sources":["../../../src/middleware/erc7677middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,GAMN,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAOzD,OAAO,EACL,WAAW,EACX,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAoD3B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,iBAAiB,CAK/B,MAA0C;IAE1C,MAAM,qBAAqB,GAAuB,KAAK,EACrD,EAAE,EACF,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,EAC1C,EAAE;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QAExD,iDAAiD;QACjD,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACpC,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACpC,MAAM,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAElC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAE3C,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,MAAM,CAAC,6BAA6B,GAAG,KAAK,CAAC;YAC7C,MAAM,CAAC,uBAAuB,GAAG,KAAK,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GACX,CAAC,OAAO,MAAM,EAAE,OAAO,KAAK,UAAU;YACpC,CAAC,CAAC,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;YAC1D,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,aAAa,GAAG,MAAuB,CAAC;QAC9C,+DAA+D;QAC/D,MAAM,EACJ,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,6BAA6B,GAC9B,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC;YAC9B,MAAM,EAAE,yBAAyB;YACjC,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;SACtE,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,EAAE;gBACL,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,EAAE;YACL,SAAS;YACT,aAAa;YACb,uBAAuB;YACvB,6BAA6B;SAC9B,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAuB,KAAK,EAChD,EAAE,EACF,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,EAC1C,EAAE;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QACxD,MAAM,OAAO,GACX,CAAC,OAAO,MAAM,EAAE,OAAO,KAAK,UAAU;YACpC,CAAC,CAAC,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;YAC1D,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACjC,CAAC;QAED,MAAM,aAAa,GAAG,MAAuB,CAAC;QAE9C,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAC3C,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAClD,MAAM,aAAa,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,qBAAqB;YAC7B,MAAM,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;SACtE,CAAC,CAAC;QAEL,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,EAAE;gBACL,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,EAAE;YACL,SAAS;YACT,aAAa;SACd,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,qBAAqB;QACrB,gBAAgB;KACjB,CAAC;AACJ,CAAC","sourcesContent":["import {\n  toHex,\n  type Address,\n  type Chain,\n  type Client,\n  type Hex,\n  type Transport,\n} from \"viem\";\nimport type { ClientMiddlewareConfig } from \"../client/types\";\nimport type { EntryPointVersion } from \"../entrypoint/types\";\nimport { ChainNotFoundError } from \"../errors/client.js\";\nimport type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationRequest,\n  UserOperationStruct,\n} from \"../types\";\nimport {\n  deepHexlify,\n  resolveProperties,\n  type Deferrable,\n} from \"../utils/index.js\";\nimport type { ClientMiddlewareFn } from \"./types\";\n\nexport type Erc7677RpcSchema = [\n  {\n    Method: \"pm_getPaymasterStubData\";\n    Parameters: [UserOperationRequest, Address, Hex, Record<string, any>];\n    ReturnType: {\n      sponsor?: { name: string; icon?: string }; // Sponsor info\n      paymaster?: Address; // Paymaster address (entrypoint v0.7)\n      paymasterData?: Hex; // Paymaster data (entrypoint v0.7)\n      paymasterVerificationGasLimit?: Hex; // Paymaster validation gas (entrypoint v0.7)\n      paymasterPostOpGasLimit?: Hex; // Paymaster post-op gas (entrypoint v0.7)\n      paymasterAndData?: Hex; // Paymaster and data (entrypoint v0.6)\n      isFinal?: boolean; // Indicates that the caller does not need to call pm_getPaymasterData\n    };\n  },\n  {\n    Method: \"pm_getPaymasterData\";\n    Parameters: [UserOperationRequest, Address, Hex, Record<string, any>];\n    ReturnType: {\n      paymaster?: Address; // Paymaster address (entrypoint v0.7)\n      paymasterData?: Hex; // Paymaster data (entrypoint v0.7)\n      paymasterAndData?: Hex; // Paymaster and data (entrypoint v0.6)\n    };\n  }\n];\n\nexport type Erc7677Client<T extends Transport = Transport> = Client<\n  T,\n  Chain,\n  undefined,\n  Erc7677RpcSchema\n>;\n\nexport type Erc7677MiddlewareParams<\n  TContext extends Record<string, any> | undefined =\n    | Record<string, any>\n    | undefined,\n  TEntryPointVersion extends EntryPointVersion = EntryPointVersion\n> = {\n  context?:\n    | ((\n        struct: Deferrable<UserOperationStruct<TEntryPointVersion>>,\n        args: {\n          overrides?: UserOperationOverrides<TEntryPointVersion>;\n          feeOptions?: UserOperationFeeOptions;\n        }\n      ) => Promise<TContext>)\n    | TContext;\n};\n\n/**\n * Middleware function for interacting with ERC-7677 enabled clients. It supports resolving paymaster and data fields for user operations.\n * This middleware assumes that your RPC provider supports the ERC-7677 methods (pm_getPaymasterStubData and pm_getPaymasterData).\n *\n * @example\n * ```ts\n * import { createSmartAccountClient, erc7677Middleware } from \"@aa-sdk/core\";\n * import { http } from \"viem\";\n * import { sepolia } from \"viem/chains\";\n *\n * const client = createSmartAccountClient({\n *  transport: http(\"rpc-url\"),\n *  chain: sepolia,\n *  // this assumes that your RPC provider supports the ERC-7677 methods AND takes no context\n *  ...erc7677Middleware(),\n * })\n * ```\n *\n * @param {Erc7677MiddlewareParams<TContext>} params Middleware parameters including context function or object. Context can be resolved dynamically by passing in a function which takes in the context at the time of sending a user op\n * @returns {Pick<ClientMiddlewareConfig, \"dummyPaymasterAndData\" | \"paymasterAndData\">} An object containing middleware functions `dummyPaymasterAndData` and `paymasterAndData` for processing user operations with the paymaster data\n */\nexport function erc7677Middleware<\n  TContext extends Record<string, any> | undefined =\n    | Record<string, any>\n    | undefined\n>(\n  params?: Erc7677MiddlewareParams<TContext>\n): Pick<ClientMiddlewareConfig, \"dummyPaymasterAndData\" | \"paymasterAndData\"> {\n  const dummyPaymasterAndData: ClientMiddlewareFn = async (\n    uo,\n    { client, account, feeOptions, overrides }\n  ) => {\n    const userOp = deepHexlify(await resolveProperties(uo));\n\n    // Those values will be set after fee estimation.\n    userOp.maxFeePerGas = \"0x0\";\n    userOp.maxPriorityFeePerGas = \"0x0\";\n    userOp.callGasLimit = \"0x0\";\n    userOp.verificationGasLimit = \"0x0\";\n    userOp.preVerificationGas = \"0x0\";\n\n    const entrypoint = account.getEntryPoint();\n\n    if (entrypoint.version === \"0.7.0\") {\n      userOp.paymasterVerificationGasLimit = \"0x0\";\n      userOp.paymasterPostOpGasLimit = \"0x0\";\n    }\n\n    const context =\n      (typeof params?.context === \"function\"\n        ? await params?.context(userOp, { overrides, feeOptions })\n        : params?.context) ?? {};\n\n    if (!client.chain) {\n      throw new ChainNotFoundError();\n    }\n\n    const erc7677client = client as Erc7677Client;\n    // TODO: probably need to handle the sponsor and isFinal fields\n    const {\n      paymaster,\n      paymasterAndData,\n      paymasterData,\n      paymasterPostOpGasLimit,\n      paymasterVerificationGasLimit,\n    } = await erc7677client.request({\n      method: \"pm_getPaymasterStubData\",\n      params: [userOp, entrypoint.address, toHex(client.chain.id), context],\n    });\n\n    if (entrypoint.version === \"0.6.0\") {\n      return {\n        ...uo,\n        paymasterAndData,\n      };\n    }\n\n    return {\n      ...uo,\n      paymaster,\n      paymasterData,\n      paymasterPostOpGasLimit,\n      paymasterVerificationGasLimit,\n    };\n  };\n\n  const paymasterAndData: ClientMiddlewareFn = async (\n    uo,\n    { client, account, feeOptions, overrides }\n  ) => {\n    const userOp = deepHexlify(await resolveProperties(uo));\n    const context =\n      (typeof params?.context === \"function\"\n        ? await params?.context(userOp, { overrides, feeOptions })\n        : params?.context) ?? {};\n\n    if (!client.chain) {\n      throw new ChainNotFoundError();\n    }\n\n    const erc7677client = client as Erc7677Client;\n\n    const entrypoint = account.getEntryPoint();\n    const { paymaster, paymasterAndData, paymasterData } =\n      await erc7677client.request({\n        method: \"pm_getPaymasterData\",\n        params: [userOp, entrypoint.address, toHex(client.chain.id), context],\n      });\n\n    if (entrypoint.version === \"0.6.0\") {\n      return {\n        ...uo,\n        paymasterAndData,\n      };\n    }\n\n    return {\n      ...uo,\n      paymaster,\n      paymasterData,\n    };\n  };\n\n  return {\n    dummyPaymasterAndData,\n    paymasterAndData,\n  };\n}\n"]}

package/dist/esm/middleware/noopMiddleware.d.ts

@@ -1,3 +1,9 @@
 import type { UserOperationContext } from "../actions/smartAccount/types";
 import type { ClientMiddlewareFn } from "./types";
+/**
+ * Noop middleware that does nothing and passes the arguments through
+ *
+ * @param {Deferrable<UserOperationStruct<TEntryPointVersion>>} args the client middleware arguments passed to the middleware
+ * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} the arguments passed to the middleware and returned as is without modification
+ */
 export declare const noopMiddleware: ClientMiddlewareFn<UserOperationContext | undefined>;

package/dist/esm/middleware/noopMiddleware.js

@@ -1,3 +1,9 @@
+/**
+ * Noop middleware that does nothing and passes the arguments through
+ *
+ * @param {Deferrable<UserOperationStruct<TEntryPointVersion>>} args the client middleware arguments passed to the middleware
+ * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} the arguments passed to the middleware and returned as is without modification
+ */
 export const noopMiddleware = async (args) => {
     return args;
 };

package/dist/esm/middleware/noopMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"noopMiddleware.js","sourceRoot":"","sources":["../../../src/middleware/noopMiddleware.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,cAAc,GAEvB,KAAK,EAAE,IAAI,EAAE,EAAE;IACjB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC","sourcesContent":["import type { UserOperationContext } from \"../actions/smartAccount/types\";\nimport type { ClientMiddlewareFn } from \"./types\";\n\n/**\n * Noop middleware that does nothing and passes the arguments through\n *\n * @param {Deferrable<UserOperationStruct<TEntryPointVersion>>} args the client middleware arguments passed to the middleware\n * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} the arguments passed to the middleware and returned as is without modification\n */\nexport const noopMiddleware: ClientMiddlewareFn<\n  UserOperationContext | undefined\n> = async (args) => {\n  return args;\n};\n"]}
+{"version":3,"file":"noopMiddleware.js","sourceRoot":"","sources":["../../../src/middleware/noopMiddleware.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAEvB,KAAK,EAAE,IAAI,EAAE,EAAE;IACjB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC","sourcesContent":["import type { UserOperationContext } from \"../actions/smartAccount/types\";\nimport type { ClientMiddlewareFn } from \"./types\";\n\n/**\n * Noop middleware that does nothing and passes the arguments through\n *\n * @param {Deferrable<UserOperationStruct<TEntryPointVersion>>} args the client middleware arguments passed to the middleware\n * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} the arguments passed to the middleware and returned as is without modification\n */\nexport const noopMiddleware: ClientMiddlewareFn<\n  UserOperationContext | undefined\n> = async (args) => {\n  return args;\n};\n"]}

package/dist/esm/middleware/types.js

@@ -1,2 +1,3 @@
 export {};
+// [!endregion ClientMiddleware]
 //# sourceMappingURL=types.js.map

package/dist/esm/middleware/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/middleware/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  GetEntryPointFromAccount,\n  SmartContractAccount,\n} from \"../account/smartContractAccount\";\nimport type { UserOperationContext } from \"../actions/smartAccount/types\";\nimport type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationStruct,\n} from \"../types\";\nimport type { Deferrable } from \"../utils\";\nimport type { MiddlewareClient } from \"./actions\";\n\nexport type ClientMiddlewareArgs<\n  TAccount extends SmartContractAccount,\n  C extends MiddlewareClient,\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined,\n  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>\n> = {\n  overrides?: UserOperationOverrides<TEntryPointVersion>;\n  context?: TContext;\n  feeOptions?: UserOperationFeeOptions;\n  account: TAccount;\n  client: C;\n};\n\n// [!region ClientMiddlewareFn]\nexport type ClientMiddlewareFn<\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined\n> = <\n  TAccount extends SmartContractAccount,\n  C extends MiddlewareClient,\n  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>\n>(\n  struct: Deferrable<UserOperationStruct<TEntryPointVersion>>,\n  args: ClientMiddlewareArgs<TAccount, C, TContext, TEntryPointVersion>\n) => Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>;\n// [!endregion ClientMiddlewareFn]\n\n// [!region ClientMiddleware]\nexport type ClientMiddleware<\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined\n> = {\n  dummyPaymasterAndData: ClientMiddlewareFn<TContext>;\n  feeEstimator: ClientMiddlewareFn<TContext>;\n  gasEstimator: ClientMiddlewareFn<TContext>;\n  customMiddleware: ClientMiddlewareFn<TContext>;\n  paymasterAndData: ClientMiddlewareFn<TContext>;\n  userOperationSimulator: ClientMiddlewareFn<TContext>;\n  signUserOperation: ClientMiddlewareFn<TContext>;\n};\n// [!endregion ClientMiddleware]\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/middleware/types.ts"],"names":[],"mappings":";AAyDA,gCAAgC","sourcesContent":["import type {\n  GetEntryPointFromAccount,\n  SmartContractAccount,\n} from \"../account/smartContractAccount\";\nimport type { UserOperationContext } from \"../actions/smartAccount/types\";\nimport type {\n  UserOperationFeeOptions,\n  UserOperationOverrides,\n  UserOperationStruct,\n} from \"../types\";\nimport type { Deferrable } from \"../utils\";\nimport type { MiddlewareClient } from \"./actions\";\n\nexport type ClientMiddlewareArgs<\n  TAccount extends SmartContractAccount,\n  C extends MiddlewareClient,\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined,\n  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>\n> = {\n  overrides?: UserOperationOverrides<TEntryPointVersion>;\n  context?: TContext;\n  feeOptions?: UserOperationFeeOptions;\n  account: TAccount;\n  client: C;\n};\n\n// [!region ClientMiddlewareFn]\nexport type ClientMiddlewareFn<\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined\n> = <\n  TAccount extends SmartContractAccount,\n  C extends MiddlewareClient,\n  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>\n>(\n  struct: Deferrable<UserOperationStruct<TEntryPointVersion>>,\n  args: ClientMiddlewareArgs<TAccount, C, TContext, TEntryPointVersion>\n) => Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>;\n// [!endregion ClientMiddlewareFn]\n\n// [!region ClientMiddleware]\nexport type ClientMiddleware<\n  TContext extends UserOperationContext | undefined =\n    | UserOperationContext\n    | undefined\n> = {\n  dummyPaymasterAndData: ClientMiddlewareFn<TContext>;\n  feeEstimator: ClientMiddlewareFn<TContext>;\n  gasEstimator: ClientMiddlewareFn<TContext>;\n  customMiddleware: ClientMiddlewareFn<TContext>;\n  paymasterAndData: ClientMiddlewareFn<TContext>;\n  userOperationSimulator: ClientMiddlewareFn<TContext>;\n  signUserOperation: ClientMiddlewareFn<TContext>;\n};\n// [!endregion ClientMiddleware]\n"]}

package/dist/esm/signer/local-account.d.ts

@@ -1,10 +1,63 @@
 import { type HDAccount, type HDOptions, type Hex, type LocalAccount, type PrivateKeyAccount, type SignableMessage, type TypedDataDefinition } from "viem";
 import type { SmartAccountSigner } from "./types.js";
+/**
+ * Represents a local account signer and provides methods to sign messages and transactions, as well as static methods to create the signer from mnemonic or private key.
+ */
 export declare class LocalAccountSigner<T extends HDAccount | PrivateKeyAccount | LocalAccount> implements SmartAccountSigner<T> {
     inner: T;
     signerType: string;
+    /**
+     * A function to initialize an object with an inner parameter and derive a signerType from it.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { privateKeyToAccount, generatePrivateKey } from "viem";
+     *
+     * const signer = new LocalAccountSigner(
+     *  privateKeyToAccount(generatePrivateKey()),
+     * );
+     * ```
+     *
+     * @param {T} inner The inner parameter containing the necessary data
+     */
     constructor(inner: T);
+    /**
+     * Signs the provided message using the inner signMessage function.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { generatePrivateKey } from "viem";
+     *
+     * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());
+     * const signature = await signer.signMessage("Hello, world!");
+     * ```
+     *
+     * @param {string} message The message to be signed
+     * @returns {Promise<any>} A promise that resolves to the signed message
+     */
     readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`>;
+    /**
+     * Signs typed data using the given parameters.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { generatePrivateKey } from "viem";
+     *
+     * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());
+     * const signature = await signer.signTypedData({
+     *  domain: {},
+     *  types: {},
+     *  primaryType: "",
+     *  message: {},
+     * });
+     * ```
+     *
+     * @param {TypedDataDefinition<TTypedData, TPrimaryType>} params The parameters defining the typed data and primary type
+     * @returns {Promise<Hex>} A promise that resolves to the signed data in hexadecimal format
+     */
     readonly signTypedData: <const TTypedData extends {
         [x: string]: readonly import("viem").TypedDataParameter[];
         [x: `string[${string}]`]: undefined;
@@ -213,7 +266,49 @@ export declare class LocalAccountSigner<T extends HDAccount | PrivateKeyAccount
     } | {
         [key: string]: unknown;
     }, TPrimaryType extends string = string>(params: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hex>;
+    /**
+     * Returns the address of the inner object in a specific hexadecimal format.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { generatePrivateKey } from "viem";
+     *
+     * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());
+     * const address = await signer.getAddress();
+     * ```
+     *
+     * @returns {Promise<Hex>} A promise that resolves to the address in the format `0x{string}`
+     */
     readonly getAddress: () => Promise<`0x${string}`>;
+    /**
+     * Creates a LocalAccountSigner using the provided mnemonic key and optional HD options.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { generateMnemonic } from "viem";
+     *
+     * const signer = LocalAccountSigner.mnemonicToAccountSigner(generateMnemonic());
+     * ```
+     *
+     * @param {string} key The mnemonic key to derive the account from.
+     * @param {HDOptions} [opts] Optional HD options for deriving the account.
+     * @returns {LocalAccountSigner<HDAccount>} A LocalAccountSigner object for the derived account.
+     */
     static mnemonicToAccountSigner(key: string, opts?: HDOptions): LocalAccountSigner<HDAccount>;
-    static privateKeyToAccountSigner(key: Hex): LocalAccountSigner<PrivateKeyAccount>;
+    /**
+     * Creates a `LocalAccountSigner` instance using the provided private key.
+     *
+     * @example
+     * ```ts
+     * import { LocalAccountSigner } from "@aa-sdk/core";
+     * import { generatePrivateKey } from "viem";
+     *
+     * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());
+     * ```
+     *
+     * @param {Hex} key The private key in hexadecimal format
+     * @returns {LocalAccountSigner<PrivateKeyAccount>} An instance of `LocalAccountSigner` initialized with the provided private key
+     */ static privateKeyToAccountSigner(key: Hex): LocalAccountSigner<PrivateKeyAccount>;
 }