@account-kit/signer 4.0.0-alpha.5 → 4.0.0-alpha.6

package/src/index.ts

@@ -1,10 +1,9 @@
-export type * from "./signer.js";
-export { AlchemyWebSigner } from "./signer.js";
-
-export type * from "./types.js";
-export { AlchemySignerStatus } from "./types.js";
-
+export { BaseAlchemySigner } from "./base.js";
 export { BaseSignerClient } from "./client/base.js";
 export { AlchemySignerWebClient } from "./client/index.js";
 export type * from "./client/types.js";
 export { DEFAULT_SESSION_MS } from "./session/manager.js";
+export type * from "./signer.js";
+export { AlchemyWebSigner } from "./signer.js";
+export type * from "./types.js";
+export { AlchemySignerStatus } from "./types.js";

package/src/signer.ts

@@ -37,15 +37,36 @@ export type AlchemySignerParams = z.input<typeof AlchemySignerParamsSchema>;
  * A SmartAccountSigner that can be used with any SmartContractAccount
  */
 export class AlchemyWebSigner extends BaseAlchemySigner<AlchemySignerWebClient> {
-  constructor(params_: AlchemySignerParams) {
-    const { sessionConfig, ...params } =
-      AlchemySignerParamsSchema.parse(params_);
+  /**
+   * Initializes an instance with the provided Alchemy signer parameters after parsing them with a schema.
+   *
+   * @example
+   * ```ts
+   * import { AlchemyWebSigner } from "@account-kit/signer";
+   *
+   * const signer = new AlchemyWebSigner({
+   *  client: {
+   *    connection: {
+   *      rpcUrl: "/api/rpc",
+   *    },
+   *    iframeConfig: {
+   *      iframeContainerId: "alchemy-signer-iframe-container",
+   *    },
+   *  },
+   * });
+   * ```
+   *
+   * @param {AlchemySignerParams} params The parameters for the Alchemy signer, including the client and session configuration
+   */
+  constructor(params: AlchemySignerParams) {
+    const { sessionConfig, ...params_ } =
+      AlchemySignerParamsSchema.parse(params);
 
     let client: AlchemySignerWebClient;
-    if ("connection" in params.client) {
-      client = new AlchemySignerWebClient(params.client);
+    if ("connection" in params_.client) {
+      client = new AlchemySignerWebClient(params_.client);
     } else {
-      client = params.client;
+      client = params_.client;
     }
     super({
       client,

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is autogenerated by inject-version.ts. Any changes will be
 // overwritten on commit!
-export const VERSION = "4.0.0-alpha.4";
+export const VERSION = "4.0.0-alpha.6";