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

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

@@ -1,11 +1,103 @@
 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}`>;
+    /**
+     * 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 {
         [x: string]: readonly import("viem").TypedDataParameter[];
         [x: `string[${string}]`]: undefined;
@@ -33,31 +125,31 @@ export declare class WalletClientSigner implements SmartAccountSigner<WalletClie
         [x: `bytes9[${string}]`]: undefined;
         [x: `bytes10[${string}]`]: undefined;
         [x: `bytes25[${string}]`]: undefined;
+        [x: `bytes31[${string}]`]: undefined;
+        [x: `bytes30[${string}]`]: undefined;
+        [x: `bytes29[${string}]`]: undefined;
+        [x: `bytes28[${string}]`]: undefined;
+        [x: `bytes27[${string}]`]: undefined;
+        [x: `bytes26[${string}]`]: undefined;
+        [x: `bytes24[${string}]`]: undefined;
+        [x: `bytes23[${string}]`]: undefined;
+        [x: `bytes22[${string}]`]: undefined;
+        [x: `bytes21[${string}]`]: undefined;
+        [x: `bytes20[${string}]`]: undefined;
+        [x: `bytes19[${string}]`]: undefined;
         [x: `bytes18[${string}]`]: undefined;
-        [x: `bytes12[${string}]`]: undefined;
-        [x: `bytes13[${string}]`]: undefined;
-        [x: `bytes14[${string}]`]: undefined;
-        [x: `bytes15[${string}]`]: undefined;
-        [x: `bytes16[${string}]`]: undefined;
         [x: `bytes17[${string}]`]: undefined;
-        [x: `bytes19[${string}]`]: undefined;
-        [x: `bytes20[${string}]`]: undefined;
-        [x: `bytes21[${string}]`]: undefined;
-        [x: `bytes22[${string}]`]: undefined;
-        [x: `bytes23[${string}]`]: undefined;
-        [x: `bytes24[${string}]`]: undefined;
-        [x: `bytes26[${string}]`]: undefined;
-        [x: `bytes27[${string}]`]: undefined;
-        [x: `bytes28[${string}]`]: undefined;
-        [x: `bytes29[${string}]`]: undefined;
-        [x: `bytes30[${string}]`]: undefined;
-        [x: `bytes31[${string}]`]: undefined;
+        [x: `bytes16[${string}]`]: undefined;
+        [x: `bytes15[${string}]`]: undefined;
+        [x: `bytes14[${string}]`]: undefined;
+        [x: `bytes13[${string}]`]: undefined;
+        [x: `bytes12[${string}]`]: undefined;
         [x: `int[${string}]`]: undefined;
         [x: `int8[${string}]`]: undefined;
-        [x: `int16[${string}]`]: undefined;
-        [x: `int24[${string}]`]: undefined;
-        [x: `int32[${string}]`]: undefined;
         [x: `int40[${string}]`]: undefined;
+        [x: `int32[${string}]`]: undefined;
+        [x: `int24[${string}]`]: undefined;
+        [x: `int16[${string}]`]: undefined;
         [x: `int48[${string}]`]: undefined;
         [x: `int56[${string}]`]: undefined;
         [x: `int64[${string}]`]: undefined;
@@ -86,9 +178,9 @@ export declare class WalletClientSigner implements SmartAccountSigner<WalletClie
         [x: `int248[${string}]`]: undefined;
         [x: `int256[${string}]`]: undefined;
         [x: `uint[${string}]`]: undefined;
-        [x: `uint16[${string}]`]: undefined;
-        [x: `uint24[${string}]`]: undefined;
         [x: `uint40[${string}]`]: undefined;
+        [x: `uint24[${string}]`]: undefined;
+        [x: `uint16[${string}]`]: undefined;
         [x: `uint56[${string}]`]: undefined;
         [x: `uint72[${string}]`]: undefined;
         [x: `uint80[${string}]`]: undefined;
@@ -135,30 +227,30 @@ export declare class WalletClientSigner implements SmartAccountSigner<WalletClie
         bytes9?: undefined;
         bytes10?: undefined;
         bytes25?: undefined;
+        bytes31?: undefined;
+        bytes30?: undefined;
+        bytes29?: undefined;
+        bytes28?: undefined;
+        bytes27?: undefined;
+        bytes26?: undefined;
+        bytes24?: undefined;
+        bytes23?: undefined;
+        bytes22?: undefined;
+        bytes21?: undefined;
+        bytes20?: undefined;
+        bytes19?: undefined;
         bytes18?: undefined;
-        bytes12?: undefined;
-        bytes13?: undefined;
-        bytes14?: undefined;
-        bytes15?: undefined;
-        bytes16?: undefined;
         bytes17?: undefined;
-        bytes19?: undefined;
-        bytes20?: undefined;
-        bytes21?: undefined;
-        bytes22?: undefined;
-        bytes23?: undefined;
-        bytes24?: undefined;
-        bytes26?: undefined;
-        bytes27?: undefined;
-        bytes28?: undefined;
-        bytes29?: undefined;
-        bytes30?: undefined;
-        bytes31?: undefined;
+        bytes16?: undefined;
+        bytes15?: undefined;
+        bytes14?: undefined;
+        bytes13?: undefined;
+        bytes12?: undefined;
         int8?: undefined;
-        int16?: undefined;
-        int24?: undefined;
-        int32?: undefined;
         int40?: undefined;
+        int32?: undefined;
+        int24?: undefined;
+        int16?: undefined;
         int48?: undefined;
         int56?: undefined;
         int64?: undefined;
@@ -186,9 +278,9 @@ export declare class WalletClientSigner implements SmartAccountSigner<WalletClie
         int240?: undefined;
         int248?: undefined;
         int256?: undefined;
-        uint16?: undefined;
-        uint24?: undefined;
         uint40?: undefined;
+        uint24?: undefined;
+        uint16?: undefined;
         uint56?: undefined;
         uint72?: undefined;
         uint80?: undefined;

package/dist/types/signer/wallet-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet-client.d.ts","sourceRoot":"","sources":["../../../src/signer/wallet-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,GAAG,EACR,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,qBAAa,kBAAmB,YAAW,kBAAkB,CAAC,YAAY,CAAC;IACzE,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,YAAY,CAAC;gBAER,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM;IAQpD,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAGtC;IAEF,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAKtE;IAEJ,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0GAKV,QAAQ,GAAG,CAAC,CAOb;CACH"}
+{"version":3,"file":"wallet-client.d.ts","sourceRoot":"","sources":["../../../src/signer/wallet-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,GAAG,EACR,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD;;GAEG;AACH,qBAAa,kBAAmB,YAAW,kBAAkB,CAAC,YAAY,CAAC;IACzE,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,YAAY,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM;IAQpD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAGtC;IAEF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAKtE;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0GAKV,QAAQ,GAAG,CAAC,CAOb;CACH"}

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

@@ -35,8 +35,8 @@ export interface SplitTransportParams {
  * });
  * ```
  *
- * @param params {@link SplitTransportParams} split transport configuration containing the methods overrides and fallback transport
- * @returns a {@link CustomTransport} that splits traffic
+ * @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;
 //# sourceMappingURL=split.d.ts.map

package/dist/types/utils/bigint.d.ts

@@ -2,24 +2,24 @@ import type { BigNumberish, Multiplier } from "../types";
 /**
  * Returns the max bigint in a list of bigints
  *
- * @param args a list of bigints to get the max of
- * @returns the max bigint in the list
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the max bigint in the list
  */
 export declare const bigIntMax: (...args: bigint[]) => bigint;
 /**
  * Returns the min bigint in a list of bigints
  *
- * @param args a list of bigints to get the max of
- * @returns the min bigint in the list
+ * @param {bigint[]} args a list of bigints to get the max of
+ * @returns {bigint} the min bigint in the list
  */
 export declare const bigIntMin: (...args: bigint[]) => bigint;
 /**
  * Given a bigint and a min-max range, returns the min-max clamped bigint value
  *
- * @param value a bigint value to clamp
- * @param lower lower bound min max tuple value
- * @param upper upper bound min max tuple value
- * @returns the clamped bigint value per given range
+ * @param {BigNumberish} value a bigint value to clamp
+ * @param {BigNumberish | undefined} lower lower bound min max tuple value
+ * @param {BigNumberish | undefined} upper upper bound min max tuple value
+ * @returns {bigint} the clamped bigint value per given range
  */
 export declare const bigIntClamp: (value: BigNumberish, lower: BigNumberish | null | undefined, upper: BigNumberish | null | undefined) => bigint;
 export declare enum RoundingMode {
@@ -30,10 +30,10 @@ export declare enum RoundingMode {
  * Given a bigint and a number (which can be a float), returns the bigint value.
  * Note: this function has loss and will round down to the nearest integer.
  *
- * @param base - the number to be multiplied
- * @param multiplier - the amount to multiply by
- * @param roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP
- * @returns the bigint value of the multiplication with the number rounded by the rounding mode
+ * @param {BigNumberish} base - the number to be multiplied
+ * @param {number} multiplier - the amount to multiply by
+ * @param {RoundingMode} roundingMode - the rounding mode to use when calculating the percent. defaults to ROUND_UP
+ * @returns {bigint} the bigint value of the multiplication with the number rounded by the rounding mode
  */
 export declare const bigIntMultiply: (base: BigNumberish, multiplier: Multiplier["multiplier"], roundingMode?: RoundingMode) => bigint;
 /**
@@ -49,8 +49,8 @@ export declare const bigIntMultiply: (base: BigNumberish, multiplier: Multiplier
  * });
  * ```
  *
- * @param phrase -- any string value.
- * @returns the bigint value of the hashed string
+ * @param {string} phrase -- any string value.
+ * @returns {bigint} the bigint value of the hashed string
  */
 export declare const stringToIndex: (phrase: string) => bigint;
 //# sourceMappingURL=bigint.d.ts.map

package/dist/types/utils/bigint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bigint.d.ts","sourceRoot":"","sources":["../../../src/utils/bigint.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGzD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,EAAE,KAAG,MAM7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,EAAE,KAAG,MAM7C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,UACf,YAAY,SACZ,YAAY,GAAG,IAAI,GAAG,SAAS,SAC/B,YAAY,GAAG,IAAI,GAAG,SAAS,WAmBvC,CAAC;AAEF,oBAAY,YAAY;IACtB,UAAU,IAAI;IACd,QAAQ,IAAI;CACb;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,SACnB,YAAY,cACN,UAAU,CAAC,YAAY,CAAC,iBACtB,YAAY,WAiB3B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,WAAY,MAAM,KAAG,MACb,CAAC"}
+{"version":3,"file":"bigint.d.ts","sourceRoot":"","sources":["../../../src/utils/bigint.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGzD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,EAAE,KAAG,MAM7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,EAAE,KAAG,MAM7C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,UACf,YAAY,SACZ,YAAY,GAAG,IAAI,GAAG,SAAS,SAC/B,YAAY,GAAG,IAAI,GAAG,SAAS,KACrC,MAkBF,CAAC;AAEF,oBAAY,YAAY;IACtB,UAAU,IAAI;IACd,QAAQ,IAAI;CACb;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,SACnB,YAAY,cACN,UAAU,CAAC,YAAY,CAAC,iBACtB,YAAY,WAiB3B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,WAAY,MAAM,KAAG,MACb,CAAC"}

package/dist/types/utils/bytes.d.ts

@@ -6,11 +6,11 @@ type TakeBytesOpts = {
 /**
  * Given a bytes string, returns a slice of the bytes
  *
- * @param bytes - the hex string representing bytes
- * @param opts - optional parameters for slicing the bytes
- * @param opts.offset - the offset in bytes to start slicing from
- * @param opts.count - the number of bytes to slice
- * @returns the sliced bytes
+ * @param {Hex} bytes - the hex string representing bytes
+ * @param {TakeBytesOpts} opts - optional parameters for slicing the bytes
+ * @param {number} opts.offset - the offset in bytes to start slicing from
+ * @param {number} opts.count - the number of bytes to slice
+ * @returns {Hex} the sliced bytes
  */
 export declare const takeBytes: (bytes: Hex, opts?: TakeBytesOpts) => Hex;
 export {};

package/dist/types/utils/defaults.d.ts

@@ -1,15 +1,5 @@
-import { type Address, type Chain } from "viem";
-import type { EntryPointVersion } from "../entrypoint/types.js";
-import type { UserOperationFeeOptions } from "../types";
-/**
- * Utility method returning the default simple account factory address given a {@link Chain} object
- *
- * @param chain - a {@link Chain} object
- * @param version - {@link EntryPointVersion} value that defaults to `defaultEntryPointVersion`
- * @returns a {@link abi.Address} for the given chain
- * @throws if the chain doesn't have an address currently deployed
- */
-export declare const getDefaultSimpleAccountFactoryAddress: (chain: Chain, version?: EntryPointVersion) => Address;
+import { type Chain } from "viem";
+import type { UserOperationFeeOptions } from "../types.js";
 export declare const minPriorityFeePerBidDefaults: Map<number, bigint>;
 export declare const getDefaultUserOperationFeeOptions: (chain: Chain) => UserOperationFeeOptions;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/types/utils/defaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../src/utils/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,MAAM,CAAC;AAuBhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAExD;;;;;;;GAOG;AACH,eAAO,MAAM,qCAAqC,UACzC,KAAK,YACH,iBAAiB,KACzB,OAqCF,CAAC;AAEF,eAAO,MAAM,4BAA4B,qBAIvC,CAAC;AAEH,eAAO,MAAM,iCAAiC,UACrC,KAAK,KACX,uBAOF,CAAC"}
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../src/utils/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE3D,eAAO,MAAM,4BAA4B,qBAIvC,CAAC;AAEH,eAAO,MAAM,iCAAiC,UACrC,KAAK,KACX,uBAOF,CAAC"}

package/dist/types/utils/index.d.ts

@@ -1,58 +1,101 @@
-import type { Chain } from "viem";
 import type { PromiseOrValue } from "../types.js";
 import type { RecordableKeys } from "./types.js";
-export declare const AlchemyChainMap: Map<number, Chain>;
-/**
- * Utility method for converting a chainId to a {@link Chain} object
- *
- * @param chainId - the chainId to convert
- * @returns a {@link Chain} object for the given chainId
- * @throws if the chainId is not found
- */
-export declare const getChain: (chainId: number) => Chain;
 /**
  * Utility function that allows for piping a series of async functions together
  *
- * @param fns - functions to pipe
- * @returns result of the pipe
+ * @param {((s: S, o?: O, f?: F) => Promise<S>)[]} fns - functions to pipe
+ * @returns {S} result of the pipe
  */
 export declare const asyncPipe: <S, O, F>(...fns: ((s: S, o?: O | undefined, f?: F | undefined) => Promise<S>)[]) => (s: S, o?: O | undefined, f?: F | undefined) => Promise<S>;
 export type Deferrable<T> = {
     [K in keyof T]: PromiseOrValue<T[K]>;
 };
 /**
- * Await all of the properties of a {@link Deferrable} object
+ * Await all of the properties of a Deferrable object
  *
- * @param object - a {@link Deferrable} object
- * @returns the object with its properties resolved
+ * @param {Deferrable<T>} object - a Deferrable object
+ * @returns {Promise<T>} the object with its properties resolved
  */
 export declare function resolveProperties<T>(object: Deferrable<T>): Promise<T>;
 /**
  * Recursively converts all values in an object to hex strings
  *
- * @param obj - obj to deep hexlify
- * @returns object with all of its values hexlified
+ * @param {any} obj - obj to deep hexlify
+ * @returns {any} object with all of its values hexlified
  */
 export declare function deepHexlify(obj: any): any;
-export declare function defineReadOnly<T, K extends keyof T>(object: T, key: K, value: T[K]): void;
+/**
+ * Filters out properties with undefined or null values from the provided object.
+ *
+ * @example
+ * ```ts
+ * import { filterUndefined } from "@aa-sdk/core";
+ *
+ * const result = filterUndefined({
+ *  foo: undefined,
+ *  bar: null,
+ *  baz: "baz",
+ * }); // { baz: "baz" }
+ * ```
+ *
+ * @param {T} obj the object from which to remove properties with undefined or null values
+ * @returns {T} the object with undefined or null properties removed
+ */
 export declare function filterUndefined<T>(obj: T): T;
+/**
+ * Picks the specified keys from an object and returns a new object containing only those key-value pairs.
+ *
+ * @example
+ * ```ts
+ * import { pick } from "@aa-sdk/core";
+ *
+ * const picked = pick({
+ *  foo: "foo",
+ *  bar: "bar",
+ * }, ["foo"]); // { foo: "foo" }
+ * ```
+ *
+ * @param {Record<string, unknown>} obj The object from which to pick keys
+ * @param {string|string[]} keys A single key or an array of keys to pick from the object
+ * @returns {Record<string, unknown>} A new object containing only the picked key-value pairs
+ */
 export declare function pick(obj: Record<string, unknown>, keys: string | string[]): {};
 /**
  * Utility method for checking if the passed in values are all equal (strictly)
  *
- * @param params - values to check
- * @returns a boolean indicating if all values are the same
+ * @param {...any[]} params - values to check
+ * @returns {boolean} a boolean indicating if all values are the same
  * @throws if no values are passed in
  */
 export declare const allEqual: (...params: any[]) => boolean;
 /**
  * Utility method for checking the condition and return the value if condition holds true, undefined if not.
  *
- * @param condition - condition to check
- * @param value - value to return when condition holds true
- * @returns the value if condition holds true, undefined if not
+ * @param {Promise<boolean>} condition - condition to check
+ * @param {() => Promise<T>} value - value to return when condition holds true
+ * @returns {Promise<T | undefined>} the value if condition holds true, undefined if not
  */
 export declare const conditionalReturn: <T>(condition: Promise<boolean>, value: () => Promise<T>) => Promise<T | undefined>;
+/**
+ * Converts an array of objects into a record (object) where each key is determined by the specified selector and the value is determined by the provided function.
+ *
+ * @example
+ * ```ts
+ * import { toRecord } from "@aa-sdk/core";
+ * import { sepolia, mainnet } from "viem/chains";
+ *
+ * const addressesByChain = toRecord(
+ *  [sepolia, mainnet],
+ *  "id",
+ *  () => "0x..."
+ * ); // { [sepolia.id]: "0x...", [mainnet.id]: "0x..." }
+ * ```
+ *
+ * @param {T[]} array The array of objects to convert to a record
+ * @param {K} selector The key used to select the property that will become the record's key
+ * @param {(item: T) => V} fn The function that transforms each item in the array into the record's value
+ * @returns {Record<T[K], V>} The resulting record object
+ */
 export declare const toRecord: <T extends { [K in RecordableKeys<T>]: string | number | symbol; }, K_1 extends RecordableKeys<T>, V>(array: T[], selector: K_1, fn: (item: T) => V) => Record<T[K_1], V>;
 export * from "./bigint.js";
 export * from "./bytes.js";

package/dist/types/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,eAAO,MAAM,eAAe,oBAE3B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,YAAa,MAAM,KAAG,KAO1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,iJAQnB,CAAC;AAGJ,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACzB,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAc5E;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAqBzC;AAGD,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EACjD,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GACV,IAAI,CAMN;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAO5C;AAED,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAIzE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,cAAe,GAAG,EAAE,KAAG,OAK3C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,iBACjB,QAAQ,OAAO,CAAC,oDAEgD,CAAC;AAE9E,eAAO,MAAM,QAAQ,2KAYM,CAAC;AAE5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,mBAAmB,YAAY,CAAC;AAChC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,iJAQnB,CAAC;AAGJ,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACzB,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAc5E;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAqBzC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAO5C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAIzE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,cAAe,GAAG,EAAE,KAAG,OAK3C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,iBACjB,QAAQ,OAAO,CAAC,oDAEgD,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,QAAQ,2KAYM,CAAC;AAE5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,mBAAmB,YAAY,CAAC;AAChC,cAAc,aAAa,CAAC"}

package/dist/types/utils/types.d.ts

@@ -7,7 +7,7 @@
  */
 export type NoUndefined<T> = T extends undefined ? never : T;
 /**
- * @description Checks if {@link T} is `undefined`
+ * @description Checks if T is `undefined`
  * @param T - Type to check
  * @example
  * type Result = IsUndefined<undefined>
@@ -18,7 +18,7 @@ export type RequiredBy<TType, TKeys extends keyof TType> = Required<Pick<TType,
 /**
  * @description Combines members of an intersection into a readable type.
  *
- * @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg}
+ * @see https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg
  * @example
  * Prettify<{ a: string } & { b: string } & { c: number, d: bigint }>
  * => { a: string, b: string, c: number, d: bigint }

package/dist/types/utils/userop.d.ts

@@ -2,53 +2,53 @@ import { type Hex } from "viem";
 import type { EntryPointVersion } from "../entrypoint/types";
 import type { BigNumberish, Multiplier, UserOperationFeeOptionsField, UserOperationOverrides, UserOperationRequest, UserOperationStruct } from "../types";
 /**
- * Utility method for asserting a {@link UserOperationStruct} has valid fields for the given entry point version
+ * Utility method for asserting a UserOperationStruct has valid fields for the given entry point version
  *
- * @param request a {@link UserOperationStruct} to validate
- * @returns a type guard that asserts the {@link UserOperationRequest} is valid
+ * @param {UserOperationStruct} request a UserOperationStruct to validate
+ * @returns {boolean} a type guard that asserts the UserOperationRequest is valid
  */
 export declare function isValidRequest<TEntryPointVersion extends EntryPointVersion = EntryPointVersion>(request: UserOperationStruct<TEntryPointVersion>): request is UserOperationRequest<TEntryPointVersion>;
 /**
- * Utility method for asserting a {@link UserOperationRequest} has valid fields for the paymaster data
+ * Utility method for asserting a UserOperationRequest has valid fields for the paymaster data
  *
- * @param request a {@link UserOperationRequest} to validate
- * @returns a type guard that asserts the {@link UserOperationRequest} is a {@link UserOperationRequest}
+ * @param {UserOperationRequest} request a UserOperationRequest to validate
+ * @returns {boolean}  a type guard that asserts the UserOperationRequest is a UserOperationRequest
  */
 export declare function isValidPaymasterAndData<TEntryPointVersion extends EntryPointVersion = EntryPointVersion>(request: UserOperationStruct<TEntryPointVersion>): boolean;
 /**
- * Utility method for asserting a {@link UserOperationStruct} has valid fields for the paymaster data
+ * Utility method for asserting a UserOperationStruct has valid fields for the paymaster data
  *
- * @param request a {@link UserOperationRequest} to validate
- * @returns a type guard that asserts the {@link UserOperationStruct} is a {@link UserOperationRequest}
+ * @param {UserOperationRequest} request a UserOperationRequest to validate
+ * @returns {boolean} a type guard that asserts the UserOperationStruct is a UserOperationRequest
  */
 export declare function isValidFactoryAndData<TEntryPointVersion extends EntryPointVersion = EntryPointVersion>(request: UserOperationStruct<TEntryPointVersion>): boolean;
 /**
- * Utility method for applying a {@link UserOperationOverrides} field value
+ * Utility method for applying a UserOperationOverrides field value
  * over the current value set for the field
  *
- * @param value the current value of the field
- * @param override the override value to apply
- * @returns the new value of the field after applying the override
+ * @param {BigNumberish} value the current value of the field
+ * @param {BigNumberish | Multiplier} override the override value to apply
+ * @returns {BigNumberish} the new value of the field after applying the override
  */
 export declare function applyUserOpOverride<TValue extends BigNumberish | undefined>(value: TValue, override?: BigNumberish | Multiplier): TValue | BigNumberish;
 /**
- * Utility method for applying a {@link UserOperationFeeOptionsField} value
+ * Utility method for applying a UserOperationFeeOptionsField value
  * over the current value set for the field
  *
- * @param value the current value of the field
- * @param feeOption the fee option field value to apply
- * @returns the new value of the field after applying the fee option
+ * @param {BigNumberish} value the current value of the field
+ * @param {UserOperationFeeOptionsField} feeOption the override value to apply
+ * @returns {BigNumberish} the new value of the field after applying the override
  */
 export declare function applyUserOpFeeOption<TValue extends BigNumberish | undefined>(value: TValue, feeOption?: UserOperationFeeOptionsField): TValue | BigNumberish;
 /**
- * Utility method for applying a {@link UserOperationOverrides} field value and
- * a {@link UserOperationFeeOptionsField} value over the current value set for the field,
+ * Utility method for applying a UserOperationOverrides field value and
+ * a UserOperationFeeOptionsField value over the current value set for the field,
  * with the override taking precedence over the fee option
  *
- * @param value the current value of the field
- * @param [override] the override value to apply
- * @param [feeOption] the fee option field value to apply
- * @returns the new value of the field after applying the override or fee option
+ * @param {BigNumberish} value the current value of the field
+ * @param {BigNumberish | Multiplier} [override] the override value to apply
+ * @param {UserOperationFeeOptionsField} [feeOption] the fee option field value to apply
+ * @returns {BigNumberish} the new value of the field after applying the override or fee option
  */
 export declare function applyUserOpOverrideOrFeeOption<TValue extends BigNumberish | undefined>(value: TValue, override?: BigNumberish | Multiplier, feeOption?: UserOperationFeeOptionsField): TValue | BigNumberish;
 /**
@@ -57,8 +57,8 @@ export declare function applyUserOpOverrideOrFeeOption<TValue extends BigNumberi
  * either because the UserOp is paying for its own gas, or passing a specific paymaster
  *
  * @template EntryPointVersion TEntryPointVersion
- * @param overrides the user operation overrides to check
- * @returns whether the paymaster middleware should be bypassed
+ * @param {UserOperationOverrides<TEntryPointVersion> | undefined} overrides the user operation overrides to check
+ * @returns {boolean} whether the paymaster middleware should be bypassed
  */
 export declare const bypassPaymasterAndData: <TEntryPointVersion extends keyof import("../entrypoint/types").EntryPointRegistryBase<unknown> = keyof import("../entrypoint/types").EntryPointRegistryBase<unknown>>(overrides: Partial<{
     callGasLimit: {
@@ -85,8 +85,8 @@ export declare const bypassPaymasterAndData: <TEntryPointVersion extends keyof i
  * pay for its own gas
  *
  * @template EntryPointVersion TEntryPointVersion
- * @param overrides the user operation overrides to check
- * @returns whether the paymaster middleware should be bypassed
+ * @param {UserOperationOverrides<TEntryPointVersion> | undefined} overrides the user operation overrides to check
+ * @returns {boolean} whether the paymaster middleware should be bypassed
  */
 export declare const bypassPaymasterAndDataEmptyHex: <TEntryPointVersion extends keyof import("../entrypoint/types").EntryPointRegistryBase<unknown> = keyof import("../entrypoint/types").EntryPointRegistryBase<unknown>>(overrides: Partial<{
     callGasLimit: {
@@ -110,20 +110,20 @@ export declare const bypassPaymasterAndDataEmptyHex: <TEntryPointVersion extends
 /**
  * Utility method for parsing the paymaster address and paymasterData from the paymasterAndData hex string
  *
- * @param paymasterAndData the paymaster and data hex string to parse.
+ * @param {Hex} paymasterAndData the paymaster and data hex string to parse.
  *                         The hex string refers to the paymasterAndData field of entrypoint v0.6 user operation request
- * @returns the parsed paymaster and paymasterData fields of entrypoint v0.7 user operation request paymaster and paymasterData field
+ * @returns {{ paymaster: Hex; paymasterData: Hex}} the parsed paymaster and paymasterData fields of entrypoint v0.7 user operation request paymaster and paymasterData field
  */
 export declare const parsePaymasterAndData: (paymasterAndData: Hex) => Pick<UserOperationRequest<"0.7.0">, "paymaster" | "paymasterData">;
 /**
  * Utility method for converting the object containing the paymaster address and paymaster data
  * to the paymaster and data concatenated hex string
  *
- * @param paymasterAndData the object containing the picked paymaster and paymasterData fields of
+ * @param {{ paymaster: Hex; paymasterData: Hex}} paymasterAndData the object containing the picked paymaster and paymasterData fields of
  *                         entrypoint v0.7 user operation request
- * @param paymasterAndData.paymaster the paymaster address
- * @param paymasterAndData.paymasterData the paymaster data
- * @returns the paymasterAndData hex value of entrypoint v0.6 user operation request paymasterAndData field
+ * @param {Hex} paymasterAndData.paymaster the paymaster address
+ * @param {Hex} paymasterAndData.paymasterData the paymaster data
+ * @returns {Hex} the paymasterAndData hex value of entrypoint v0.6 user operation request paymasterAndData field
  */
 export declare const concatPaymasterAndData: ({ paymaster, paymasterData, }: Pick<UserOperationRequest<"0.7.0">, "paymaster" | "paymasterData">) => Hex;
 //# sourceMappingURL=userop.d.ts.map

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.0.0-alpha.0";
+export declare const VERSION = "4.0.0-alpha.10";
 //# sourceMappingURL=version.d.ts.map

package/dist/types/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,mBAAmB,CAAC"}