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

package/dist/esm/ens/utils.js

@@ -1,18 +1,67 @@
 import * as chains from "viem/chains";
 import { mainnet } from "viem/chains";
 export const ChainsById = new Map(Object.values(chains).map((x) => [x.id, x]));
+/**
+ * Converts a given chain ID to a coin type, following specific standards for mainnet and non-mainnet chains.
+ *
+ * @example
+ * ```ts
+ * import { convertChainIdToCoinType } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ *
+ * const coinType = convertChainIdToCoinType(sepolia.id);
+ * ```
+ *
+ * @param {number} chainId the blockchain chain ID that you want to convert to a coin type
+ * @returns {number} the corresponding coin type for the given chain ID
+ */
 export const convertChainIdToCoinType = (chainId) => {
     if (chainId === mainnet.id) {
+        // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)
         return 60;
     }
+    // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains
     return (0x80000000 | chainId) >>> 0;
 };
+/**
+ * Converts a coin type to a chain ID based on predefined mappings. This function follows ENSIP-9 for coin type 60 and ENSIP-11 for other coin types.
+ *
+ * @example
+ * ```ts
+ * import { convertChainIdToCoinType, convertCoinTypeToChainId } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ *
+ * const coinType = convertChainIdToCoinType(sepolia.id);
+ * const chainId = convertCoinTypeToChainId(coinType);
+ * ```
+ *
+ * @param {number} coinType the coin type to be converted to a chain ID
+ * @returns {number} the corresponding chain ID
+ */
 export const convertCoinTypeToChainId = (coinType) => {
     if (coinType === 60) {
+        // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)
         return mainnet.id;
     }
+    // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains
     return (0x7fffffff & coinType) >> 0;
 };
+/**
+ * Converts a coin type to its corresponding blockchain chain based on a predefined mapping.
+ *
+ * @example
+ * ```ts
+ * import { convertChainIdToCoinType, convertCoinTypeToChain } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ *
+ * const coinType = convertChainIdToCoinType(sepolia.id);
+ * const chain = convertCoinTypeToChain(coinType);
+ * ```
+ *
+ * @param {number} coinType The numerical identifier for the coin type
+ * @returns {Chain} The corresponding blockchain chain
+ * @throws {Error} If the coin type does not map to a supported chain
+ */
 export const convertCoinTypeToChain = (coinType) => {
     const chainId = convertCoinTypeToChainId(coinType);
     const chain = ChainsById.get(chainId);

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

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/ens/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAc,MAAM,aAAa,CAAC;AAElD,MAAM,CAAC,MAAM,UAAU,GAA8B,IAAI,GAAG,CAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAC5C,CAAC;AAgBF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAAe,EAAU,EAAE;IAClE,IAAI,OAAO,KAAK,OAAO,CAAC,EAAE,EAAE,CAAC;QAE3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAGD,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,CAAC;AAiBF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAU,EAAE;IACnE,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QAEpB,OAAO,OAAO,CAAC,EAAE,CAAC;IACpB,CAAC;IAGD,OAAO,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC,CAAC;AAkBF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAS,EAAE;IAChE,MAAM,OAAO,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["import * as chains from \"viem/chains\";\nimport { mainnet, type Chain } from \"viem/chains\";\n\nexport const ChainsById: Map<number, chains.Chain> = new Map(\n  Object.values(chains).map((x) => [x.id, x])\n);\n\n/**\n * Converts a given chain ID to a coin type, following specific standards for mainnet and non-mainnet chains.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * ```\n *\n * @param {number} chainId the blockchain chain ID that you want to convert to a coin type\n * @returns {number} the corresponding coin type for the given chain ID\n */\nexport const convertChainIdToCoinType = (chainId: number): number => {\n  if (chainId === mainnet.id) {\n    // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)\n    return 60;\n  }\n\n  // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains\n  return (0x80000000 | chainId) >>> 0;\n};\n\n/**\n * Converts a coin type to a chain ID based on predefined mappings. This function follows ENSIP-9 for coin type 60 and ENSIP-11 for other coin types.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType, convertCoinTypeToChainId } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * const chainId = convertCoinTypeToChainId(coinType);\n * ```\n *\n * @param {number} coinType the coin type to be converted to a chain ID\n * @returns {number} the corresponding chain ID\n */\nexport const convertCoinTypeToChainId = (coinType: number): number => {\n  if (coinType === 60) {\n    // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)\n    return mainnet.id;\n  }\n\n  // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains\n  return (0x7fffffff & coinType) >> 0;\n};\n\n/**\n * Converts a coin type to its corresponding blockchain chain based on a predefined mapping.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType, convertCoinTypeToChain } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * const chain = convertCoinTypeToChain(coinType);\n * ```\n *\n * @param {number} coinType The numerical identifier for the coin type\n * @returns {Chain} The corresponding blockchain chain\n * @throws {Error} If the coin type does not map to a supported chain\n */\nexport const convertCoinTypeToChain = (coinType: number): Chain => {\n  const chainId = convertCoinTypeToChainId(coinType);\n  const chain = ChainsById.get(chainId);\n  if (!chain) {\n    throw new Error(\"CoinType does not map to a supported chain\");\n  }\n\n  return chain;\n};\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/ens/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAc,MAAM,aAAa,CAAC;AAElD,MAAM,CAAC,MAAM,UAAU,GAA8B,IAAI,GAAG,CAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAC5C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAAe,EAAU,EAAE;IAClE,IAAI,OAAO,KAAK,OAAO,CAAC,EAAE,EAAE,CAAC;QAC3B,sHAAsH;QACtH,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,uLAAuL;IACvL,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAU,EAAE;IACnE,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QACpB,sHAAsH;QACtH,OAAO,OAAO,CAAC,EAAE,CAAC;IACpB,CAAC;IAED,uLAAuL;IACvL,OAAO,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAS,EAAE;IAChE,MAAM,OAAO,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["import * as chains from \"viem/chains\";\nimport { mainnet, type Chain } from \"viem/chains\";\n\nexport const ChainsById: Map<number, chains.Chain> = new Map(\n  Object.values(chains).map((x) => [x.id, x])\n);\n\n/**\n * Converts a given chain ID to a coin type, following specific standards for mainnet and non-mainnet chains.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * ```\n *\n * @param {number} chainId the blockchain chain ID that you want to convert to a coin type\n * @returns {number} the corresponding coin type for the given chain ID\n */\nexport const convertChainIdToCoinType = (chainId: number): number => {\n  if (chainId === mainnet.id) {\n    // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)\n    return 60;\n  }\n\n  // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains\n  return (0x80000000 | chainId) >>> 0;\n};\n\n/**\n * Converts a coin type to a chain ID based on predefined mappings. This function follows ENSIP-9 for coin type 60 and ENSIP-11 for other coin types.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType, convertCoinTypeToChainId } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * const chainId = convertCoinTypeToChainId(coinType);\n * ```\n *\n * @param {number} coinType the coin type to be converted to a chain ID\n * @returns {number} the corresponding chain ID\n */\nexport const convertCoinTypeToChainId = (coinType: number): number => {\n  if (coinType === 60) {\n    // this comes from [ensip-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution)\n    return mainnet.id;\n  }\n\n  // this is using [ENSIP-11](https://docs.ens.domains/ens-improvement-proposals/ensip-11-evmchain-address-resolution) and assumes this is how mappings are stored for non mainnet chains\n  return (0x7fffffff & coinType) >> 0;\n};\n\n/**\n * Converts a coin type to its corresponding blockchain chain based on a predefined mapping.\n *\n * @example\n * ```ts\n * import { convertChainIdToCoinType, convertCoinTypeToChain } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const coinType = convertChainIdToCoinType(sepolia.id);\n * const chain = convertCoinTypeToChain(coinType);\n * ```\n *\n * @param {number} coinType The numerical identifier for the coin type\n * @returns {Chain} The corresponding blockchain chain\n * @throws {Error} If the coin type does not map to a supported chain\n */\nexport const convertCoinTypeToChain = (coinType: number): Chain => {\n  const chainId = convertCoinTypeToChainId(coinType);\n  const chain = ChainsById.get(chainId);\n  if (!chain) {\n    throw new Error(\"CoinType does not map to a supported chain\");\n  }\n\n  return chain;\n};\n"]}

package/dist/esm/entrypoint/index.d.ts

@@ -2,6 +2,20 @@ import { type Chain } from "viem";
 import type { DefaultEntryPointVersion, EntryPointDefRegistry, EntryPointRegistry, EntryPointVersion, GetEntryPointOptions } from "./types.js";
 export declare const defaultEntryPointVersion: DefaultEntryPointVersion;
 export declare const entryPointRegistry: EntryPointRegistry;
+/**
+ * Checks if the given value is a valid key of the EntryPointRegistry.
+ *
+ * @example
+ * ```ts
+ * import { isEntryPointVersion } from "@aa-sdk/core";
+ *
+ * const valid = isEntryPointVersion("0.6.0");
+ * const invalid = isEntryPointVersion("0.8.0");
+ * ```
+ *
+ * @param {*} value The value to be checked
+ * @returns {boolean} true if the value is a valid key of EntryPointRegistry, false otherwise
+ */
 export declare const isEntryPointVersion: (value: any) => value is keyof EntryPointRegistry<Chain>;
 export declare function getEntryPoint<TEntryPointVersion extends EntryPointVersion = DefaultEntryPointVersion, TChain extends Chain = Chain>(chain: TChain, options: GetEntryPointOptions<TEntryPointVersion>): EntryPointDefRegistry<TChain>[TEntryPointVersion];
 export declare function getEntryPoint<TEntryPointVersion extends DefaultEntryPointVersion = DefaultEntryPointVersion, TChain extends Chain = Chain>(chain: TChain, options?: GetEntryPointOptions<TEntryPointVersion>): EntryPointDefRegistry<TChain>[TEntryPointVersion];

package/dist/esm/entrypoint/index.js

@@ -7,9 +7,39 @@ export const entryPointRegistry = {
     "0.6.0": EntryPoint_v6,
     "0.7.0": EntryPoint_v7,
 };
+/**
+ * Checks if the given value is a valid key of the EntryPointRegistry.
+ *
+ * @example
+ * ```ts
+ * import { isEntryPointVersion } from "@aa-sdk/core";
+ *
+ * const valid = isEntryPointVersion("0.6.0");
+ * const invalid = isEntryPointVersion("0.8.0");
+ * ```
+ *
+ * @param {*} value The value to be checked
+ * @returns {boolean} true if the value is a valid key of EntryPointRegistry, false otherwise
+ */
 export const isEntryPointVersion = (value) => {
     return Object.keys(entryPointRegistry).includes(value);
 };
+/**
+ * Retrieves the entry point definition for the specified chain and version, falling back to the default version if not provided. Throws an error if the entry point address cannot be found.
+ *
+ * @example
+ * ```ts
+ * import { getEntryPoint } from "@aa-sdk/core";
+ * import { sepolia } from "viem/chains";
+ *
+ * const entryPoint060 = getEntryPoint(sepolia);
+ * const entryPoint070 = getEntryPoint(sepolia, { version: "0.7.0" });
+ * ```
+ *
+ * @param {Chain} chain The chain for which the entry point is being retrieved
+ * @param {GetEntryPointOptions<TEntryPointVersion>} options Options containing the version and address overrides for the entry point
+ * @returns {EntryPointDefRegistry<TChain>[EntryPointVersion]} The entry point definition for the specified chain and version
+ */
 export function getEntryPoint(chain, options) {
     const { version = defaultEntryPointVersion, addressOverride } = options ?? {
         version: defaultEntryPointVersion,

package/dist/esm/entrypoint/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/entrypoint/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,aAAa,MAAM,UAAU,CAAC;AACrC,OAAO,aAAa,MAAM,UAAU,CAAC;AASrC,MAAM,CAAC,MAAM,wBAAwB,GAA6B,OAAO,CAAC;AAE1E,MAAM,CAAC,MAAM,kBAAkB,GAAuB;IACpD,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,aAAa;CACvB,CAAC;AAgBF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAU,EACyB,EAAE;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC,CAAC;AAuCF,MAAM,UAAU,aAAa,CAI3B,KAAa,EACb,OAAiD;IAEjD,MAAM,EAAE,OAAO,GAAG,wBAAwB,EAAE,eAAe,EAAE,GAAG,OAAO,IAAI;QACzE,OAAO,EAAE,wBAAwB;KAClC,CAAC;IAEF,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,CAAC,CAAC;IAC3E,MAAM,OAAO,GACX,eAAe;QACf,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,OAAO;YACP,KAAK;YACL,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1B,UAAU,CAAC,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;SAChD,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAC1C,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,OAAO;YACP,KAAK;YACL,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1B,UAAU,CAAC,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;SAChD,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC","sourcesContent":["import { type Chain } from \"viem\";\nimport { EntryPointNotFoundError } from \"../errors/entrypoint.js\";\nimport EntryPoint_v6 from \"./0.6.js\";\nimport EntryPoint_v7 from \"./0.7.js\";\nimport type {\n  DefaultEntryPointVersion,\n  EntryPointDefRegistry,\n  EntryPointRegistry,\n  EntryPointVersion,\n  GetEntryPointOptions,\n} from \"./types.js\";\n\nexport const defaultEntryPointVersion: DefaultEntryPointVersion = \"0.6.0\";\n\nexport const entryPointRegistry: EntryPointRegistry = {\n  \"0.6.0\": EntryPoint_v6,\n  \"0.7.0\": EntryPoint_v7,\n};\n\n/**\n * Checks if the given value is a valid key of the EntryPointRegistry.\n *\n * @example\n * ```ts\n * import { isEntryPointVersion } from \"@aa-sdk/core\";\n *\n * const valid = isEntryPointVersion(\"0.6.0\");\n * const invalid = isEntryPointVersion(\"0.8.0\");\n * ```\n *\n * @param {*} value The value to be checked\n * @returns {boolean} true if the value is a valid key of EntryPointRegistry, false otherwise\n */\nexport const isEntryPointVersion = (\n  value: any\n): value is keyof EntryPointRegistry => {\n  return Object.keys(entryPointRegistry).includes(value);\n};\n\nexport function getEntryPoint<\n  TEntryPointVersion extends EntryPointVersion = DefaultEntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[TEntryPointVersion];\n\nexport function getEntryPoint<\n  TEntryPointVersion extends DefaultEntryPointVersion = DefaultEntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options?: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[TEntryPointVersion];\n\nexport function getEntryPoint<TChain extends Chain = Chain>(\n  chain: TChain,\n  options?: GetEntryPointOptions<DefaultEntryPointVersion>\n): EntryPointDefRegistry<TChain>[DefaultEntryPointVersion];\n\n/**\n * Retrieves the entry point definition for the specified chain and version, falling back to the default version if not provided. Throws an error if the entry point address cannot be found.\n *\n * @example\n * ```ts\n * import { getEntryPoint } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const entryPoint060 = getEntryPoint(sepolia);\n * const entryPoint070 = getEntryPoint(sepolia, { version: \"0.7.0\" });\n * ```\n *\n * @param {Chain} chain The chain for which the entry point is being retrieved\n * @param {GetEntryPointOptions<TEntryPointVersion>} options Options containing the version and address overrides for the entry point\n * @returns {EntryPointDefRegistry<TChain>[EntryPointVersion]} The entry point definition for the specified chain and version\n */\nexport function getEntryPoint<\n  TEntryPointVersion extends EntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[EntryPointVersion] {\n  const { version = defaultEntryPointVersion, addressOverride } = options ?? {\n    version: defaultEntryPointVersion,\n  };\n\n  const entryPoint = entryPointRegistry[version ?? defaultEntryPointVersion];\n  const address =\n    addressOverride ??\n    entryPoint.address[chain.id] ??\n    entryPoint.address.default;\n  if (!address) {\n    throw new EntryPointNotFoundError(chain, version);\n  }\n\n  if (entryPoint.version === \"0.6.0\") {\n    return {\n      version: entryPoint.version,\n      address,\n      chain,\n      abi: entryPoint.abi,\n      getUserOperationHash: (r) =>\n        entryPoint.getUserOperationHash(r, address, chain.id),\n      packUserOperation: entryPoint.packUserOperation,\n    };\n  } else if (entryPoint.version === \"0.7.0\") {\n    return {\n      version: entryPoint.version,\n      address,\n      chain,\n      abi: entryPoint.abi,\n      getUserOperationHash: (r) =>\n        entryPoint.getUserOperationHash(r, address, chain.id),\n      packUserOperation: entryPoint.packUserOperation,\n    };\n  }\n\n  throw new EntryPointNotFoundError(chain, version);\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/entrypoint/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,MAAM,MAAM,CAAC;AAClC,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,aAAa,MAAM,UAAU,CAAC;AACrC,OAAO,aAAa,MAAM,UAAU,CAAC;AASrC,MAAM,CAAC,MAAM,wBAAwB,GAA6B,OAAO,CAAC;AAE1E,MAAM,CAAC,MAAM,kBAAkB,GAAuB;IACpD,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,aAAa;CACvB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAU,EACyB,EAAE;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC,CAAC;AAuBF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAI3B,KAAa,EACb,OAAiD;IAEjD,MAAM,EAAE,OAAO,GAAG,wBAAwB,EAAE,eAAe,EAAE,GAAG,OAAO,IAAI;QACzE,OAAO,EAAE,wBAAwB;KAClC,CAAC;IAEF,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,CAAC,CAAC;IAC3E,MAAM,OAAO,GACX,eAAe;QACf,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,OAAO;YACP,KAAK;YACL,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1B,UAAU,CAAC,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;SAChD,CAAC;IACJ,CAAC;SAAM,IAAI,UAAU,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAC1C,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,OAAO;YACP,KAAK;YACL,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAC1B,UAAU,CAAC,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;SAChD,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC","sourcesContent":["import { type Chain } from \"viem\";\nimport { EntryPointNotFoundError } from \"../errors/entrypoint.js\";\nimport EntryPoint_v6 from \"./0.6.js\";\nimport EntryPoint_v7 from \"./0.7.js\";\nimport type {\n  DefaultEntryPointVersion,\n  EntryPointDefRegistry,\n  EntryPointRegistry,\n  EntryPointVersion,\n  GetEntryPointOptions,\n} from \"./types.js\";\n\nexport const defaultEntryPointVersion: DefaultEntryPointVersion = \"0.6.0\";\n\nexport const entryPointRegistry: EntryPointRegistry = {\n  \"0.6.0\": EntryPoint_v6,\n  \"0.7.0\": EntryPoint_v7,\n};\n\n/**\n * Checks if the given value is a valid key of the EntryPointRegistry.\n *\n * @example\n * ```ts\n * import { isEntryPointVersion } from \"@aa-sdk/core\";\n *\n * const valid = isEntryPointVersion(\"0.6.0\");\n * const invalid = isEntryPointVersion(\"0.8.0\");\n * ```\n *\n * @param {*} value The value to be checked\n * @returns {boolean} true if the value is a valid key of EntryPointRegistry, false otherwise\n */\nexport const isEntryPointVersion = (\n  value: any\n): value is keyof EntryPointRegistry => {\n  return Object.keys(entryPointRegistry).includes(value);\n};\n\nexport function getEntryPoint<\n  TEntryPointVersion extends EntryPointVersion = DefaultEntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[TEntryPointVersion];\n\nexport function getEntryPoint<\n  TEntryPointVersion extends DefaultEntryPointVersion = DefaultEntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options?: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[TEntryPointVersion];\n\nexport function getEntryPoint<TChain extends Chain = Chain>(\n  chain: TChain,\n  options?: GetEntryPointOptions<DefaultEntryPointVersion>\n): EntryPointDefRegistry<TChain>[DefaultEntryPointVersion];\n\n/**\n * Retrieves the entry point definition for the specified chain and version, falling back to the default version if not provided. Throws an error if the entry point address cannot be found.\n *\n * @example\n * ```ts\n * import { getEntryPoint } from \"@aa-sdk/core\";\n * import { sepolia } from \"viem/chains\";\n *\n * const entryPoint060 = getEntryPoint(sepolia);\n * const entryPoint070 = getEntryPoint(sepolia, { version: \"0.7.0\" });\n * ```\n *\n * @param {Chain} chain The chain for which the entry point is being retrieved\n * @param {GetEntryPointOptions<TEntryPointVersion>} options Options containing the version and address overrides for the entry point\n * @returns {EntryPointDefRegistry<TChain>[EntryPointVersion]} The entry point definition for the specified chain and version\n */\nexport function getEntryPoint<\n  TEntryPointVersion extends EntryPointVersion,\n  TChain extends Chain = Chain\n>(\n  chain: TChain,\n  options: GetEntryPointOptions<TEntryPointVersion>\n): EntryPointDefRegistry<TChain>[EntryPointVersion] {\n  const { version = defaultEntryPointVersion, addressOverride } = options ?? {\n    version: defaultEntryPointVersion,\n  };\n\n  const entryPoint = entryPointRegistry[version ?? defaultEntryPointVersion];\n  const address =\n    addressOverride ??\n    entryPoint.address[chain.id] ??\n    entryPoint.address.default;\n  if (!address) {\n    throw new EntryPointNotFoundError(chain, version);\n  }\n\n  if (entryPoint.version === \"0.6.0\") {\n    return {\n      version: entryPoint.version,\n      address,\n      chain,\n      abi: entryPoint.abi,\n      getUserOperationHash: (r) =>\n        entryPoint.getUserOperationHash(r, address, chain.id),\n      packUserOperation: entryPoint.packUserOperation,\n    };\n  } else if (entryPoint.version === \"0.7.0\") {\n    return {\n      version: entryPoint.version,\n      address,\n      chain,\n      abi: entryPoint.abi,\n      getUserOperationHash: (r) =>\n        entryPoint.getUserOperationHash(r, address, chain.id),\n      packUserOperation: entryPoint.packUserOperation,\n    };\n  }\n\n  throw new EntryPointNotFoundError(chain, version);\n}\n"]}

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

@@ -13,7 +13,24 @@ export type SupportedEntryPoint<TEntryPointVersion extends EntryPointVersion = E
     version: TEntryPointVersion;
     address: Record<TChain["id"] | "default", Address>;
     abi: GetContractParameters<Transport, TChain, Account, TAbi>["abi"];
+    /**
+     * Generates a hash for a UserOperation valid from entry point version 0.6 onwards
+     *
+     * @param request - the UserOperation to get the hash for
+     * @param entryPointAddress - the entry point address that will be used to execute the UserOperation
+     * @param chainId - the chain on which this UserOperation will be executed
+     * @returns the hash of the UserOperation
+     */
     getUserOperationHash: (request: UserOperationRequest<TEntryPointVersion>, entryPointAddress: Address, chainId: number) => Hash;
+    /**
+     * Pack the user operation data into bytes for hashing for entry point version 0.6 onwards
+     * Reference:
+     * v6: https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.6/test/UserOp.ts#L16-L61
+     * v7: https://github.com/eth-infinitism/account-abstraction/blob/releases/v0.7/test/UserOp.ts#L28-L67
+     *
+     * @param request - the UserOperation to get the hash for
+     * @returns the hash of the UserOperation
+     */
     packUserOperation: (userOperation: UserOperationRequest<TEntryPointVersion>) => Hex;
 };
 export interface EntryPointRegistry<TChain extends Chain = Chain> extends EntryPointRegistryBase<SupportedEntryPoint<EntryPointVersion, TChain, Abi>> {

package/dist/esm/errors/account.d.ts

@@ -1,47 +1,130 @@
 import type { Chain } from "viem";
 import type { EntryPointVersion } from "../entrypoint/types.js";
 import { BaseError } from "./base.js";
+/**
+ * This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.
+ */
 export declare class AccountNotFoundError extends BaseError {
     name: string;
-    constructor();
+    /**
+     * Constructor for initializing an error message indicating that an account could not be found to execute the specified action.
+     */ constructor();
 }
+/**
+ * Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.
+ * This error suggests providing an override via the `factoryAddress` parameter when creating an account.
+ */
 export declare class DefaultFactoryNotDefinedError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Custom error class for handling errors when getting a counterfactual address. This extends the `BaseError` class and provides a custom error message and name.
+ */
 export declare class GetCounterFactualAddressError extends BaseError {
     name: string;
-    constructor();
+    /**
+     * Constructor for initializing an error message indicating the failure of fetching the counter-factual address.
+     */ constructor();
 }
+/**
+ * An error class representing the condition where upgrades are not supported for a specific account type. This error extends the `BaseError` class and provides a custom error message based on the account type.
+ */
 export declare class UpgradesNotSupportedError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Error thrown when attempting to sign a transaction that is not supported by smart contracts.
+ */
 export declare class SignTransactionNotSupportedError extends BaseError {
     name: string;
-    constructor();
+    /**
+     * Throws an error indicating that signing a transaction is not supported by smart contracts.
+     *
+     
+     */ constructor();
 }
+/**
+ * Custom error class `FailedToGetStorageSlotError` which is used to signal a failure when attempting to retrieve a storage slot. This error includes the slot and slot descriptor in its message and inherits from `BaseError`.
+ */
 export declare class FailedToGetStorageSlotError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Represents an error indicating that batch execution is not supported for a specific account type.
+ */
 export declare class BatchExecutionNotSupportedError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Represents an error that occurs when an account requires an owner to execute but none is provided.
+ */
 export declare class AccountRequiresOwnerError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Represents an error that occurs when an attempt is made to call `UpgradeToAndCall` on an account type that does not support it. Includes the account type in the error message.
+ */
 export declare class UpgradeToAndCallNotSupportedError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Represents an error thrown when an account type does not match the expected type.
+ */
 export declare class IncorrectAccountType extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Error class indicating that a smart account operation requires a signer.
+ */
 export declare class SmartAccountWithSignerRequiredError extends BaseError {
     name: string;
-    constructor();
+    /**
+     * Initializes a new instance of the error class with a predefined error message indicating that a smart account requires a signer.
+     */ constructor();
 }

package/dist/esm/errors/account.js

@@ -1,6 +1,12 @@
 import { BaseError } from "./base.js";
+/**
+ * This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.
+ */
 export class AccountNotFoundError extends BaseError {
-    constructor() {
+    // TODO: extend this further using docs path as well
+    /**
+     * 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.");
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -10,7 +16,18 @@ export class AccountNotFoundError extends BaseError {
         });
     }
 }
+/**
+ * Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.
+ * This error suggests providing an override via the `factoryAddress` parameter when creating an account.
+ */
 export class DefaultFactoryNotDefinedError extends BaseError {
+    /**
+     * 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, chain, version) {
         super([
             `No default factory for ${accountType} found on chain ${chain.name} for entrypoint version ${version}`,
@@ -24,8 +41,13 @@ export class DefaultFactoryNotDefinedError extends BaseError {
         });
     }
 }
+/**
+ * Custom error class for handling errors when getting a counterfactual address. This extends the `BaseError` class and provides a custom error message and name.
+ */
 export class GetCounterFactualAddressError extends BaseError {
-    constructor() {
+    /**
+     * Constructor for initializing an error message indicating the failure of fetching the counter-factual address.
+     */ constructor() {
         super("getCounterFactualAddress failed");
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -35,7 +57,15 @@ export class GetCounterFactualAddressError extends BaseError {
         });
     }
 }
+/**
+ * An error class representing the condition where upgrades are not supported for a specific account type. This error extends the `BaseError` class and provides a custom error message based on the account type.
+ */
 export class UpgradesNotSupportedError extends BaseError {
+    /**
+     * 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) {
         super(`Upgrades are not supported by ${accountType}`);
         Object.defineProperty(this, "name", {
@@ -46,8 +76,15 @@ export class UpgradesNotSupportedError extends BaseError {
         });
     }
 }
+/**
+ * Error thrown when attempting to sign a transaction that is not supported by smart contracts.
+ */
 export class SignTransactionNotSupportedError extends BaseError {
-    constructor() {
+    /**
+     * Throws an error indicating that signing a transaction is not supported by smart contracts.
+     *
+     
+     */ constructor() {
         super(`SignTransaction is not supported by smart contracts`);
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -57,7 +94,16 @@ export class SignTransactionNotSupportedError extends BaseError {
         });
     }
 }
+/**
+ * Custom error class `FailedToGetStorageSlotError` which is used to signal a failure when attempting to retrieve a storage slot. This error includes the slot and slot descriptor in its message and inherits from `BaseError`.
+ */
 export class FailedToGetStorageSlotError extends BaseError {
+    /**
+     * 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, slotDescriptor) {
         super(`Failed to get storage slot ${slot} (${slotDescriptor})`);
         Object.defineProperty(this, "name", {
@@ -68,7 +114,15 @@ export class FailedToGetStorageSlotError extends BaseError {
         });
     }
 }
+/**
+ * Represents an error indicating that batch execution is not supported for a specific account type.
+ */
 export class BatchExecutionNotSupportedError extends BaseError {
+    /**
+     * 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) {
         super(`Batch execution is not supported by ${accountType}`);
         Object.defineProperty(this, "name", {
@@ -79,7 +133,15 @@ export class BatchExecutionNotSupportedError extends BaseError {
         });
     }
 }
+/**
+ * Represents an error that occurs when an account requires an owner to execute but none is provided.
+ */
 export class AccountRequiresOwnerError extends BaseError {
+    /**
+     * 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) {
         super(`Account of type ${accountType} requires an owner to execute`);
         Object.defineProperty(this, "name", {
@@ -90,7 +152,15 @@ export class AccountRequiresOwnerError extends BaseError {
         });
     }
 }
+/**
+ * Represents an error that occurs when an attempt is made to call `UpgradeToAndCall` on an account type that does not support it. Includes the account type in the error message.
+ */
 export class UpgradeToAndCallNotSupportedError extends BaseError {
+    /**
+     * 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) {
         super(`UpgradeToAndCall is not supported by ${accountType}`);
         Object.defineProperty(this, "name", {
@@ -101,7 +171,16 @@ export class UpgradeToAndCallNotSupportedError extends BaseError {
         });
     }
 }
+/**
+ * Represents an error thrown when an account type does not match the expected type.
+ */
 export class IncorrectAccountType extends BaseError {
+    /**
+     * 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, actual) {
         super(`Expected account type ${expected}, got ${actual}`);
         Object.defineProperty(this, "name", {
@@ -112,8 +191,13 @@ export class IncorrectAccountType extends BaseError {
         });
     }
 }
+/**
+ * Error class indicating that a smart account operation requires a signer.
+ */
 export class SmartAccountWithSignerRequiredError extends BaseError {
-    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");
         Object.defineProperty(this, "name", {
             enumerable: true,

package/dist/esm/errors/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../src/errors/account.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAKtC,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IAO7C;QACF,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAPzD;;;;mBAAO,sBAAsB;WAAC;IAQvC,CAAC;CACF;AAMD,MAAM,OAAO,6BAA8B,SAAQ,SAAS;IAU1D,YAAY,WAAmB,EAAE,KAAY,EAAE,OAA0B;QACvE,KAAK,CACH;YACE,0BAA0B,WAAW,mBAAmB,KAAK,CAAC,IAAI,2BAA2B,OAAO,EAAE;YACtG,gFAAgF;SACjF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAfK;;;;mBAAO,+BAA+B;WAAC;IAgBhD,CAAC;CACF;AAKD,MAAM,OAAO,6BAA8B,SAAQ,SAAS;IAKtD;QACF,KAAK,CAAC,iCAAiC,CAAC,CAAC;QALlC;;;;mBAAO,+BAA+B;WAAC;IAMhD,CAAC;CACF;AAKD,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IAQtD,YAAY,WAAmB;QAC7B,KAAK,CAAC,iCAAiC,WAAW,EAAE,CAAC,CAAC;QAR/C;;;;mBAAO,sBAAsB;WAAC;IASvC,CAAC;CACF;AAKD,MAAM,OAAO,gCAAiC,SAAQ,SAAS;IAOzD;QACF,KAAK,CAAC,qDAAqD,CAAC,CAAC;QAPtD;;;;mBAAO,6BAA6B;WAAC;IAQ9C,CAAC;CACF;AAKD,MAAM,OAAO,2BAA4B,SAAQ,SAAS;IASxD,YAAY,IAAY,EAAE,cAAsB;QAC9C,KAAK,CAAC,8BAA8B,IAAI,KAAK,cAAc,GAAG,CAAC,CAAC;QATzD;;;;mBAAO,6BAA6B;WAAC;IAU9C,CAAC;CACF;AAKD,MAAM,OAAO,+BAAgC,SAAQ,SAAS;IAQ5D,YAAY,WAAmB;QAC7B,KAAK,CAAC,uCAAuC,WAAW,EAAE,CAAC,CAAC;QARrD;;;;mBAAO,iCAAiC;WAAC;IASlD,CAAC;CACF;AAKD,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IAQtD,YAAY,WAAmB;QAC7B,KAAK,CAAC,mBAAmB,WAAW,+BAA+B,CAAC,CAAC;QAR9D;;;;mBAAO,2BAA2B;WAAC;IAS5C,CAAC;CACF;AAKD,MAAM,OAAO,iCAAkC,SAAQ,SAAS;IAQ9D,YAAY,WAAmB;QAC7B,KAAK,CAAC,wCAAwC,WAAW,EAAE,CAAC,CAAC;QARtD;;;;mBAAO,mCAAmC;WAAC;IASpD,CAAC;CACF;AAKD,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IASjD,YAAY,QAAgB,EAAE,MAAc;QAC1C,KAAK,CAAC,yBAAyB,QAAQ,SAAS,MAAM,EAAE,CAAC,CAAC;QATnD;;;;mBAAO,2BAA2B;WAAC;IAU5C,CAAC;CACF;AAKD,MAAM,OAAO,mCAAoC,SAAQ,SAAS;IAK5D;QACF,KAAK,CAAC,iCAAiC,CAAC,CAAC;QALlC;;;;mBAAO,qCAAqC;WAAC;IAMtD,CAAC;CACF","sourcesContent":["import type { Chain } from \"viem\";\nimport type { EntryPointVersion } from \"../entrypoint/types.js\";\nimport { BaseError } from \"./base.js\";\n\n/**\n * This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.\n */\nexport class AccountNotFoundError extends BaseError {\n  override name = \"AccountNotFoundError\";\n\n  // TODO: extend this further using docs path as well\n\n  /**\n   * Constructor for initializing an error message indicating that an account could not be found to execute the specified action.\n   */ constructor() {\n    super(\"Could not find an Account to execute with this Action.\");\n  }\n}\n\n/**\n * Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.\n * This error suggests providing an override via the `factoryAddress` parameter when creating an account.\n */\nexport class DefaultFactoryNotDefinedError extends BaseError {\n  override name = \"DefaultFactoryNotDefinedError\";\n\n  /**\n   * Constructs an error message indicating that no default factory was found for the given account type, chain, and entry point version.\n   *\n   * @param {string} accountType the type of account\n   * @param {Chain} chain the blockchain chain\n   * @param {EntryPointVersion} version the entry point version\n   */\n  constructor(accountType: string, chain: Chain, version: EntryPointVersion) {\n    super(\n      [\n        `No default factory for ${accountType} found on chain ${chain.name} for entrypoint version ${version}`,\n        \"Supply an override via the `factoryAddress` parameter when creating an account\",\n      ].join(\"\\n\")\n    );\n  }\n}\n\n/**\n * Custom error class for handling errors when getting a counterfactual address. This extends the `BaseError` class and provides a custom error message and name.\n */\nexport class GetCounterFactualAddressError extends BaseError {\n  override name = \"GetCounterFactualAddressError\";\n\n  /**\n   * Constructor for initializing an error message indicating the failure of fetching the counter-factual address.\n   */ constructor() {\n    super(\"getCounterFactualAddress failed\");\n  }\n}\n\n/**\n * An error class representing the condition where upgrades are not supported for a specific account type. This error extends the `BaseError` class and provides a custom error message based on the account type.\n */\nexport class UpgradesNotSupportedError extends BaseError {\n  override name = \"UpgradesNotSupported\";\n\n  /**\n   * Error constructor for indicating that upgrades are not supported by the given account type.\n   *\n   * @param {string} accountType The type of account that does not support upgrades\n   */\n  constructor(accountType: string) {\n    super(`Upgrades are not supported by ${accountType}`);\n  }\n}\n\n/**\n * Error thrown when attempting to sign a transaction that is not supported by smart contracts.\n */\nexport class SignTransactionNotSupportedError extends BaseError {\n  override name = \"SignTransactionNotSupported\";\n\n  /**\n   * Throws an error indicating that signing a transaction is not supported by smart contracts.\n   *\n   \n   */ constructor() {\n    super(`SignTransaction is not supported by smart contracts`);\n  }\n}\n\n/**\n * Custom error class `FailedToGetStorageSlotError` which is used to signal a failure when attempting to retrieve a storage slot. This error includes the slot and slot descriptor in its message and inherits from `BaseError`.\n */\nexport class FailedToGetStorageSlotError extends BaseError {\n  override name = \"FailedToGetStorageSlotError\";\n\n  /**\n   * Custom error message constructor for failing to get a specific storage slot.\n   *\n   * @param {string} slot The storage slot that failed to be accessed or retrieved\n   * @param {string} slotDescriptor A description of the storage slot, for additional context in the error message\n   */\n  constructor(slot: string, slotDescriptor: string) {\n    super(`Failed to get storage slot ${slot} (${slotDescriptor})`);\n  }\n}\n\n/**\n * Represents an error indicating that batch execution is not supported for a specific account type.\n */\nexport class BatchExecutionNotSupportedError extends BaseError {\n  override name = \"BatchExecutionNotSupportedError\";\n\n  /**\n   * Constructs an error message indicating that batch execution is not supported by the specified account type.\n   *\n   * @param {string} accountType the type of account that does not support batch execution\n   */\n  constructor(accountType: string) {\n    super(`Batch execution is not supported by ${accountType}`);\n  }\n}\n\n/**\n * Represents an error that occurs when an account requires an owner to execute but none is provided.\n */\nexport class AccountRequiresOwnerError extends BaseError {\n  override name = \"AccountRequiresOwnerError\";\n\n  /**\n   * Constructs an error indicating that an account of the specified type requires an owner to execute.\n   *\n   * @param {string} accountType The type of account that requires an owner\n   */\n  constructor(accountType: string) {\n    super(`Account of type ${accountType} requires an owner to execute`);\n  }\n}\n\n/**\n * Represents an error that occurs when an attempt is made to call `UpgradeToAndCall` on an account type that does not support it. Includes the account type in the error message.\n */\nexport class UpgradeToAndCallNotSupportedError extends BaseError {\n  override name = \"UpgradeToAndCallNotSupportedError\";\n\n  /**\n   * Constructs an error message indicating that `UpgradeToAndCall` is not supported by the specified account type.\n   *\n   * @param {string} accountType The type of account that does not support `UpgradeToAndCall`\n   */\n  constructor(accountType: string) {\n    super(`UpgradeToAndCall is not supported by ${accountType}`);\n  }\n}\n\n/**\n * Represents an error thrown when an account type does not match the expected type.\n */\nexport class IncorrectAccountType extends BaseError {\n  override name = \"IncorrectAccountTypeError\";\n\n  /**\n   * Constructs an error object indicating that the expected account type does not match the actual account type.\n   *\n   * @param {string} expected the expected account type\n   * @param {string} actual the actual account type that was received\n   */\n  constructor(expected: string, actual: string) {\n    super(`Expected account type ${expected}, got ${actual}`);\n  }\n}\n\n/**\n * Error class indicating that a smart account operation requires a signer.\n */\nexport class SmartAccountWithSignerRequiredError extends BaseError {\n  override name = \"SmartAccountWithSignerRequiredError\";\n\n  /**\n   * Initializes a new instance of the error class with a predefined error message indicating that a smart account requires a signer.\n   */ constructor() {\n    super(\"Smart account requires a signer\");\n  }\n}\n"]}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../src/errors/account.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IAGjD,oDAAoD;IAEpD;;OAEG,CAAC;QACF,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAPzD;;;;mBAAO,sBAAsB;WAAC;IAQvC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,SAAS;IAG1D;;;;;;OAMG;IACH,YAAY,WAAmB,EAAE,KAAY,EAAE,OAA0B;QACvE,KAAK,CACH;YACE,0BAA0B,WAAW,mBAAmB,KAAK,CAAC,IAAI,2BAA2B,OAAO,EAAE;YACtG,gFAAgF;SACjF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAfK;;;;mBAAO,+BAA+B;WAAC;IAgBhD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,SAAS;IAG1D;;OAEG,CAAC;QACF,KAAK,CAAC,iCAAiC,CAAC,CAAC;QALlC;;;;mBAAO,+BAA+B;WAAC;IAMhD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IAGtD;;;;OAIG;IACH,YAAY,WAAmB;QAC7B,KAAK,CAAC,iCAAiC,WAAW,EAAE,CAAC,CAAC;QAR/C;;;;mBAAO,sBAAsB;WAAC;IASvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,SAAS;IAG7D;;;;OAIG,CAAC;QACF,KAAK,CAAC,qDAAqD,CAAC,CAAC;QAPtD;;;;mBAAO,6BAA6B;WAAC;IAQ9C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,SAAS;IAGxD;;;;;OAKG;IACH,YAAY,IAAY,EAAE,cAAsB;QAC9C,KAAK,CAAC,8BAA8B,IAAI,KAAK,cAAc,GAAG,CAAC,CAAC;QATzD;;;;mBAAO,6BAA6B;WAAC;IAU9C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,SAAS;IAG5D;;;;OAIG;IACH,YAAY,WAAmB;QAC7B,KAAK,CAAC,uCAAuC,WAAW,EAAE,CAAC,CAAC;QARrD;;;;mBAAO,iCAAiC;WAAC;IASlD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IAGtD;;;;OAIG;IACH,YAAY,WAAmB;QAC7B,KAAK,CAAC,mBAAmB,WAAW,+BAA+B,CAAC,CAAC;QAR9D;;;;mBAAO,2BAA2B;WAAC;IAS5C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,iCAAkC,SAAQ,SAAS;IAG9D;;;;OAIG;IACH,YAAY,WAAmB;QAC7B,KAAK,CAAC,wCAAwC,WAAW,EAAE,CAAC,CAAC;QARtD;;;;mBAAO,mCAAmC;WAAC;IASpD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IAGjD;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,MAAc;QAC1C,KAAK,CAAC,yBAAyB,QAAQ,SAAS,MAAM,EAAE,CAAC,CAAC;QATnD;;;;mBAAO,2BAA2B;WAAC;IAU5C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,SAAS;IAGhE;;OAEG,CAAC;QACF,KAAK,CAAC,iCAAiC,CAAC,CAAC;QALlC;;;;mBAAO,qCAAqC;WAAC;IAMtD,CAAC;CACF","sourcesContent":["import type { Chain } from \"viem\";\nimport type { EntryPointVersion } from \"../entrypoint/types.js\";\nimport { BaseError } from \"./base.js\";\n\n/**\n * This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.\n */\nexport class AccountNotFoundError extends BaseError {\n  override name = \"AccountNotFoundError\";\n\n  // TODO: extend this further using docs path as well\n\n  /**\n   * Constructor for initializing an error message indicating that an account could not be found to execute the specified action.\n   */ constructor() {\n    super(\"Could not find an Account to execute with this Action.\");\n  }\n}\n\n/**\n * Represents an error that is thrown when no default factory is defined for a specific account type on a given chain and entry point version.\n * This error suggests providing an override via the `factoryAddress` parameter when creating an account.\n */\nexport class DefaultFactoryNotDefinedError extends BaseError {\n  override name = \"DefaultFactoryNotDefinedError\";\n\n  /**\n   * Constructs an error message indicating that no default factory was found for the given account type, chain, and entry point version.\n   *\n   * @param {string} accountType the type of account\n   * @param {Chain} chain the blockchain chain\n   * @param {EntryPointVersion} version the entry point version\n   */\n  constructor(accountType: string, chain: Chain, version: EntryPointVersion) {\n    super(\n      [\n        `No default factory for ${accountType} found on chain ${chain.name} for entrypoint version ${version}`,\n        \"Supply an override via the `factoryAddress` parameter when creating an account\",\n      ].join(\"\\n\")\n    );\n  }\n}\n\n/**\n * Custom error class for handling errors when getting a counterfactual address. This extends the `BaseError` class and provides a custom error message and name.\n */\nexport class GetCounterFactualAddressError extends BaseError {\n  override name = \"GetCounterFactualAddressError\";\n\n  /**\n   * Constructor for initializing an error message indicating the failure of fetching the counter-factual address.\n   */ constructor() {\n    super(\"getCounterFactualAddress failed\");\n  }\n}\n\n/**\n * An error class representing the condition where upgrades are not supported for a specific account type. This error extends the `BaseError` class and provides a custom error message based on the account type.\n */\nexport class UpgradesNotSupportedError extends BaseError {\n  override name = \"UpgradesNotSupported\";\n\n  /**\n   * Error constructor for indicating that upgrades are not supported by the given account type.\n   *\n   * @param {string} accountType The type of account that does not support upgrades\n   */\n  constructor(accountType: string) {\n    super(`Upgrades are not supported by ${accountType}`);\n  }\n}\n\n/**\n * Error thrown when attempting to sign a transaction that is not supported by smart contracts.\n */\nexport class SignTransactionNotSupportedError extends BaseError {\n  override name = \"SignTransactionNotSupported\";\n\n  /**\n   * Throws an error indicating that signing a transaction is not supported by smart contracts.\n   *\n   \n   */ constructor() {\n    super(`SignTransaction is not supported by smart contracts`);\n  }\n}\n\n/**\n * Custom error class `FailedToGetStorageSlotError` which is used to signal a failure when attempting to retrieve a storage slot. This error includes the slot and slot descriptor in its message and inherits from `BaseError`.\n */\nexport class FailedToGetStorageSlotError extends BaseError {\n  override name = \"FailedToGetStorageSlotError\";\n\n  /**\n   * Custom error message constructor for failing to get a specific storage slot.\n   *\n   * @param {string} slot The storage slot that failed to be accessed or retrieved\n   * @param {string} slotDescriptor A description of the storage slot, for additional context in the error message\n   */\n  constructor(slot: string, slotDescriptor: string) {\n    super(`Failed to get storage slot ${slot} (${slotDescriptor})`);\n  }\n}\n\n/**\n * Represents an error indicating that batch execution is not supported for a specific account type.\n */\nexport class BatchExecutionNotSupportedError extends BaseError {\n  override name = \"BatchExecutionNotSupportedError\";\n\n  /**\n   * Constructs an error message indicating that batch execution is not supported by the specified account type.\n   *\n   * @param {string} accountType the type of account that does not support batch execution\n   */\n  constructor(accountType: string) {\n    super(`Batch execution is not supported by ${accountType}`);\n  }\n}\n\n/**\n * Represents an error that occurs when an account requires an owner to execute but none is provided.\n */\nexport class AccountRequiresOwnerError extends BaseError {\n  override name = \"AccountRequiresOwnerError\";\n\n  /**\n   * Constructs an error indicating that an account of the specified type requires an owner to execute.\n   *\n   * @param {string} accountType The type of account that requires an owner\n   */\n  constructor(accountType: string) {\n    super(`Account of type ${accountType} requires an owner to execute`);\n  }\n}\n\n/**\n * Represents an error that occurs when an attempt is made to call `UpgradeToAndCall` on an account type that does not support it. Includes the account type in the error message.\n */\nexport class UpgradeToAndCallNotSupportedError extends BaseError {\n  override name = \"UpgradeToAndCallNotSupportedError\";\n\n  /**\n   * Constructs an error message indicating that `UpgradeToAndCall` is not supported by the specified account type.\n   *\n   * @param {string} accountType The type of account that does not support `UpgradeToAndCall`\n   */\n  constructor(accountType: string) {\n    super(`UpgradeToAndCall is not supported by ${accountType}`);\n  }\n}\n\n/**\n * Represents an error thrown when an account type does not match the expected type.\n */\nexport class IncorrectAccountType extends BaseError {\n  override name = \"IncorrectAccountTypeError\";\n\n  /**\n   * Constructs an error object indicating that the expected account type does not match the actual account type.\n   *\n   * @param {string} expected the expected account type\n   * @param {string} actual the actual account type that was received\n   */\n  constructor(expected: string, actual: string) {\n    super(`Expected account type ${expected}, got ${actual}`);\n  }\n}\n\n/**\n * Error class indicating that a smart account operation requires a signer.\n */\nexport class SmartAccountWithSignerRequiredError extends BaseError {\n  override name = \"SmartAccountWithSignerRequiredError\";\n\n  /**\n   * Initializes a new instance of the error class with a predefined error message indicating that a smart account requires a signer.\n   */ constructor() {\n    super(\"Smart account requires a signer\");\n  }\n}\n"]}

package/dist/esm/errors/base.d.ts

@@ -10,6 +10,11 @@ type BaseErrorParameters = {
     cause: BaseError | Error;
     details?: never;
 });
+/**
+ * A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.
+ * This is based on on viem's BaseError type (obviously from the import and extend)
+ * we want the errors here to point to our docs if we supply a docsPath though
+ */
 export declare class BaseError extends ViemBaseError {
     name: string;
     version: string;

package/dist/esm/errors/base.js

@@ -1,5 +1,10 @@
 import { BaseError as ViemBaseError } from "viem";
 import { VERSION } from "../version.js";
+/**
+ * A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.
+ * This is based on on viem's BaseError type (obviously from the import and extend)
+ * we want the errors here to point to our docs if we supply a docsPath though
+ */
 export class BaseError extends ViemBaseError {
     constructor(shortMessage, args = {}) {
         super(shortMessage, args);

package/dist/esm/errors/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/errors/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAsBxC,MAAM,OAAO,SAAU,SAAQ,aAAa;IAI1C,YAAY,YAAoB,EAAE,OAA4B,EAAE;QAC9D,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAJnB;;;;mBAAO,YAAY;WAAC;QACpB;;;;mBAAU,OAAO;WAAC;QAKzB,MAAM,QAAQ,GACZ,IAAI,CAAC,KAAK,YAAY,SAAS;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACtC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAEpB,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,IAAI,oBAAoB;YACpC,EAAE;YACF,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,GAAG,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE,uCAAuC,QAAQ,GAC7C,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EACxC,EAAE;iBACH;gBACH,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,YAAY,IAAI,CAAC,OAAO,EAAE;SAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;CACF","sourcesContent":["import { BaseError as ViemBaseError } from \"viem\";\nimport { VERSION } from \"../version.js\";\n\ntype BaseErrorParameters = {\n  docsPath?: string;\n  docsSlug?: string;\n  metaMessages?: string[];\n} & (\n  | {\n      cause?: never;\n      details?: string;\n    }\n  | {\n      cause: BaseError | Error;\n      details?: never;\n    }\n);\n\n/**\n * A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.\n * This is based on on viem's BaseError type (obviously from the import and extend)\n * we want the errors here to point to our docs if we supply a docsPath though\n */\nexport class BaseError extends ViemBaseError {\n  override name = \"AASDKError\";\n  override version = VERSION;\n\n  constructor(shortMessage: string, args: BaseErrorParameters = {}) {\n    super(shortMessage, args);\n\n    const docsPath =\n      args.cause instanceof BaseError\n        ? args.cause.docsPath || args.docsPath\n        : args.docsPath;\n\n    this.message = [\n      shortMessage || \"An error occurred.\",\n      \"\",\n      ...(args.metaMessages ? [...args.metaMessages, \"\"] : []),\n      ...(docsPath\n        ? [\n            `Docs: https://accountkit.alchemy.com${docsPath}${\n              args.docsSlug ? `#${args.docsSlug}` : \"\"\n            }`,\n          ]\n        : []),\n      ...(this.details ? [`Details: ${this.details}`] : []),\n      `Version: ${this.version}`,\n    ].join(\"\\n\");\n  }\n}\n"]}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/errors/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAiBxC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,aAAa;IAI1C,YAAY,YAAoB,EAAE,OAA4B,EAAE;QAC9D,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAJnB;;;;mBAAO,YAAY;WAAC;QACpB;;;;mBAAU,OAAO;WAAC;QAKzB,MAAM,QAAQ,GACZ,IAAI,CAAC,KAAK,YAAY,SAAS;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACtC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAEpB,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,IAAI,oBAAoB;YACpC,EAAE;YACF,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,GAAG,CAAC,QAAQ;gBACV,CAAC,CAAC;oBACE,uCAAuC,QAAQ,GAC7C,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EACxC,EAAE;iBACH;gBACH,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,YAAY,IAAI,CAAC,OAAO,EAAE;SAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;CACF","sourcesContent":["import { BaseError as ViemBaseError } from \"viem\";\nimport { VERSION } from \"../version.js\";\n\ntype BaseErrorParameters = {\n  docsPath?: string;\n  docsSlug?: string;\n  metaMessages?: string[];\n} & (\n  | {\n      cause?: never;\n      details?: string;\n    }\n  | {\n      cause: BaseError | Error;\n      details?: never;\n    }\n);\n\n/**\n * A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.\n * This is based on on viem's BaseError type (obviously from the import and extend)\n * we want the errors here to point to our docs if we supply a docsPath though\n */\nexport class BaseError extends ViemBaseError {\n  override name = \"AASDKError\";\n  override version = VERSION;\n\n  constructor(shortMessage: string, args: BaseErrorParameters = {}) {\n    super(shortMessage, args);\n\n    const docsPath =\n      args.cause instanceof BaseError\n        ? args.cause.docsPath || args.docsPath\n        : args.docsPath;\n\n    this.message = [\n      shortMessage || \"An error occurred.\",\n      \"\",\n      ...(args.metaMessages ? [...args.metaMessages, \"\"] : []),\n      ...(docsPath\n        ? [\n            `Docs: https://accountkit.alchemy.com${docsPath}${\n              args.docsSlug ? `#${args.docsSlug}` : \"\"\n            }`,\n          ]\n        : []),\n      ...(this.details ? [`Details: ${this.details}`] : []),\n      `Version: ${this.version}`,\n    ].join(\"\\n\");\n  }\n}\n"]}

package/dist/esm/errors/client.d.ts

@@ -1,14 +1,38 @@
 import type { Client } from "viem";
 import { BaseError } from "./base.js";
+/**
+ * Represents an error thrown when a client is not compatible with the expected client type for a specific method. The error message provides guidance on how to create a compatible client.
+ */
 export declare class IncompatibleClientError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Represents an error that occurs when an invalid RPC URL is provided. This class extends the `BaseError` class and includes the invalid URL in the error message.
+ */
 export declare class InvalidRpcUrlError extends BaseError {
     name: string;
+    /**
+     * 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);
 }
+/**
+ * Error class representing a "Chain Not Found" error, typically thrown when no chain is supplied to the client.
+ */
 export declare class ChainNotFoundError extends BaseError {
     name: string;
+    /**
+     * Initializes a new instance of the error message with a default message indicating that no chain was supplied to the client.
+     */
     constructor();
 }