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

package/dist/esm/signer/local-account.js

@@ -1,6 +1,24 @@
 import {} from "viem";
 import { mnemonicToAccount, privateKeyToAccount } from "viem/accounts";
+/**
+ * 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 class LocalAccountSigner {
+    /**
+     * 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) {
         Object.defineProperty(this, "inner", {
             enumerable: true,
@@ -14,6 +32,21 @@ export class LocalAccountSigner {
             writable: true,
             value: void 0
         });
+        /**
+         * 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
+         */
         Object.defineProperty(this, "signMessage", {
             enumerable: true,
             configurable: true,
@@ -22,6 +55,26 @@ export class LocalAccountSigner {
                 return this.inner.signMessage({ message });
             }
         });
+        /**
+         * 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
+         */
         Object.defineProperty(this, "signTypedData", {
             enumerable: true,
             configurable: true,
@@ -30,6 +83,20 @@ export class LocalAccountSigner {
                 return this.inner.signTypedData(params);
             }
         });
+        /**
+         * 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}`
+         */
         Object.defineProperty(this, "getAddress", {
             enumerable: true,
             configurable: true,
@@ -39,13 +106,41 @@ export class LocalAccountSigner {
             }
         });
         this.inner = inner;
-        this.signerType = inner.type;
+        this.signerType = inner.type; //  type: "local"
     }
+    /**
+     * 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, opts) {
         const signer = mnemonicToAccount(key, opts);
         return new LocalAccountSigner(signer);
     }
-    static privateKeyToAccountSigner(key) {
+    /**
+     * 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) {
         const signer = privateKeyToAccount(key);
         return new LocalAccountSigner(signer);
     }

package/dist/esm/signer/local-account.js.map

@@ -1 +1 @@
-{"version":3,"file":"local-account.js","sourceRoot":"","sources":["../../../src/signer/local-account.ts"],"names":[],"mappings":"AAAA,OAAO,EASN,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAMvE,MAAM,OAAO,kBAAkB;IAsB7B,YAAY,KAAQ;QAlBpB;;;;;WAAS;QACT;;;;;WAAmB;QAqCV;;;;mBAAoE,CAC3E,OAAO,EACP,EAAE;gBACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7C,CAAC;WAAC;QAsBO;;;;mBAAgB,KAAK,EAI5B,MAAqD,EACvC,EAAE;gBAChB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC1C,CAAC;WAAC;QAgBO;;;;mBAAa,KAAK,IAA4B,EAAE;gBACvD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YAC5B,CAAC;WAAC;QAtEA,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;IAC/B,CAAC;IAqFD,MAAM,CAAC,uBAAuB,CAC5B,GAAW,EACX,IAAgB;QAEhB,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAeG,MAAM,CAAC,yBAAyB,CAClC,GAAQ;QAER,MAAM,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF","sourcesContent":["import {\n  type HDAccount,\n  type HDOptions,\n  type Hex,\n  type LocalAccount,\n  type PrivateKeyAccount,\n  type SignableMessage,\n  type TypedData,\n  type TypedDataDefinition,\n} from \"viem\";\nimport { mnemonicToAccount, privateKeyToAccount } from \"viem/accounts\";\nimport type { SmartAccountSigner } from \"./types.js\";\n\n/**\n * 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.\n */\nexport class LocalAccountSigner<\n  T extends HDAccount | PrivateKeyAccount | LocalAccount\n> implements SmartAccountSigner<T>\n{\n  inner: T;\n  signerType: string;\n\n  /**\n   * A function to initialize an object with an inner parameter and derive a signerType from it.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { privateKeyToAccount, generatePrivateKey } from \"viem\";\n   *\n   * const signer = new LocalAccountSigner(\n   *  privateKeyToAccount(generatePrivateKey()),\n   * );\n   * ```\n   *\n   * @param {T} inner The inner parameter containing the necessary data\n   */\n  constructor(inner: T) {\n    this.inner = inner;\n    this.signerType = inner.type; //  type: \"local\"\n  }\n\n  /**\n   * Signs the provided message using the inner signMessage function.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const signature = await signer.signMessage(\"Hello, world!\");\n   * ```\n   *\n   * @param {string} message The message to be signed\n   * @returns {Promise<any>} A promise that resolves to the signed message\n   */\n  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> = (\n    message\n  ) => {\n    return this.inner.signMessage({ message });\n  };\n\n  /**\n   * Signs typed data using the given parameters.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const signature = await signer.signTypedData({\n   *  domain: {},\n   *  types: {},\n   *  primaryType: \"\",\n   *  message: {},\n   * });\n   * ```\n   *\n   * @param {TypedDataDefinition<TTypedData, TPrimaryType>} params The parameters defining the typed data and primary type\n   * @returns {Promise<Hex>} A promise that resolves to the signed data in hexadecimal format\n   */\n  readonly signTypedData = async <\n    const TTypedData extends TypedData | { [key: string]: unknown },\n    TPrimaryType extends string = string\n  >(\n    params: TypedDataDefinition<TTypedData, TPrimaryType>\n  ): Promise<Hex> => {\n    return this.inner.signTypedData(params);\n  };\n\n  /**\n   * Returns the address of the inner object in a specific hexadecimal format.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const address = await signer.getAddress();\n   * ```\n   *\n   * @returns {Promise<Hex>} A promise that resolves to the address in the format `0x{string}`\n   */\n  readonly getAddress = async (): Promise<`0x${string}`> => {\n    return this.inner.address;\n  };\n\n  /**\n   * Creates a LocalAccountSigner using the provided mnemonic key and optional HD options.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generateMnemonic } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generateMnemonic());\n   * ```\n   *\n   * @param {string} key The mnemonic key to derive the account from.\n   * @param {HDOptions} [opts] Optional HD options for deriving the account.\n   * @returns {LocalAccountSigner<HDAccount>} A LocalAccountSigner object for the derived account.\n   */\n  static mnemonicToAccountSigner(\n    key: string,\n    opts?: HDOptions\n  ): LocalAccountSigner<HDAccount> {\n    const signer = mnemonicToAccount(key, opts);\n    return new LocalAccountSigner(signer);\n  }\n\n  /**\n   * Creates a `LocalAccountSigner` instance using the provided private key.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * ```\n   *\n   * @param {Hex} key The private key in hexadecimal format\n   * @returns {LocalAccountSigner<PrivateKeyAccount>} An instance of `LocalAccountSigner` initialized with the provided private key\n   */ static privateKeyToAccountSigner(\n    key: Hex\n  ): LocalAccountSigner<PrivateKeyAccount> {\n    const signer = privateKeyToAccount(key);\n    return new LocalAccountSigner(signer);\n  }\n}\n"]}
+{"version":3,"file":"local-account.js","sourceRoot":"","sources":["../../../src/signer/local-account.ts"],"names":[],"mappings":"AAAA,OAAO,EASN,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAO7B;;;;;;;;;;;;;;OAcG;IACH,YAAY,KAAQ;QAlBpB;;;;;WAAS;QACT;;;;;WAAmB;QAsBnB;;;;;;;;;;;;;;WAcG;QACM;;;;mBAAoE,CAC3E,OAAO,EACP,EAAE;gBACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7C,CAAC;WAAC;QAEF;;;;;;;;;;;;;;;;;;;WAmBG;QACM;;;;mBAAgB,KAAK,EAI5B,MAAqD,EACvC,EAAE;gBAChB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC1C,CAAC;WAAC;QAEF;;;;;;;;;;;;;WAaG;QACM;;;;mBAAa,KAAK,IAA4B,EAAE;gBACvD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YAC5B,CAAC;WAAC;QAtEA,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,iBAAiB;IACjD,CAAC;IAsED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,uBAAuB,CAC5B,GAAW,EACX,IAAgB;QAEhB,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;OAaG,CAAC,MAAM,CAAC,yBAAyB,CAClC,GAAQ;QAER,MAAM,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF","sourcesContent":["import {\n  type HDAccount,\n  type HDOptions,\n  type Hex,\n  type LocalAccount,\n  type PrivateKeyAccount,\n  type SignableMessage,\n  type TypedData,\n  type TypedDataDefinition,\n} from \"viem\";\nimport { mnemonicToAccount, privateKeyToAccount } from \"viem/accounts\";\nimport type { SmartAccountSigner } from \"./types.js\";\n\n/**\n * 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.\n */\nexport class LocalAccountSigner<\n  T extends HDAccount | PrivateKeyAccount | LocalAccount\n> implements SmartAccountSigner<T>\n{\n  inner: T;\n  signerType: string;\n\n  /**\n   * A function to initialize an object with an inner parameter and derive a signerType from it.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { privateKeyToAccount, generatePrivateKey } from \"viem\";\n   *\n   * const signer = new LocalAccountSigner(\n   *  privateKeyToAccount(generatePrivateKey()),\n   * );\n   * ```\n   *\n   * @param {T} inner The inner parameter containing the necessary data\n   */\n  constructor(inner: T) {\n    this.inner = inner;\n    this.signerType = inner.type; //  type: \"local\"\n  }\n\n  /**\n   * Signs the provided message using the inner signMessage function.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const signature = await signer.signMessage(\"Hello, world!\");\n   * ```\n   *\n   * @param {string} message The message to be signed\n   * @returns {Promise<any>} A promise that resolves to the signed message\n   */\n  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> = (\n    message\n  ) => {\n    return this.inner.signMessage({ message });\n  };\n\n  /**\n   * Signs typed data using the given parameters.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const signature = await signer.signTypedData({\n   *  domain: {},\n   *  types: {},\n   *  primaryType: \"\",\n   *  message: {},\n   * });\n   * ```\n   *\n   * @param {TypedDataDefinition<TTypedData, TPrimaryType>} params The parameters defining the typed data and primary type\n   * @returns {Promise<Hex>} A promise that resolves to the signed data in hexadecimal format\n   */\n  readonly signTypedData = async <\n    const TTypedData extends TypedData | Record<string, unknown>,\n    TPrimaryType extends keyof TTypedData | \"EIP712Domain\" = keyof TTypedData\n  >(\n    params: TypedDataDefinition<TTypedData, TPrimaryType>\n  ): Promise<Hex> => {\n    return this.inner.signTypedData(params);\n  };\n\n  /**\n   * Returns the address of the inner object in a specific hexadecimal format.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * const address = await signer.getAddress();\n   * ```\n   *\n   * @returns {Promise<Hex>} A promise that resolves to the address in the format `0x{string}`\n   */\n  readonly getAddress = async (): Promise<`0x${string}`> => {\n    return this.inner.address;\n  };\n\n  /**\n   * Creates a LocalAccountSigner using the provided mnemonic key and optional HD options.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generateMnemonic } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generateMnemonic());\n   * ```\n   *\n   * @param {string} key The mnemonic key to derive the account from.\n   * @param {HDOptions} [opts] Optional HD options for deriving the account.\n   * @returns {LocalAccountSigner<HDAccount>} A LocalAccountSigner object for the derived account.\n   */\n  static mnemonicToAccountSigner(\n    key: string,\n    opts?: HDOptions\n  ): LocalAccountSigner<HDAccount> {\n    const signer = mnemonicToAccount(key, opts);\n    return new LocalAccountSigner(signer);\n  }\n\n  /**\n   * Creates a `LocalAccountSigner` instance using the provided private key.\n   *\n   * @example\n   * ```ts\n   * import { LocalAccountSigner } from \"@aa-sdk/core\";\n   * import { generatePrivateKey } from \"viem\";\n   *\n   * const signer = LocalAccountSigner.mnemonicToAccountSigner(generatePrivateKey());\n   * ```\n   *\n   * @param {Hex} key The private key in hexadecimal format\n   * @returns {LocalAccountSigner<PrivateKeyAccount>} An instance of `LocalAccountSigner` initialized with the provided private key\n   */ static privateKeyToAccountSigner(\n    key: Hex\n  ): LocalAccountSigner<PrivateKeyAccount> {\n    const signer = privateKeyToAccount(key);\n    return new LocalAccountSigner(signer);\n  }\n}\n"]}

package/dist/esm/signer/schema.d.ts

@@ -1,4 +1,18 @@
 import { z } from "zod";
 import type { SmartAccountSigner } from "./types";
+/**
+ * Checks if the provided object is a `SmartAccountSigner`.
+ *
+ * @example
+ * ```ts
+ * import { isSigner, LocalAccountSigner } from "@aa-sdk/core";
+ *
+ * const signer = new LocalAccountSigner(...);
+ * console.log(isSigner(signer)); // true
+ * ```
+ *
+ * @param {any} signer the object to check
+ * @returns {boolean} A boolean indicating whether the object is a `SmartAccountSigner`
+ */
 export declare const isSigner: (signer: any) => signer is SmartAccountSigner<any>;
 export declare const SignerSchema: z.ZodType<SmartAccountSigner<any>, z.ZodTypeDef, SmartAccountSigner<any>>;

package/dist/esm/signer/schema.js

@@ -1,4 +1,18 @@
 import { z } from "zod";
+/**
+ * Checks if the provided object is a `SmartAccountSigner`.
+ *
+ * @example
+ * ```ts
+ * import { isSigner, LocalAccountSigner } from "@aa-sdk/core";
+ *
+ * const signer = new LocalAccountSigner(...);
+ * console.log(isSigner(signer)); // true
+ * ```
+ *
+ * @param {any} signer the object to check
+ * @returns {boolean} A boolean indicating whether the object is a `SmartAccountSigner`
+ */
 export const isSigner = (signer) => {
     return (signer != null &&
         typeof signer === "object" &&

package/dist/esm/signer/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/signer/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAW,EAAgC,EAAE;IACpE,OAAO,CACL,MAAM,IAAI,IAAI;QACd,OAAO,MAAM,KAAK,QAAQ;QAC1B,YAAY,IAAI,MAAM;QACtB,aAAa,IAAI,MAAM;QACvB,eAAe,IAAI,MAAM;QACzB,YAAY,IAAI,MAAM;QACtB,OAAO,IAAI,MAAM,CAClB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAqB,QAAQ,CAAC,CAAC","sourcesContent":["import { z } from \"zod\";\nimport type { SmartAccountSigner } from \"./types\";\n\n/**\n * Checks if the provided object is a `SmartAccountSigner`.\n *\n * @example\n * ```ts\n * import { isSigner, LocalAccountSigner } from \"@aa-sdk/core\";\n *\n * const signer = new LocalAccountSigner(...);\n * console.log(isSigner(signer)); // true\n * ```\n *\n * @param {any} signer the object to check\n * @returns {boolean} A boolean indicating whether the object is a `SmartAccountSigner`\n */\nexport const isSigner = (signer: any): signer is SmartAccountSigner => {\n  return (\n    signer != null &&\n    typeof signer === \"object\" &&\n    \"signerType\" in signer &&\n    \"signMessage\" in signer &&\n    \"signTypedData\" in signer &&\n    \"getAddress\" in signer &&\n    \"inner\" in signer\n  );\n};\n\nexport const SignerSchema = z.custom<SmartAccountSigner>(isSigner);\n"]}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/signer/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAW,EAAgC,EAAE;IACpE,OAAO,CACL,MAAM,IAAI,IAAI;QACd,OAAO,MAAM,KAAK,QAAQ;QAC1B,YAAY,IAAI,MAAM;QACtB,aAAa,IAAI,MAAM;QACvB,eAAe,IAAI,MAAM;QACzB,YAAY,IAAI,MAAM;QACtB,OAAO,IAAI,MAAM,CAClB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAqB,QAAQ,CAAC,CAAC","sourcesContent":["import { z } from \"zod\";\nimport type { SmartAccountSigner } from \"./types\";\n\n/**\n * Checks if the provided object is a `SmartAccountSigner`.\n *\n * @example\n * ```ts\n * import { isSigner, LocalAccountSigner } from \"@aa-sdk/core\";\n *\n * const signer = new LocalAccountSigner(...);\n * console.log(isSigner(signer)); // true\n * ```\n *\n * @param {any} signer the object to check\n * @returns {boolean} A boolean indicating whether the object is a `SmartAccountSigner`\n */\nexport const isSigner = (signer: any): signer is SmartAccountSigner => {\n  return (\n    signer != null &&\n    typeof signer === \"object\" &&\n    \"signerType\" in signer &&\n    \"signMessage\" in signer &&\n    \"signTypedData\" in signer &&\n    \"getAddress\" in signer &&\n    \"inner\" in signer\n  );\n};\n\nexport const SignerSchema = z.custom<SmartAccountSigner>(isSigner);\n"]}

package/dist/esm/signer/types.d.ts

@@ -1,15 +1,25 @@
 import type { Address } from "abitype";
 import type { Hex, SignableMessage, TypedData, TypedDataDefinition } from "viem";
+/**
+ * Extends the @interface SmartAccountSigner interface with authentication.
+ *
+ * @template AuthParams - the generic type of the authentication parameters
+ * @template AuthDetails - the generic type of the authentication details
+ * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.
+ */
 export interface SmartAccountAuthenticator<AuthParams, AuthDetails, Inner = any> extends SmartAccountSigner<Inner> {
     authenticate: (params: AuthParams) => Promise<AuthDetails>;
     getAuthDetails: () => Promise<AuthDetails>;
 }
+/**
+ * A signer that can sign messages and typed data.
+ *
+ * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.
+ */
 export interface SmartAccountSigner<Inner = any> {
     signerType: string;
     inner: Inner;
     getAddress: () => Promise<Address>;
     signMessage: (message: SignableMessage) => Promise<Hex>;
-    signTypedData: <const TTypedData extends TypedData | {
-        [key: string]: unknown;
-    }, TPrimaryType extends string = string>(params: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hex>;
+    signTypedData: <const TTypedData extends TypedData | Record<string, unknown>, TPrimaryType extends keyof TTypedData | "EIP712Domain" = keyof TTypedData>(params: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hex>;
 }

package/dist/esm/signer/types.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/signer/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Address } from \"abitype\";\nimport type {\n  Hex,\n  SignableMessage,\n  TypedData,\n  TypedDataDefinition,\n} from \"viem\";\n\n// [!region SmartAccountAuthenticator]\n/**\n * Extends the @interface SmartAccountSigner interface with authentication.\n *\n * @template AuthParams - the generic type of the authentication parameters\n * @template AuthDetails - the generic type of the authentication details\n * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.\n */\nexport interface SmartAccountAuthenticator<AuthParams, AuthDetails, Inner = any>\n  extends SmartAccountSigner<Inner> {\n  authenticate: (params: AuthParams) => Promise<AuthDetails>;\n\n  getAuthDetails: () => Promise<AuthDetails>;\n}\n// [!endregion SmartAccountAuthenticator]\n\n// [!region SmartAccountSigner]\n/**\n * A signer that can sign messages and typed data.\n *\n * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.\n */\nexport interface SmartAccountSigner<Inner = any> {\n  signerType: string;\n  inner: Inner;\n\n  getAddress: () => Promise<Address>;\n\n  signMessage: (message: SignableMessage) => Promise<Hex>;\n\n  signTypedData: <\n    const TTypedData extends TypedData | { [key: string]: unknown },\n    TPrimaryType extends string = string\n  >(\n    params: TypedDataDefinition<TTypedData, TPrimaryType>\n  ) => Promise<Hex>;\n}\n// [!endregion SmartAccountSigner]\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/signer/types.ts"],"names":[],"mappings":";AA6CA,kCAAkC","sourcesContent":["import type { Address } from \"abitype\";\nimport type {\n  Hex,\n  SignableMessage,\n  TypedData,\n  TypedDataDefinition,\n} from \"viem\";\n\n// [!region SmartAccountAuthenticator]\n/**\n * Extends the @interface SmartAccountSigner interface with authentication.\n *\n * @template AuthParams - the generic type of the authentication parameters\n * @template AuthDetails - the generic type of the authentication details\n * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.\n */\nexport interface SmartAccountAuthenticator<AuthParams, AuthDetails, Inner = any>\n  extends SmartAccountSigner<Inner> {\n  authenticate: (params: AuthParams) => Promise<AuthDetails>;\n\n  getAuthDetails: () => Promise<AuthDetails>;\n}\n// [!endregion SmartAccountAuthenticator]\n\n// [!region SmartAccountSigner]\n/**\n * A signer that can sign messages and typed data.\n *\n * @template Inner - the generic type of the inner client that the signer wraps to provide functionality such as signing, etc.\n */\nexport interface SmartAccountSigner<Inner = any> {\n  signerType: string;\n  inner: Inner;\n\n  getAddress: () => Promise<Address>;\n\n  signMessage: (message: SignableMessage) => Promise<Hex>;\n\n  signTypedData: <\n    const TTypedData extends TypedData | Record<string, unknown>,\n    TPrimaryType extends keyof TTypedData | \"EIP712Domain\" = keyof TTypedData\n  >(\n    params: TypedDataDefinition<TTypedData, TPrimaryType>\n  ) => Promise<Hex>;\n}\n// [!endregion SmartAccountSigner]\n"]}

package/dist/esm/signer/utils.d.ts

@@ -4,4 +4,24 @@ export type SignWith6492Params = {
     factoryCalldata: Hex;
     signature: Hash;
 };
+/**
+ * Wraps a given signature with additional data following the EIP-6492 standard.
+ *
+ * @example
+ * ```ts
+ * import { wrapSignatureWith6492 } from "@aa-sdk/core";
+ *
+ * const signature = wrapSignatureWith6492({
+ *  factoryAddress: "0x...",
+ *  factoryCalldata: "0x...",
+ *  signature: "0x...",
+ * });
+ * ```
+ *
+ * @param {SignWith6492Params} params The parameters to wrap the signature
+ * @param {Hex} params.factoryAddress The address of the factory
+ * @param {Hex} params.factoryCalldata The calldata for the factory
+ * @param {Hex} params.signature The original signature that needs to be wrapped
+ * @returns {Hash} The wrapped signature
+ */
 export declare const wrapSignatureWith6492: ({ factoryAddress, factoryCalldata, signature, }: SignWith6492Params) => Hash;

package/dist/esm/signer/utils.js

@@ -1,5 +1,32 @@
 import { concat, encodeAbiParameters, parseAbiParameters, } from "viem";
+/**
+ * Wraps a given signature with additional data following the EIP-6492 standard.
+ *
+ * @example
+ * ```ts
+ * import { wrapSignatureWith6492 } from "@aa-sdk/core";
+ *
+ * const signature = wrapSignatureWith6492({
+ *  factoryAddress: "0x...",
+ *  factoryCalldata: "0x...",
+ *  signature: "0x...",
+ * });
+ * ```
+ *
+ * @param {SignWith6492Params} params The parameters to wrap the signature
+ * @param {Hex} params.factoryAddress The address of the factory
+ * @param {Hex} params.factoryCalldata The calldata for the factory
+ * @param {Hex} params.signature The original signature that needs to be wrapped
+ * @returns {Hash} The wrapped signature
+ */
 export const wrapSignatureWith6492 = ({ factoryAddress, factoryCalldata, signature, }) => {
+    // wrap the signature as follows: https://eips.ethereum.org/EIPS/eip-6492
+    // concat(
+    //  abi.encode(
+    //    (create2Factory, factoryCalldata, originalERC1271Signature),
+    //    (address, bytes, bytes)),
+    //    magicBytes
+    // )
     return concat([
         encodeAbiParameters(parseAbiParameters("address, bytes, bytes"), [
             factoryAddress,

package/dist/esm/signer/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/signer/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,GAInB,MAAM,MAAM,CAAC;AA4Bd,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EACpC,cAAc,EACd,eAAe,EACf,SAAS,GACU,EAAQ,EAAE;IAQ7B,OAAO,MAAM,CAAC;QACZ,mBAAmB,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,EAAE;YAC/D,cAAc;YACd,eAAe;YACf,SAAS;SACV,CAAC;QACF,oEAAoE;KACrE,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["import {\n  concat,\n  encodeAbiParameters,\n  parseAbiParameters,\n  type Address,\n  type Hash,\n  type Hex,\n} from \"viem\";\n\nexport type SignWith6492Params = {\n  factoryAddress: Address;\n  factoryCalldata: Hex;\n  signature: Hash;\n};\n\n/**\n * Wraps a given signature with additional data following the EIP-6492 standard.\n *\n * @example\n * ```ts\n * import { wrapSignatureWith6492 } from \"@aa-sdk/core\";\n *\n * const signature = wrapSignatureWith6492({\n *  factoryAddress: \"0x...\",\n *  factoryCalldata: \"0x...\",\n *  signature: \"0x...\",\n * });\n * ```\n *\n * @param {SignWith6492Params} params The parameters to wrap the signature\n * @param {Hex} params.factoryAddress The address of the factory\n * @param {Hex} params.factoryCalldata The calldata for the factory\n * @param {Hex} params.signature The original signature that needs to be wrapped\n * @returns {Hash} The wrapped signature\n */\nexport const wrapSignatureWith6492 = ({\n  factoryAddress,\n  factoryCalldata,\n  signature,\n}: SignWith6492Params): Hash => {\n  // wrap the signature as follows: https://eips.ethereum.org/EIPS/eip-6492\n  // concat(\n  //  abi.encode(\n  //    (create2Factory, factoryCalldata, originalERC1271Signature),\n  //    (address, bytes, bytes)),\n  //    magicBytes\n  // )\n  return concat([\n    encodeAbiParameters(parseAbiParameters(\"address, bytes, bytes\"), [\n      factoryAddress,\n      factoryCalldata,\n      signature,\n    ]),\n    \"0x6492649264926492649264926492649264926492649264926492649264926492\",\n  ]);\n};\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/signer/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,mBAAmB,EACnB,kBAAkB,GAInB,MAAM,MAAM,CAAC;AAQd;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EACpC,cAAc,EACd,eAAe,EACf,SAAS,GACU,EAAQ,EAAE;IAC7B,yEAAyE;IACzE,UAAU;IACV,eAAe;IACf,kEAAkE;IAClE,+BAA+B;IAC/B,gBAAgB;IAChB,IAAI;IACJ,OAAO,MAAM,CAAC;QACZ,mBAAmB,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,EAAE;YAC/D,cAAc;YACd,eAAe;YACf,SAAS;SACV,CAAC;QACF,oEAAoE;KACrE,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["import {\n  concat,\n  encodeAbiParameters,\n  parseAbiParameters,\n  type Address,\n  type Hash,\n  type Hex,\n} from \"viem\";\n\nexport type SignWith6492Params = {\n  factoryAddress: Address;\n  factoryCalldata: Hex;\n  signature: Hash;\n};\n\n/**\n * Wraps a given signature with additional data following the EIP-6492 standard.\n *\n * @example\n * ```ts\n * import { wrapSignatureWith6492 } from \"@aa-sdk/core\";\n *\n * const signature = wrapSignatureWith6492({\n *  factoryAddress: \"0x...\",\n *  factoryCalldata: \"0x...\",\n *  signature: \"0x...\",\n * });\n * ```\n *\n * @param {SignWith6492Params} params The parameters to wrap the signature\n * @param {Hex} params.factoryAddress The address of the factory\n * @param {Hex} params.factoryCalldata The calldata for the factory\n * @param {Hex} params.signature The original signature that needs to be wrapped\n * @returns {Hash} The wrapped signature\n */\nexport const wrapSignatureWith6492 = ({\n  factoryAddress,\n  factoryCalldata,\n  signature,\n}: SignWith6492Params): Hash => {\n  // wrap the signature as follows: https://eips.ethereum.org/EIPS/eip-6492\n  // concat(\n  //  abi.encode(\n  //    (create2Factory, factoryCalldata, originalERC1271Signature),\n  //    (address, bytes, bytes)),\n  //    magicBytes\n  // )\n  return concat([\n    encodeAbiParameters(parseAbiParameters(\"address, bytes, bytes\"), [\n      factoryAddress,\n      factoryCalldata,\n      signature,\n    ]),\n    \"0x6492649264926492649264926492649264926492649264926492649264926492\",\n  ]);\n};\n"]}

package/dist/esm/signer/wallet-client.d.ts

@@ -1,12 +1,104 @@
 import { type Hex, type SignableMessage, type TypedDataDefinition, type WalletClient } from "viem";
 import type { SmartAccountSigner } from "./types";
+/**
+ * Represents a wallet client signer for smart accounts, providing methods to get the address, sign messages, and sign typed data.
+ */
 export declare class WalletClientSigner implements SmartAccountSigner<WalletClient> {
     signerType: string;
     inner: WalletClient;
+    /**
+     * Initializes a signer with a given wallet client and signer type.
+     *
+     * @example
+     * ```ts
+     * import { WalletClientSigner } from "@aa-sdk/core";
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum!)
+     * });
+     *
+     * const signer = new WalletClientSigner(client, 'wallet');
+     * ```
+     *
+     * @param {WalletClient} client The wallet client to interact with
+     * @param {string} signerType The type of signer; must be a valid signer type, otherwise an error will be thrown
+     * @throws {InvalidSignerTypeError} If the signer type is invalid
+     */
     constructor(client: WalletClient, signerType: string);
+    /**
+     * Asynchronously retrieves addresses from the inner object and returns the first address after applying the `getAddress` function.
+     *
+     * @example
+     * ```ts
+     * import { WalletClientSigner } from "@aa-sdk/core";
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum!)
+     * });
+     *
+     * const signer = new WalletClientSigner(client, 'wallet');
+     * console.log(await signer.getAddress());
+     * ```
+     *
+     * @returns {Promise<string>} A promise that resolves to the first address after being processed by the `getAddress` function.
+     */
     getAddress: () => Promise<`0x${string}`>;
+    /**
+     * Signs a message using the account's signing method.
+     *
+     * @example
+     * ```ts
+     * import { WalletClientSigner } from "@aa-sdk/core";
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum!)
+     * });
+     *
+     * const signer = new WalletClientSigner(client, 'wallet');
+     * console.log(await signer.signMessage("hello"));
+     * ```
+     *
+     * @param {string} message the message string that needs to be signed
+     * @returns {Promise<string>} a promise that resolves to the signed message
+     */
     readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`>;
-    signTypedData: <const TTypedData extends {
+    /**
+     * Signs the provided typed data using the account's private key.
+     *
+     * @example
+     * ```ts
+     * import { WalletClientSigner } from "@aa-sdk/core";
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum!)
+     * });
+     *
+     * const signer = new WalletClientSigner(client, 'wallet');
+     * console.log(await signer.signTypedData({
+     *  types: {
+     *    "Message": [{ name: "content", type: "string" }]
+     *  },
+     *  primaryType: "Message",
+     *  message: { content: "Hello" },
+     * }));
+     * ```
+     *
+     * @param {TypedDataDefinition<TTypedData, TPrimaryType>} typedData The typed data to be signed
+     * @returns {Promise<Hex>} A promise that resolves to a hex string representing the signed data
+     */
+    signTypedData: <const TTypedData extends Record<string, unknown> | {
         [x: string]: readonly import("viem").TypedDataParameter[];
         [x: `string[${string}]`]: undefined;
         [x: `function[${string}]`]: undefined;
@@ -211,7 +303,5 @@ export declare class WalletClientSigner implements SmartAccountSigner<WalletClie
         uint232?: undefined;
         uint240?: undefined;
         uint248?: undefined;
-    } | {
-        [key: string]: unknown;
-    }, TPrimaryType extends string = string>(typedData: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hex>;
+    }, TPrimaryType extends string | keyof TTypedData = string>(typedData: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hex>;
 }

package/dist/esm/signer/wallet-client.js

@@ -1,6 +1,30 @@
 import { getAddress, } from "viem";
 import { InvalidSignerTypeError } from "../errors/signer.js";
+/**
+ * Represents a wallet client signer for smart accounts, providing methods to get the address, sign messages, and sign typed data.
+ */
 export class WalletClientSigner {
+    /**
+     * Initializes a signer with a given wallet client and signer type.
+     *
+     * @example
+     * ```ts
+     * import { WalletClientSigner } from "@aa-sdk/core";
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum!)
+     * });
+     *
+     * const signer = new WalletClientSigner(client, 'wallet');
+     * ```
+     *
+     * @param {WalletClient} client The wallet client to interact with
+     * @param {string} signerType The type of signer; must be a valid signer type, otherwise an error will be thrown
+     * @throws {InvalidSignerTypeError} If the signer type is invalid
+     */
     constructor(client, signerType) {
         Object.defineProperty(this, "signerType", {
             enumerable: true,
@@ -14,6 +38,26 @@ export class WalletClientSigner {
             writable: true,
             value: void 0
         });
+        /**
+         * Asynchronously retrieves addresses from the inner object and returns the first address after applying the `getAddress` function.
+         *
+         * @example
+         * ```ts
+         * import { WalletClientSigner } from "@aa-sdk/core";
+         * import { createWalletClient, custom } from 'viem'
+         * import { mainnet } from 'viem/chains'
+         *
+         * const client = createWalletClient({
+         *   chain: mainnet,
+         *   transport: custom(window.ethereum!)
+         * });
+         *
+         * const signer = new WalletClientSigner(client, 'wallet');
+         * console.log(await signer.getAddress());
+         * ```
+         *
+         * @returns {Promise<string>} A promise that resolves to the first address after being processed by the `getAddress` function.
+         */
         Object.defineProperty(this, "getAddress", {
             enumerable: true,
             configurable: true,
@@ -23,6 +67,27 @@ export class WalletClientSigner {
                 return getAddress(addresses[0]);
             }
         });
+        /**
+         * Signs a message using the account's signing method.
+         *
+         * @example
+         * ```ts
+         * import { WalletClientSigner } from "@aa-sdk/core";
+         * import { createWalletClient, custom } from 'viem'
+         * import { mainnet } from 'viem/chains'
+         *
+         * const client = createWalletClient({
+         *   chain: mainnet,
+         *   transport: custom(window.ethereum!)
+         * });
+         *
+         * const signer = new WalletClientSigner(client, 'wallet');
+         * console.log(await signer.signMessage("hello"));
+         * ```
+         *
+         * @param {string} message the message string that needs to be signed
+         * @returns {Promise<string>} a promise that resolves to the signed message
+         */
         Object.defineProperty(this, "signMessage", {
             enumerable: true,
             configurable: true,
@@ -32,16 +97,44 @@ export class WalletClientSigner {
                 return this.inner.signMessage({ message, account });
             }
         });
+        /**
+         * Signs the provided typed data using the account's private key.
+         *
+         * @example
+         * ```ts
+         * import { WalletClientSigner } from "@aa-sdk/core";
+         * import { createWalletClient, custom } from 'viem'
+         * import { mainnet } from 'viem/chains'
+         *
+         * const client = createWalletClient({
+         *   chain: mainnet,
+         *   transport: custom(window.ethereum!)
+         * });
+         *
+         * const signer = new WalletClientSigner(client, 'wallet');
+         * console.log(await signer.signTypedData({
+         *  types: {
+         *    "Message": [{ name: "content", type: "string" }]
+         *  },
+         *  primaryType: "Message",
+         *  message: { content: "Hello" },
+         * }));
+         * ```
+         *
+         * @param {TypedDataDefinition<TTypedData, TPrimaryType>} typedData The typed data to be signed
+         * @returns {Promise<Hex>} A promise that resolves to a hex string representing the signed data
+         */
         Object.defineProperty(this, "signTypedData", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: async (typedData) => {
                 const account = this.inner.account ?? (await this.getAddress());
-                return this.inner.signTypedData({
+                const params = {
                     account,
                     ...typedData,
-                });
+                };
+                return this.inner.signTypedData(params);
             }
         });
         this.inner = client;

package/dist/esm/signer/wallet-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"wallet-client.js","sourceRoot":"","sources":["../../../src/signer/wallet-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GAMX,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAM7D,MAAM,OAAO,kBAAkB;IAyB7B,YAAY,MAAoB,EAAE,UAAkB;QAxBpD;;;;;WAAmB;QACnB;;;;;WAAoB;QAmDpB;;;;mBAA2C,KAAK,IAAI,EAAE;gBACpD,IAAI,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;gBAChD,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC;WAAC;QAuBO;;;;mBACP,KAAK,EAAE,OAAO,EAAE,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;gBAEhE,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACtD,CAAC;WAAC;QA6BJ;;;;mBAAgB,KAAK,EAInB,SAAwD,EAC1C,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;gBAEhE,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;oBAC9B,OAAO;oBACP,GAAG,SAAS;iBACb,CAAC,CAAC;YACL,CAAC;WAAC;QAnGA,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CA+FF","sourcesContent":["import {\n  getAddress,\n  type Hex,\n  type SignableMessage,\n  type TypedData,\n  type TypedDataDefinition,\n  type WalletClient,\n} from \"viem\";\nimport { InvalidSignerTypeError } from \"../errors/signer.js\";\nimport type { SmartAccountSigner } from \"./types\";\n\n/**\n * Represents a wallet client signer for smart accounts, providing methods to get the address, sign messages, and sign typed data.\n */\nexport class WalletClientSigner implements SmartAccountSigner<WalletClient> {\n  signerType: string;\n  inner: WalletClient;\n\n  /**\n   * Initializes a signer with a given wallet client and signer type.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * ```\n   *\n   * @param {WalletClient} client The wallet client to interact with\n   * @param {string} signerType The type of signer; must be a valid signer type, otherwise an error will be thrown\n   * @throws {InvalidSignerTypeError} If the signer type is invalid\n   */\n  constructor(client: WalletClient, signerType: string) {\n    this.inner = client;\n    if (!signerType) {\n      throw new InvalidSignerTypeError(signerType);\n    }\n    this.signerType = signerType;\n  }\n\n  /**\n   * Asynchronously retrieves addresses from the inner object and returns the first address after applying the `getAddress` function.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.getAddress());\n   * ```\n   *\n   * @returns {Promise<string>} A promise that resolves to the first address after being processed by the `getAddress` function.\n   */\n  getAddress: () => Promise<`0x${string}`> = async () => {\n    let addresses = await this.inner.getAddresses();\n    return getAddress(addresses[0]);\n  };\n\n  /**\n   * Signs a message using the account's signing method.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.signMessage(\"hello\"));\n   * ```\n   *\n   * @param {string} message the message string that needs to be signed\n   * @returns {Promise<string>} a promise that resolves to the signed message\n   */\n  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> =\n    async (message) => {\n      const account = this.inner.account ?? (await this.getAddress());\n\n      return this.inner.signMessage({ message, account });\n    };\n\n  /**\n   * Signs the provided typed data using the account's private key.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.signTypedData({\n   *  types: {\n   *    \"Message\": [{ name: \"content\", type: \"string\" }]\n   *  },\n   *  primaryType: \"Message\",\n   *  message: { content: \"Hello\" },\n   * }));\n   * ```\n   *\n   * @param {TypedDataDefinition<TTypedData, TPrimaryType>} typedData The typed data to be signed\n   * @returns {Promise<Hex>} A promise that resolves to a hex string representing the signed data\n   */\n  signTypedData = async <\n    const TTypedData extends TypedData | { [key: string]: unknown },\n    TPrimaryType extends string = string\n  >(\n    typedData: TypedDataDefinition<TTypedData, TPrimaryType>\n  ): Promise<Hex> => {\n    const account = this.inner.account ?? (await this.getAddress());\n\n    return this.inner.signTypedData({\n      account,\n      ...typedData,\n    });\n  };\n}\n"]}
+{"version":3,"file":"wallet-client.js","sourceRoot":"","sources":["../../../src/signer/wallet-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GAMX,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAG7D;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAI7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,MAAoB,EAAE,UAAkB;QAxBpD;;;;;WAAmB;QACnB;;;;;WAAoB;QA+BpB;;;;;;;;;;;;;;;;;;;WAmBG;QACH;;;;mBAA2C,KAAK,IAAI,EAAE;gBACpD,IAAI,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;gBAChD,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC;WAAC;QAEF;;;;;;;;;;;;;;;;;;;;WAoBG;QACM;;;;mBACP,KAAK,EAAE,OAAO,EAAE,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;gBAEhE,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACtD,CAAC;WAAC;QAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH;;;;mBAAgB,KAAK,EAInB,SAAwD,EAC1C,EAAE;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;gBAEhE,MAAM,MAAM,GAAG;oBACb,OAAO;oBACP,GAAG,SAAS;iBACuD,CAAC;gBAEtE,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAqB,MAAM,CAAC,CAAC;YAC9D,CAAC;WAAC;QArGA,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CAiGF","sourcesContent":["import {\n  getAddress,\n  type Hex,\n  type SignableMessage,\n  type TypedData,\n  type TypedDataDefinition,\n  type WalletClient,\n} from \"viem\";\nimport type { Account } from \"viem/accounts\";\nimport type { SignTypedDataParameters } from \"viem/actions\";\nimport { InvalidSignerTypeError } from \"../errors/signer.js\";\nimport type { SmartAccountSigner } from \"./types\";\n\n/**\n * Represents a wallet client signer for smart accounts, providing methods to get the address, sign messages, and sign typed data.\n */\nexport class WalletClientSigner implements SmartAccountSigner<WalletClient> {\n  signerType: string;\n  inner: WalletClient;\n\n  /**\n   * Initializes a signer with a given wallet client and signer type.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * ```\n   *\n   * @param {WalletClient} client The wallet client to interact with\n   * @param {string} signerType The type of signer; must be a valid signer type, otherwise an error will be thrown\n   * @throws {InvalidSignerTypeError} If the signer type is invalid\n   */\n  constructor(client: WalletClient, signerType: string) {\n    this.inner = client;\n    if (!signerType) {\n      throw new InvalidSignerTypeError(signerType);\n    }\n    this.signerType = signerType;\n  }\n\n  /**\n   * Asynchronously retrieves addresses from the inner object and returns the first address after applying the `getAddress` function.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.getAddress());\n   * ```\n   *\n   * @returns {Promise<string>} A promise that resolves to the first address after being processed by the `getAddress` function.\n   */\n  getAddress: () => Promise<`0x${string}`> = async () => {\n    let addresses = await this.inner.getAddresses();\n    return getAddress(addresses[0]);\n  };\n\n  /**\n   * Signs a message using the account's signing method.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.signMessage(\"hello\"));\n   * ```\n   *\n   * @param {string} message the message string that needs to be signed\n   * @returns {Promise<string>} a promise that resolves to the signed message\n   */\n  readonly signMessage: (message: SignableMessage) => Promise<`0x${string}`> =\n    async (message) => {\n      const account = this.inner.account ?? (await this.getAddress());\n\n      return this.inner.signMessage({ message, account });\n    };\n\n  /**\n   * Signs the provided typed data using the account's private key.\n   *\n   * @example\n   * ```ts\n   * import { WalletClientSigner } from \"@aa-sdk/core\";\n   * import { createWalletClient, custom } from 'viem'\n   * import { mainnet } from 'viem/chains'\n   *\n   * const client = createWalletClient({\n   *   chain: mainnet,\n   *   transport: custom(window.ethereum!)\n   * });\n   *\n   * const signer = new WalletClientSigner(client, 'wallet');\n   * console.log(await signer.signTypedData({\n   *  types: {\n   *    \"Message\": [{ name: \"content\", type: \"string\" }]\n   *  },\n   *  primaryType: \"Message\",\n   *  message: { content: \"Hello\" },\n   * }));\n   * ```\n   *\n   * @param {TypedDataDefinition<TTypedData, TPrimaryType>} typedData The typed data to be signed\n   * @returns {Promise<Hex>} A promise that resolves to a hex string representing the signed data\n   */\n  signTypedData = async <\n    const TTypedData extends TypedData | Record<string, unknown>,\n    TPrimaryType extends keyof TTypedData | \"EIP712Domain\" | string = string\n  >(\n    typedData: TypedDataDefinition<TTypedData, TPrimaryType>\n  ): Promise<Hex> => {\n    const account = this.inner.account ?? (await this.getAddress());\n\n    const params = {\n      account,\n      ...typedData,\n    } as SignTypedDataParameters<TTypedData, string, Account | undefined>;\n\n    return this.inner.signTypedData<TTypedData, string>(params);\n  };\n}\n"]}

package/dist/esm/transport/split.d.ts

@@ -6,4 +6,36 @@ export interface SplitTransportParams {
     }[];
     fallback: Transport;
 }
+/**
+ * The Split Transport allows you to split RPC traffic for specific methods across
+ * different RPC providers. This is done by specifying the methods you want handled
+ * specially as overrides and providing a fallback transport for all other methods.
+ *
+ * @example
+ * ```ts
+ * import { createPublicClient, http } from "viem";
+ * import { split } from "@aa-sdk/core";
+ *
+ * const bundlerMethods = [
+ *  "eth_sendUserOperation",
+ *  "eth_estimateUserOperationGas",
+ *  "eth_getUserOperationReceipt",
+ *  "eth_getUserOperationByHash",
+ *  "eth_supportedEntryPoints"
+ * ];
+ *
+ * const clientWithSplit = createPublicClient({
+ *  transport: split({
+ *      overrides: [{
+ *          methods: bundlerMethods,
+ *          transport: http(BUNDLER_RPC_URL)
+ *      }],
+ *      fallback: http(OTHER_RPC_URL)
+ *  }),
+ * });
+ * ```
+ *
+ * @param {SplitTransportParams} params split transport configuration containing the methods overrides and fallback transport
+ * @returns {CustomTransport} a viem Transport that splits traffic
+ */
 export declare const split: (params: SplitTransportParams) => CustomTransport;