@account-kit/infra 4.0.0-alpha.0 → 4.0.0-alpha.1

package/src/client/smartAccountClient.ts

@@ -115,6 +115,23 @@ export function createAlchemySmartAccountClient<
   TContext
 >;
 
+/**
+ * Creates an Alchemy smart account client using the provided configuration options, including account details, gas manager configuration, and custom middleware.
+ *
+ * @example
+ * ```ts
+ * import { createAlchemySmartAccountClient } from "@account-kit/infra";
+ * import { sepolia } from "@account-kit/infra/chain";
+ *
+ * const client = createAlchemySmartAccountClient({
+ *  chain: sepolia,
+ *  apiKey: "your-api-key",
+ * });
+ * ```
+ *
+ * @param {AlchemySmartAccountClientConfig} config The configuration for creating the Alchemy smart account client
+ * @returns {AlchemySmartAccountClient} An instance of `AlchemySmartAccountClient` configured based on the provided options
+ */
 export function createAlchemySmartAccountClient({
   account,
   gasManagerConfig,

package/src/defaults.ts

@@ -9,6 +9,20 @@ import {
 } from "@aa-sdk/core";
 import type { Chain } from "viem";
 
+/**
+ * Retrieves the default user operation fee options for a given chain. Adjusts fees for specific chains like Arbitrum and Optimism.
+ *
+ * @example
+ * ```ts
+ * import { getDefaultUserOperationFeeOptions } from "@account-kit/infra";
+ * import { arbitrum } from "@account-kit/infra/chains";
+ *
+ * const feeOpts = getDefaultUserOperationFeeOptions(arbitrum);
+ * ```
+ *
+ * @param {Chain} chain The blockchain chain for which to get the fee options
+ * @returns {UserOperationFeeOptions} An object containing the default fee options for user operations on the specified chain
+ */
 export const getDefaultUserOperationFeeOptions = (
   chain: Chain
 ): UserOperationFeeOptions => {

package/src/gas-manager.ts

@@ -1,21 +1,21 @@
-import type { Address, Chain } from "viem";
 import {
   arbitrum,
   arbitrumSepolia,
   base,
   baseSepolia,
+  fraxtal,
+  fraxtalSepolia,
   mainnet,
-  sepolia,
   optimism,
   optimismSepolia,
   polygon,
   polygonAmoy,
   polygonMumbai,
-  fraxtal,
-  fraxtalSepolia,
+  sepolia,
   zora,
   zoraSepolia,
 } from "@aa-sdk/core";
+import type { Address, Chain } from "viem";
 
 export const AlchemyPaymasterAddressV3 =
   "0x4f84a207A80c39E9e8BaE717c1F25bA7AD1fB08F";
@@ -26,6 +26,19 @@ export const ArbSepoliaPaymasterAddress =
 export const AlchemyPaymasterAddressV1 =
   "0xc03aac639bb21233e0139381970328db8bceeb67";
 
+/**
+ * Retrieves the Alchemy paymaster address for the given chain. Returns different addresses based on the chain ID.
+ *
+ * @example
+ * ```ts
+ * import { sepolia, getAlchemyPaymasterAddress } from "@account-kit/infra/chains";
+ *
+ * const paymasterAddress = getAlchemyPaymasterAddress(sepolia);
+ * ```
+ *
+ * @param {Chain} chain The chain for which the paymaster address is required
+ * @returns {Address} The Alchemy paymaster address corresponding to the specified chain
+ */
 export const getAlchemyPaymasterAddress = (chain: Chain): Address => {
   switch (chain.id) {
     case polygonAmoy.id:

package/src/index.ts

@@ -1,6 +1,7 @@
 export type * from "./actions/simulateUserOperationChanges.js";
 export { simulateUserOperationChanges } from "./actions/simulateUserOperationChanges.js";
 export type * from "./actions/types.js";
+export type * from "./chains.js";
 export { defineAlchemyChain } from "./chains.js";
 export type * from "./client/decorators/alchemyEnhancedApis.js";
 export { alchemyEnhancedApiActions } from "./client/decorators/alchemyEnhancedApis.js";

package/src/middleware/feeEstimator.ts

@@ -2,6 +2,25 @@ import type { ClientMiddlewareFn } from "@aa-sdk/core";
 import { applyUserOpOverrideOrFeeOption } from "@aa-sdk/core";
 import type { ClientWithAlchemyMethods } from "../client/types";
 
+/**
+ * Function that estimates the transaction fees using Alchemy methods for a given client.
+ * It fetches the latest block and estimates the max priority fee per gas, applying any overrides or fee options provided.
+ *
+ * @example
+ * ```ts
+ * import { alchemyFeeEstimator, createAlchemyPublicRpcClient } from "@account-kit/infra";
+ * import { createSmartAccountClient } from "@aa-sdk/core";
+ *
+ * const bundlerClient = createAlchemyPublicRpcClient(...);
+ * const client = createSmartAccountClient({
+ *  feeEstimator: alchemyFeeEstimator(bundlerClient),
+ *  ...otherParams
+ * });
+ * ```
+ *
+ * @param {ClientWithAlchemyMethods} client The client with Alchemy methods
+ * @returns {ClientMiddlewareFn} A middleware function that takes a transaction structure and fee options, and returns the augmented structure with estimated fees
+ */
 export const alchemyFeeEstimator: <C extends ClientWithAlchemyMethods>(
   client: C
 ) => ClientMiddlewareFn =

package/src/middleware/gasManager.ts

@@ -145,7 +145,7 @@ export interface AlchemyGasEstimationOptions {
 }
 
 /**
- * dummy paymaster and data middleware for the alchemy gas manager
+ * Dummy paymaster and data middleware for the alchemy gas manager
  *
  * @template {ClientWithAlchemyMethods} C
  * @param client client with alchemy methods

package/src/middleware/userOperationSimulator.ts

@@ -5,6 +5,25 @@ import {
 } from "@aa-sdk/core";
 import type { ClientWithAlchemyMethods } from "../client/types";
 
+/**
+ * A middleware function to be used during simulation of user operations which leverages Alchemy's RPC uo simulation method.
+ *
+ * @example
+ * ```ts
+ * import { alchemyUserOperationSimulator, createAlchemyPublicRpcClient } from "@account-kit/infra";
+ * import { createSmartAccountClient } from "@aa-sdk/core";
+ *
+ * const bundlerClient = createAlchemyPublicRpcClient(...);
+ * const client = createSmartAccountClient({
+ *  userOperationSimulator: alchemyUserOperationSimulator(bundlerClient),
+ *  ...otherParams
+ * });
+ * ```
+ *
+ * @template C The client object with Alchemy methods
+ * @param {C} client The client object with Alchemy methods
+ * @returns {ClientMiddlewareFn} A middleware function to simulate and process user operations
+ */
 export function alchemyUserOperationSimulator<
   C extends ClientWithAlchemyMethods
 >(client: C): ClientMiddlewareFn {

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.0";
+export const VERSION = "4.0.0-alpha.1";