@aa-sdk/core 4.0.0-alpha.1 → 4.0.0-alpha.10

package/src/actions/smartAccount/buildUserOperationFromTxs.ts

@@ -17,74 +17,58 @@ import type {
 } from "./types";
 
 /**
- * Performs {@link buildUserOperationFromTx} in batch and builds into a single,
+ * Performs `buildUserOperationFromTx` in batch and builds into a single,
  * yet to be signed `UserOperation` (UO) struct. The output user operation struct
  * will be filled with all gas fields (and paymaster data if a paymaster is used)
  * based on the transactions data (`to`, `data`, `value`, `maxFeePerGas`,
- * `maxPriorityFeePerGas`) computed using the configured
- * [`ClientMiddlewares`](/packages/aa-core/smart-account-client/middleware/index) on the `SmartAccountClient`
- * 
+ * `maxPriorityFeePerGas`) computed using the configured ClientMiddlewares on the SmartAccountClient.
+ *
  * @example
  * ```ts
  * import type { RpcTransactionRequest } from "viem";
-import { smartAccountClient } from "./smartAccountClient";
-// [!code focus:99]
-// buildUserOperationFromTxs converts traditional Ethereum transactions in batch and returns
-// the unsigned user operation struct after constructing the user operation struct
-// through the middleware pipeline
-const requests: RpcTransactionRequest[] = [
-  {
-    from, // ignored
-    to,
-    data: encodeFunctionData({
-      abi: ContractABI.abi,
-      functionName: "func",
-      args: [arg1, arg2, ...],
-    }),
-  },
-  {
-    from, // ignored
-    to,
-    data: encodeFunctionData({
-      abi: ContractABI.abi,
-      functionName: "func",
-      args: [arg1, arg2, ...],
-    }),
-  },
-  ...
-  {
-    from, // ignored
-    to,
-    data: encodeFunctionData({
-      abi: ContractABI.abi,
-      functionName: "func",
-      args: [arg1, arg2, ...],
-    }),
-  },
-];
-const uoStruct = await smartAccountClient.buildUserOperationFromTxs({
-  requests,
-});
- 
-// signUserOperation signs the above unsigned user operation struct built
-// using the account connected to the smart account client
-const request = await smartAccountClient.signUserOperation({ uoStruct });
- 
-// You can use the BundlerAction `sendRawUserOperation` (packages/core/src/actions/bundler/sendRawUserOperation.ts)
-// to send the signed user operation request to the bundler, requesting the bundler to send the signed uo to the
-// EntryPoint contract pointed at by the entryPoint address parameter
-const entryPointAddress = client.account.getEntryPoint().address;
-const uoHash = await smartAccountClient.sendRawUserOperation({
-  request,
-  entryPoint: entryPointAddress,
-});
+ * import { smartAccountClient } from "./smartAccountClient";
+ *
+ * const requests: RpcTransactionRequest[] = [
+ *   {
+ *     from, // ignored
+ *     to,
+ *     data: encodeFunctionData({
+ *       abi: ContractABI.abi,
+ *       functionName: "func",
+ *       args: [arg1, arg2, ...],
+ *     }),
+ *   },
+ *   {
+ *     from, // ignored
+ *     to,
+ *     data: encodeFunctionData({
+ *       abi: ContractABI.abi,
+ *       functionName: "func",
+ *       args: [arg1, arg2, ...],
+ *     }),
+ *   },
+ * ];
+ * const uoStruct = await smartAccountClient.buildUserOperationFromTxs({
+ *   requests,
+ * });
+ *
+ * // signUserOperation signs the above unsigned user operation struct built
+ * // using the account connected to the smart account client
+ * const request = await smartAccountClient.signUserOperation({ uoStruct });
+ *
+ * // You can use the BundlerAction `sendRawUserOperation` (packages/core/src/actions/bundler/sendRawUserOperation.ts)
+ * // to send the signed user operation request to the bundler, requesting the bundler to send the signed uo to the
+ * // EntryPoint contract pointed at by the entryPoint address parameter
+ * const entryPointAddress = client.account.getEntryPoint().address;
+ * const uoHash = await smartAccountClient.sendRawUserOperation({
+ *   request,
+ *   entryPoint: entryPointAddress,
+ * });
  * ```
  *
- * @param client the smart account client to use to make RPC calls
- * @param args {@link BuildTransactionParameters} an object containing the requests
- * to build as well as, the account if not hoisted, the context, the overrides, and
- * optionally a flag to enable signing of the UO via the underlying middleware
- * @returns a Promise containing the built user operation
+ * @param {Client<TTransport, TChain, TAccount>} client the smart account client to use to make RPC calls
+ * @param {BuildTransactionParameters} args  an object containing the requests to build as well as, the account if not hoisted, the context, the overrides, and optionally a flag to enable signing of the UO via the underlying middleware
+ * @returns {Promise<BuildUserOperationFromTransactionsResult<TEntryPointVersion>>} a Promise containing the built user operation
  */
 export async function buildUserOperationFromTxs<
   TTransport extends Transport = Transport,

package/src/actions/smartAccount/checkGasSponsorshipEligibility.ts

@@ -12,31 +12,31 @@ import type {
 
 /**
  * This function verifies the eligibility of the connected account for gas sponsorship concerning the upcoming `UserOperation` (UO) that is intended to be sent.
- * Internally, this method invokes [`buildUserOperation`](./buildUserOperation.md), which navigates through the middleware pipeline, including the `PaymasterMiddleware`. Its purpose is to construct the UO struct meant for transmission to the bundler. Following the construction of the UO struct, this function verifies if the resulting structure contains a non-empty `paymasterAndData` field.
+ * Internally, this method invokes `buildUserOperation`, which navigates through the middleware pipeline, including the `PaymasterMiddleware`. Its purpose is to construct the UO struct meant for transmission to the bundler. Following the construction of the UO struct, this function verifies if the resulting structure contains a non-empty `paymasterAndData` field.
  * You can utilize this method before sending the user operation to confirm its eligibility for gas sponsorship. Depending on the outcome, it allows you to tailor the user experience accordingly, based on eligibility.
  *
  * @example
  * ```ts
  * import { smartAccountClient } from "./smartAccountClient";
-// [!code focus:99]
-const eligible = await smartAccountClient.checkGasSponsorshipEligibility({
-  uo: {
-    data: "0xCalldata",
-    target: "0xTarget",
-    value: 0n,
-  },
-});
- 
-console.log(
-  `User Operation is ${
-    eligible ? "eligible" : "ineligible"
-  } for gas sponsorship.`
-);
+ * // [!code focus:99]
+ * const eligible = await smartAccountClient.checkGasSponsorshipEligibility({
+ *   uo: {
+ *     data: "0xCalldata",
+ *     target: "0xTarget",
+ *     value: 0n,
+ *   },
+ * });
+ *
+ * console.log(
+ *   `User Operation is ${
+ *     eligible ? "eligible" : "ineligible"
+ *   } for gas sponsorship.`
+ * );
  * ```
- * 
- * @param client the smart account client to use for making RPC calls
- * @param args {@link SendUserOperationParameters} containing the user operation, account, context, and overrides
- * @returns a Promise containing a boolean indicating if the account is elgibile for sponsorship
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client the smart account client to use for making RPC calls
+ * @param {SendUserOperationParameters} args containing the user operation, account, context, and overrides
+ * @returns {Promise<boolean>} a Promise containing a boolean indicating if the account is elgibile for sponsorship
  */
 export function checkGasSponsorshipEligibility<
   TTransport extends Transport = Transport,

package/src/actions/smartAccount/estimateUserOperationGas.ts

@@ -23,9 +23,9 @@ import type {
  * @template {SmartContractAccount | undefined} TAccount
  * @template {UserOperationContext | undefined} TContext
  * @template {GetEntryPointFromAccount<TAccount>} TEntryPointVersion
- * @param client smart account client
- * @param args send user operation parameters
- * @returns user operation gas estimate response
+ * @param {Client<TTransport, TChain, TAccount>} client smart account client
+ * @param {SendUserOperationParameters<TAccount, TContext>} args send user operation parameters
+ * @returns {Promise<UserOperationEstimateGasResponse<TEntryPointVersion>>}user operation gas estimate response
  */
 export async function estimateUserOperationGas<
   TTransport extends Transport = Transport,

package/src/actions/smartAccount/internal/initUserOperation.ts

@@ -18,15 +18,14 @@ import type {
  * Description internal action function of SmartAccountClient for initializing
  * a user operation for the sender account
  *
- * @async
  * @template {Transport} TTransport
  * @template {Chain | undefined} TChain
  * @template {SmartContractAccount | undefined} TAccount
  * @template {UserOperationContext | undefined} TContext
  * @template {GetEntryPointFromAccount} TEntryPointVersion
- * @param client smart account client
- * @param args send user operation parameters
- * @returns initialized user operation struct
+ * @param {BaseSmartAccountClient<TTransport, TChain, TAccount>} client smart account client
+ * @param {SendUserOperationParameters<TAccount, TContext, TEntryPointVersion> | BuildUserOperationParameters<TAccount, TContext, TEntryPointVersion>} args send user operation parameters
+ * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} initialized user operation struct
  */
 export async function _initUserOperation<
   TTransport extends Transport = Transport,

package/src/actions/smartAccount/internal/runMiddlewareStack.ts

@@ -19,14 +19,6 @@ import {
 } from "../../../utils/index.js";
 import type { UserOperationContext } from "../types";
 
-/**
- * Utility method for running a sequence of async functions as a pipeline
- *
- * @template S
- * @template Opts
- * @param fns async functions to run in a pipeline sequence
- * @returns a function that runs the async functions in a pipeline sequence
- */
 const asyncPipe =
   <S, Opts>(...fns: ((s: S, opts: Opts) => Promise<S>)[]) =>
   async (s: S, opts: Opts) => {
@@ -37,20 +29,6 @@ const asyncPipe =
     return result;
   };
 
-/**
- * Internal method of {@link SmartAccountClient} running the middleware stack for a user operation
- *
- * @async
- * @template TTransport
- * @template TChain
- * @template TAccount
- * @template TContext the {@link UserOperationContext} passed to the middleware
- * @template TEntryPointVersion
- * @param client the smart account client instance that runs the middleware pipeline with
- * @param args the Deferrable {@link UserOperationStruct} to run the middleware pipeline on
- *
- * @returns the resolved {@link UserOperationStruct} after running the middleware pipeline
- */
 export async function _runMiddlewareStack<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,

package/src/actions/smartAccount/internal/sendUserOperation.ts

@@ -15,13 +15,6 @@ import type {
 import { signUserOperation } from "../signUserOperation.js";
 import type { GetContextParameter, UserOperationContext } from "../types";
 
-/**
- * Used internally to send a user operation that has **already** been signed
- *
- * @param client a base smart account client instance with middleware configured
- * @param args user operation struct, overrides, account, and context to be used in sending
- * @returns A Promise containing the send user operation result {@link SendUserOperationResult}
- */
 export async function _sendUserOperation<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,

package/src/actions/smartAccount/sendUserOperation.ts

@@ -17,9 +17,23 @@ import type {
 /**
  * Sends a user operation or batch of user operations using the connected account. Before executing, sendUserOperation will run the user operation through the middleware pipeline.
  *
- * @param client the smart account client to use for RPC requests
- * @param args {@link SendUserOperationParameters} containg the UO or batch to send, context, overrides, and account if not hoisted on the client
- * @returns a Promise containing the {@link SendUserOperationResult}
+ * @example
+ * ```ts
+ * import { createSmartAccountClient, toSmartContractAccount } from "@aa-sdk/core";
+ *
+ * const account = await toSmartContractAccount(...);
+ * const result = await createSmartAccountClient(...).sendUserOperation({
+ *  uo: {
+ *    target: "0x...",
+ *    data: "0x...", // or "0x",
+ *    value: 0n, // optional
+ *  }
+ * });
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client the smart account client to use for RPC requests
+ * @param {SendUserOperationParameters<TAccount, TContext>} args contains the UO or batch to send, context, overrides, and account if not hoisted on the client
+ * @returns {Promise<SendUserOperationResult<TEntryPointVersion>>} a Promise containing the result of the user operation
  */
 export async function sendUserOperation<
   TTransport extends Transport = Transport,

package/src/client/bundlerClient.ts

@@ -58,8 +58,8 @@ export const createBundlerClientFromExisting: <
 /**
  * Creates a PublicClient with methods for calling Bundler RPC methods
  *
- * @param args - configuration for the client
- * @returns a PublicClient with methods for calling Bundler RPC methods
+ * @param {PublicClientConfig<TTransport, Chain> & { type?: string }} args - configuration for the client
+ * @returns {BundlerClient<TTransport>} a PublicClient with methods for calling Bundler RPC methods
  */
 export function createBundlerClient<TTransport extends Transport>(
   args: PublicClientConfig<TTransport, Chain> & { type?: string }

package/src/client/decorators/bundlerClient.ts

@@ -55,10 +55,10 @@ export type BundlerActions = {
   /**
    * calls `eth_estimateUserOperationGas` and  returns the result
    *
-   * @param request - the {@link UserOperationRequest} to estimate gas for
+   * @param request - the UserOperationRequest to estimate gas for
    * @param entryPoint - the entry point address the op will be sent to
    * @param stateOverride - the state override to use for the estimation
-   * @returns the gas estimates for the given response (see: {@link UserOperationEstimateGasResponse})
+   * @returns the gas estimates for the given response
    */
   estimateUserOperationGas<
     TEntryPointVersion extends EntryPointVersion = EntryPointVersion
@@ -71,7 +71,7 @@ export type BundlerActions = {
   /**
    * calls `eth_sendUserOperation` and returns the hash of the sent UserOperation
    *
-   * @param request - the {@link UserOperationRequest} to send
+   * @param request - the UserOperationRequest to send
    * @param entryPoint - the entry point address the op will be sent to
    * @returns the hash of the sent UserOperation
    */
@@ -83,25 +83,25 @@ export type BundlerActions = {
   ): Promise<Hash>;
 
   /**
-   * calls `eth_getUserOperationByHash` and returns the {@link UserOperationResponse}
+   * calls `eth_getUserOperationByHash` and returns the UserOperationResponse
    *
    * @param hash - the hash of the UserOperation to fetch
-   * @returns - {@link UserOperationResponse}
+   * @returns - the user operation if found or null
    */
   getUserOperationByHash(hash: Hash): Promise<UserOperationResponse | null>;
 
   /**
-   * calls `eth_getUserOperationReceipt` and returns the {@link UserOperationReceipt}
+   * calls `eth_getUserOperationReceipt` and returns the UserOperationReceipt
    *
    * @param hash - the hash of the UserOperation to get the receipt for
-   * @returns - {@link UserOperationReceipt}
+   * @returns - a user operation receipt or null if not found
    */
   getUserOperationReceipt(hash: Hash): Promise<UserOperationReceipt | null>;
 
   /**
    * calls `eth_supportedEntryPoints` and returns the entry points the RPC supports
    *
-   * @returns - {@link Address}[]
+   * @returns - an array of the entrypoint addresses supported
    */
   getSupportedEntryPoints(): Promise<Address[]>;
 };

package/src/client/isSmartAccountClient.ts

@@ -11,8 +11,8 @@ import type {
  * Useful for narrowing the type of the client down when used within the
  * smart account client decorators
  *
- * @param client a viem client
- * @returns true if the client is a SmartAccountClient
+ * @param {Client<TTransport, TChain, TAccount>} client a viem client
+ * @returns {boolean} true if the client is a SmartAccountClient
  */
 export function isSmartAccountClient<
   TTransport extends Transport = Transport,
@@ -37,8 +37,8 @@ export function isSmartAccountClient<
  * Useful for narrowing the type of the client down when used within the
  * smart account action decorators
  *
- * @param client a viem client
- * @returns true if the account is a BaseSmartAccountClient
+ * @param {Client<TTransport, TChain, TAccount>} client a viem client
+ * @returns {boolean} true if the account is a BaseSmartAccountClient
  */
 export function isBaseSmartAccountClient<
   TTransport extends Transport = Transport,

package/src/client/types.ts

@@ -3,10 +3,7 @@ import type { Hash, Hex } from "viem";
 import type { z } from "zod";
 import type { UserOperationContext } from "../actions/smartAccount/types.js";
 import type { EntryPointVersion } from "../entrypoint/types.js";
-import type {
-  ClientMiddleware,
-  ClientMiddlewareFn,
-} from "../middleware/types.js";
+import type { ClientMiddleware } from "../middleware/types.js";
 import type { UserOperationRequest } from "../types.js";
 import type { ConnectionConfigSchema } from "./schema.js";
 
@@ -37,15 +34,5 @@ export type ClientMiddlewareConfig<
   TContext extends UserOperationContext | undefined =
     | UserOperationContext
     | undefined
-> = Omit<
-  Partial<ClientMiddleware<TContext>>,
-  "dummyPaymasterAndData" | "paymasterAndData"
-> & {
-  paymasterAndData?: {
-    dummyPaymasterAndData: () =>
-      | UserOperationRequest<"0.6.0">["paymasterAndData"]
-      | Pick<UserOperationRequest<"0.7.0">, "paymaster" | "paymasterData">;
-    paymasterAndData: ClientMiddlewareFn<TContext>;
-  };
-};
+> = Partial<ClientMiddleware<TContext>>;
 // [!endregion ClientMiddlewareConfig]

package/src/ens/utils.ts

@@ -1,6 +1,5 @@
-import type { Chain } from "viem/chains";
 import * as chains from "viem/chains";
-import { mainnet } from "../chains/index.js";
+import { mainnet, type Chain } from "viem/chains";
 
 export const ChainsById: Map<number, chains.Chain> = new Map(
   Object.values(chains).map((x) => [x.id, x])

package/src/errors/account.ts

@@ -9,7 +9,10 @@ export class AccountNotFoundError extends BaseError {
   override name = "AccountNotFoundError";
 
   // TODO: extend this further using docs path as well
-  constructor() {
+
+  /**
+   * Constructor for initializing an error message indicating that an account could not be found to execute the specified action.
+   */ constructor() {
     super("Could not find an Account to execute with this Action.");
   }
 }
@@ -20,6 +23,14 @@ export class AccountNotFoundError extends BaseError {
  */
 export class DefaultFactoryNotDefinedError extends BaseError {
   override name = "DefaultFactoryNotDefinedError";
+
+  /**
+   * Constructs an error message indicating that no default factory was found for the given account type, chain, and entry point version.
+   *
+   * @param {string} accountType the type of account
+   * @param {Chain} chain the blockchain chain
+   * @param {EntryPointVersion} version the entry point version
+   */
   constructor(accountType: string, chain: Chain, version: EntryPointVersion) {
     super(
       [
@@ -35,7 +46,10 @@ export class DefaultFactoryNotDefinedError extends BaseError {
  */
 export class GetCounterFactualAddressError extends BaseError {
   override name = "GetCounterFactualAddressError";
-  constructor() {
+
+  /**
+   * Constructor for initializing an error message indicating the failure of fetching the counter-factual address.
+   */ constructor() {
     super("getCounterFactualAddress failed");
   }
 }
@@ -45,6 +59,12 @@ export class GetCounterFactualAddressError extends BaseError {
  */
 export class UpgradesNotSupportedError extends BaseError {
   override name = "UpgradesNotSupported";
+
+  /**
+   * Error constructor for indicating that upgrades are not supported by the given account type.
+   *
+   * @param {string} accountType The type of account that does not support upgrades
+   */
   constructor(accountType: string) {
     super(`Upgrades are not supported by ${accountType}`);
   }
@@ -55,7 +75,12 @@ export class UpgradesNotSupportedError extends BaseError {
  */
 export class SignTransactionNotSupportedError extends BaseError {
   override name = "SignTransactionNotSupported";
-  constructor() {
+
+  /**
+   * Throws an error indicating that signing a transaction is not supported by smart contracts.
+   *
+   
+   */ constructor() {
     super(`SignTransaction is not supported by smart contracts`);
   }
 }
@@ -65,6 +90,13 @@ export class SignTransactionNotSupportedError extends BaseError {
  */
 export class FailedToGetStorageSlotError extends BaseError {
   override name = "FailedToGetStorageSlotError";
+
+  /**
+   * Custom error message constructor for failing to get a specific storage slot.
+   *
+   * @param {string} slot The storage slot that failed to be accessed or retrieved
+   * @param {string} slotDescriptor A description of the storage slot, for additional context in the error message
+   */
   constructor(slot: string, slotDescriptor: string) {
     super(`Failed to get storage slot ${slot} (${slotDescriptor})`);
   }
@@ -75,6 +107,12 @@ export class FailedToGetStorageSlotError extends BaseError {
  */
 export class BatchExecutionNotSupportedError extends BaseError {
   override name = "BatchExecutionNotSupportedError";
+
+  /**
+   * Constructs an error message indicating that batch execution is not supported by the specified account type.
+   *
+   * @param {string} accountType the type of account that does not support batch execution
+   */
   constructor(accountType: string) {
     super(`Batch execution is not supported by ${accountType}`);
   }
@@ -85,6 +123,12 @@ export class BatchExecutionNotSupportedError extends BaseError {
  */
 export class AccountRequiresOwnerError extends BaseError {
   override name = "AccountRequiresOwnerError";
+
+  /**
+   * Constructs an error indicating that an account of the specified type requires an owner to execute.
+   *
+   * @param {string} accountType The type of account that requires an owner
+   */
   constructor(accountType: string) {
     super(`Account of type ${accountType} requires an owner to execute`);
   }
@@ -95,6 +139,12 @@ export class AccountRequiresOwnerError extends BaseError {
  */
 export class UpgradeToAndCallNotSupportedError extends BaseError {
   override name = "UpgradeToAndCallNotSupportedError";
+
+  /**
+   * Constructs an error message indicating that `UpgradeToAndCall` is not supported by the specified account type.
+   *
+   * @param {string} accountType The type of account that does not support `UpgradeToAndCall`
+   */
   constructor(accountType: string) {
     super(`UpgradeToAndCall is not supported by ${accountType}`);
   }
@@ -105,6 +155,13 @@ export class UpgradeToAndCallNotSupportedError extends BaseError {
  */
 export class IncorrectAccountType extends BaseError {
   override name = "IncorrectAccountTypeError";
+
+  /**
+   * Constructs an error object indicating that the expected account type does not match the actual account type.
+   *
+   * @param {string} expected the expected account type
+   * @param {string} actual the actual account type that was received
+   */
   constructor(expected: string, actual: string) {
     super(`Expected account type ${expected}, got ${actual}`);
   }
@@ -115,7 +172,10 @@ export class IncorrectAccountType extends BaseError {
  */
 export class SmartAccountWithSignerRequiredError extends BaseError {
   override name = "SmartAccountWithSignerRequiredError";
-  constructor() {
+
+  /**
+   * Initializes a new instance of the error class with a predefined error message indicating that a smart account requires a signer.
+   */ constructor() {
     super("Smart account requires a signer");
   }
 }

package/src/errors/client.ts

@@ -6,6 +6,14 @@ import { BaseError } from "./base.js";
  */
 export class IncompatibleClientError extends BaseError {
   override name = "IncompatibleClientError";
+
+  /**
+   * Throws an error when the client type does not match the expected client type.
+   *
+   * @param {string} expectedClient The expected type of the client.
+   * @param {string} method The method that was called.
+   * @param {Client} client The client instance.
+   */
   constructor(expectedClient: string, method: string, client: Client) {
     super(
       [
@@ -21,6 +29,12 @@ export class IncompatibleClientError extends BaseError {
  */
 export class InvalidRpcUrlError extends BaseError {
   override name = "InvalidRpcUrlError";
+
+  /**
+   * Creates an instance of an error with a message indicating an invalid RPC URL.
+   *
+   * @param {string} [rpcUrl] The invalid RPC URL that caused the error
+   */
   constructor(rpcUrl?: string) {
     super(`Invalid RPC URL ${rpcUrl}`);
   }
@@ -31,6 +45,10 @@ export class InvalidRpcUrlError extends BaseError {
  */
 export class ChainNotFoundError extends BaseError {
   override name = "ChainNotFoundError";
+
+  /**
+   * Initializes a new instance of the error message with a default message indicating that no chain was supplied to the client.
+   */
   constructor() {
     super("No chain supplied to the client");
   }

package/src/errors/entrypoint.ts

@@ -7,6 +7,12 @@ import { BaseError } from "./base.js";
 export class EntryPointNotFoundError extends BaseError {
   override name = "EntryPointNotFoundError";
 
+  /**
+   * Constructs an error message indicating that no default entry point exists for the given chain and entry point version.
+   *
+   * @param {Chain} chain The blockchain network for which the entry point is being queried
+   * @param {any} entryPointVersion The version of the entry point for which no default exists
+   */
   constructor(chain: Chain, entryPointVersion: any) {
     super(
       [
@@ -23,6 +29,12 @@ export class EntryPointNotFoundError extends BaseError {
 export class InvalidEntryPointError extends BaseError {
   override name = "InvalidEntryPointError";
 
+  /**
+   * Constructs an error indicating an invalid entry point version for a specific chain.
+   *
+   * @param {Chain} chain The chain object containing information about the blockchain
+   * @param {any} entryPointVersion The entry point version that is invalid
+   */
   constructor(chain: Chain, entryPointVersion: any) {
     super(
       `Invalid entry point: unexpected version ${entryPointVersion} for ${chain.name}.`

package/src/errors/signer.ts

@@ -5,6 +5,12 @@ import { BaseError } from "./base.js";
  */
 export class InvalidSignerTypeError extends BaseError {
   override name = "InvalidSignerTypeError";
+
+  /**
+   * Constructs an error message when an invalid signer type is passed to SmartAccountSigner.
+   *
+   * @param {string} [signerType] An optional parameter specifying the signer type. If not provided, a default error message will be used.
+   */
   constructor(signerType?: string) {
     super(
       [

package/src/errors/transaction.ts

@@ -6,7 +6,10 @@ import { BaseError } from "./base.js";
  */
 export class TransactionMissingToParamError extends BaseError {
   override name = "TransactionMissingToParamError";
-  constructor() {
+
+  /**
+   * Throws an error indicating that a transaction is missing the `to` address in the request.
+   */ constructor() {
     super("Transaction is missing `to` address set on request");
   }
 }
@@ -16,6 +19,12 @@ export class TransactionMissingToParamError extends BaseError {
  */
 export class FailedToFindTransactionError extends BaseError {
   override name = "FailedToFindTransactionError";
+
+  /**
+   * Constructs a new error message indicating a failure to find the transaction for the specified user operation hash.
+   *
+   * @param {Hex} hash The hexadecimal value representing the user operation hash.
+   */
   constructor(hash: Hex) {
     super(`Failed to find transaction for user operation ${hash}`);
   }