@metamask/multichain-account-service 7.0.0 → 8.0.0

package/dist/utils.d.cts

@@ -1,16 +1,43 @@
+/**
+ * Range-based multichain account creations type.
+ */
+export type GroupIndexRange = {
+    from?: number;
+    to: number;
+};
+/**
+ * Asserts that a range is valid.
+ *
+ * @param range - The range to assert.
+ * @param range.from - The starting index of the range (inclusive).
+ * @param range.to - The ending index of the range (inclusive).
+ */
+export declare function assertGroupIndexRangeIsValid({ from, to, }: GroupIndexRange): void;
+/**
+ *  Asserts that a group index is valid given the next available group index.
+ *
+ * @param groupIndex - The group index to assert.
+ * @param nextGroupIndex - The next available group index.
+ */
+export declare function assertGroupIndexIsValid(groupIndex: number, nextGroupIndex: number): void;
 /**
  * Creates a Sentry error from an error message, an inner error and a context.
  *
  * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.
  * As such, the context depth shouldn't be too deep.
  *
- * @param msg - The error message to create a Sentry error from.
+ * @param message - The error message to create a Sentry error from.
  * @param innerError - The inner error to create a Sentry error from.
  * @param context - The context to add to the Sentry error.
  * @returns A Sentry error.
  */
-export declare const createSentryError: (msg: string, innerError: Error, context: Record<string, unknown>) => Error & {
-    cause: Error;
-    context: Record<string, unknown>;
-};
+export declare const createSentryError: (message: string, innerError: Error, context?: Record<string, unknown>) => Error;
+/**
+ * Converts an unknown error value to a string message.
+ *
+ * @param error - The error to convert.
+ * @returns The error message if the error is an `Error` instance, otherwise
+ * the string representation of the value.
+ */
+export declare function toErrorMessage(error: unknown): string;
 //# sourceMappingURL=utils.d.cts.map

package/dist/utils.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,QACvB,MAAM,cACC,KAAK,WACR,OAAO,MAAM,EAAE,OAAO,CAAC;WAGvB,KAAK;;CAMf,CAAC"}
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAC3C,IAAQ,EACR,EAAE,GACH,EAAE,eAAe,GAAG,IAAI,CAYxB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,GACrB,IAAI,CAMN;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,YACnB,MAAM,cACH,KAAK,YACP,OAAO,MAAM,EAAE,OAAO,CAAC,KAChC,KAUF,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAErD"}

package/dist/utils.d.mts

@@ -1,16 +1,43 @@
+/**
+ * Range-based multichain account creations type.
+ */
+export type GroupIndexRange = {
+    from?: number;
+    to: number;
+};
+/**
+ * Asserts that a range is valid.
+ *
+ * @param range - The range to assert.
+ * @param range.from - The starting index of the range (inclusive).
+ * @param range.to - The ending index of the range (inclusive).
+ */
+export declare function assertGroupIndexRangeIsValid({ from, to, }: GroupIndexRange): void;
+/**
+ *  Asserts that a group index is valid given the next available group index.
+ *
+ * @param groupIndex - The group index to assert.
+ * @param nextGroupIndex - The next available group index.
+ */
+export declare function assertGroupIndexIsValid(groupIndex: number, nextGroupIndex: number): void;
 /**
  * Creates a Sentry error from an error message, an inner error and a context.
  *
  * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.
  * As such, the context depth shouldn't be too deep.
  *
- * @param msg - The error message to create a Sentry error from.
+ * @param message - The error message to create a Sentry error from.
  * @param innerError - The inner error to create a Sentry error from.
  * @param context - The context to add to the Sentry error.
  * @returns A Sentry error.
  */
-export declare const createSentryError: (msg: string, innerError: Error, context: Record<string, unknown>) => Error & {
-    cause: Error;
-    context: Record<string, unknown>;
-};
+export declare const createSentryError: (message: string, innerError: Error, context?: Record<string, unknown>) => Error;
+/**
+ * Converts an unknown error value to a string message.
+ *
+ * @param error - The error to convert.
+ * @returns The error message if the error is an `Error` instance, otherwise
+ * the string representation of the value.
+ */
+export declare function toErrorMessage(error: unknown): string;
 //# sourceMappingURL=utils.d.mts.map

package/dist/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,QACvB,MAAM,cACC,KAAK,WACR,OAAO,MAAM,EAAE,OAAO,CAAC;WAGvB,KAAK;;CAMf,CAAC"}
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAC3C,IAAQ,EACR,EAAE,GACH,EAAE,eAAe,GAAG,IAAI,CAYxB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,GACrB,IAAI,CAMN;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,YACnB,MAAM,cACH,KAAK,YACP,OAAO,MAAM,EAAE,OAAO,CAAC,KAChC,KAUF,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAErD"}

package/dist/utils.mjs

@@ -1,18 +1,59 @@
+/**
+ * Asserts that a range is valid.
+ *
+ * @param range - The range to assert.
+ * @param range.from - The starting index of the range (inclusive).
+ * @param range.to - The ending index of the range (inclusive).
+ */
+export function assertGroupIndexRangeIsValid({ from = 0, to, }) {
+    if (from < 0) {
+        throw new Error(`Bad range, from (${from}) must be >= 0`);
+    }
+    if (to < 0) {
+        throw new Error(`Bad range, to (${to}) must be >= 0`);
+    }
+    if (to < from) {
+        throw new Error(`Bad range, to (${to}) must be >= from (${from})`);
+    }
+}
+/**
+ *  Asserts that a group index is valid given the next available group index.
+ *
+ * @param groupIndex - The group index to assert.
+ * @param nextGroupIndex - The next available group index.
+ */
+export function assertGroupIndexIsValid(groupIndex, nextGroupIndex) {
+    if (groupIndex > nextGroupIndex) {
+        throw new Error(`Bad group index, groupIndex (${groupIndex}) cannot be higher than the next available one (<= ${nextGroupIndex})`);
+    }
+}
 /**
  * Creates a Sentry error from an error message, an inner error and a context.
  *
  * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.
  * As such, the context depth shouldn't be too deep.
  *
- * @param msg - The error message to create a Sentry error from.
+ * @param message - The error message to create a Sentry error from.
  * @param innerError - The inner error to create a Sentry error from.
  * @param context - The context to add to the Sentry error.
  * @returns A Sentry error.
  */
-export const createSentryError = (msg, innerError, context) => {
-    const error = new Error(msg);
+export const createSentryError = (message, innerError, context) => {
+    const error = new Error(message);
     error.cause = innerError;
-    error.context = context;
+    if (context) {
+        error.context = context;
+    }
     return error;
 };
+/**
+ * Converts an unknown error value to a string message.
+ *
+ * @param error - The error to convert.
+ * @returns The error message if the error is an `Error` instance, otherwise
+ * the string representation of the value.
+ */
+export function toErrorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
 //# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAW,EACX,UAAiB,EACjB,OAAgC,EAChC,EAAE;IACF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,GAAG,CAG1B,CAAC;IACF,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC;IACzB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/**\n * Creates a Sentry error from an error message, an inner error and a context.\n *\n * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.\n * As such, the context depth shouldn't be too deep.\n *\n * @param msg - The error message to create a Sentry error from.\n * @param innerError - The inner error to create a Sentry error from.\n * @param context - The context to add to the Sentry error.\n * @returns A Sentry error.\n */\nexport const createSentryError = (\n  msg: string,\n  innerError: Error,\n  context: Record<string, unknown>,\n) => {\n  const error = new Error(msg) as Error & {\n    cause: Error;\n    context: typeof context;\n  };\n  error.cause = innerError;\n  error.context = context;\n  return error;\n};\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,MAAM,UAAU,4BAA4B,CAAC,EAC3C,IAAI,GAAG,CAAC,EACR,EAAE,GACc;IAChB,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,sBAAsB,IAAI,GAAG,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAkB,EAClB,cAAsB;IAEtB,IAAI,UAAU,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,gCAAgC,UAAU,sDAAsD,cAAc,GAAG,CAClH,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,OAAe,EACf,UAAiB,EACjB,OAAiC,EAC1B,EAAE;IACT,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAG9B,CAAC;IACF,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC;IACzB,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC","sourcesContent":["/**\n * Range-based multichain account creations type.\n */\nexport type GroupIndexRange = {\n  from?: number;\n  to: number;\n};\n\n/**\n * Asserts that a range is valid.\n *\n * @param range - The range to assert.\n * @param range.from - The starting index of the range (inclusive).\n * @param range.to - The ending index of the range (inclusive).\n */\nexport function assertGroupIndexRangeIsValid({\n  from = 0,\n  to,\n}: GroupIndexRange): void {\n  if (from < 0) {\n    throw new Error(`Bad range, from (${from}) must be >= 0`);\n  }\n\n  if (to < 0) {\n    throw new Error(`Bad range, to (${to}) must be >= 0`);\n  }\n\n  if (to < from) {\n    throw new Error(`Bad range, to (${to}) must be >= from (${from})`);\n  }\n}\n\n/**\n *  Asserts that a group index is valid given the next available group index.\n *\n * @param groupIndex - The group index to assert.\n * @param nextGroupIndex - The next available group index.\n */\nexport function assertGroupIndexIsValid(\n  groupIndex: number,\n  nextGroupIndex: number,\n): void {\n  if (groupIndex > nextGroupIndex) {\n    throw new Error(\n      `Bad group index, groupIndex (${groupIndex}) cannot be higher than the next available one (<= ${nextGroupIndex})`,\n    );\n  }\n}\n\n/**\n * Creates a Sentry error from an error message, an inner error and a context.\n *\n * NOTE: Sentry defaults to a depth of 3 when extracting non-native attributes.\n * As such, the context depth shouldn't be too deep.\n *\n * @param message - The error message to create a Sentry error from.\n * @param innerError - The inner error to create a Sentry error from.\n * @param context - The context to add to the Sentry error.\n * @returns A Sentry error.\n */\nexport const createSentryError = (\n  message: string,\n  innerError: Error,\n  context?: Record<string, unknown>,\n): Error => {\n  const error = new Error(message) as Error & {\n    cause: Error;\n    context: typeof context;\n  };\n  error.cause = innerError;\n  if (context) {\n    error.context = context;\n  }\n  return error;\n};\n\n/**\n * Converts an unknown error value to a string message.\n *\n * @param error - The error to convert.\n * @returns The error message if the error is an `Error` instance, otherwise\n * the string representation of the value.\n */\nexport function toErrorMessage(error: unknown): string {\n  return error instanceof Error ? error.message : String(error);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/multichain-account-service",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "description": "Service to manage multichain accounts",
   "keywords": [
     "MetaMask",
@@ -40,7 +40,7 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-account-service",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-account-service",
-    "publish:preview": "yarn npm publish --tag preview",
+    "generate-method-action-types": "tsx ../../scripts/generate-method-action-types.ts",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
     "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
@@ -49,16 +49,16 @@
   },
   "dependencies": {
     "@ethereumjs/util": "^9.1.0",
-    "@metamask/accounts-controller": "^36.0.0",
-    "@metamask/base-controller": "^9.0.0",
+    "@metamask/accounts-controller": "^37.1.0",
+    "@metamask/base-controller": "^9.0.1",
     "@metamask/eth-snap-keyring": "^19.0.0",
     "@metamask/key-tree": "^10.1.1",
-    "@metamask/keyring-api": "^21.5.0",
-    "@metamask/keyring-controller": "^25.1.0",
+    "@metamask/keyring-api": "^21.6.0",
+    "@metamask/keyring-controller": "^25.1.1",
     "@metamask/keyring-internal-api": "^10.0.0",
     "@metamask/keyring-snap-client": "^8.2.0",
     "@metamask/keyring-utils": "^3.1.0",
-    "@metamask/messenger": "^0.3.0",
+    "@metamask/messenger": "^1.0.0",
     "@metamask/snaps-controllers": "^17.2.0",
     "@metamask/snaps-sdk": "^10.3.0",
     "@metamask/snaps-utils": "^11.7.0",
@@ -70,6 +70,7 @@
   "devDependencies": {
     "@metamask/account-api": "^1.0.0",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/controller-utils": "^11.19.0",
     "@metamask/eth-hd-keyring": "^13.0.0",
     "@metamask/providers": "^22.1.0",
     "@ts-bridge/cli": "^0.6.4",
@@ -78,6 +79,7 @@
     "deepmerge": "^4.2.2",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
+    "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~5.3.3",

package/dist/constants/traces.cjs

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TraceName = void 0;
-var TraceName;
-(function (TraceName) {
-    TraceName["SnapDiscoverAccounts"] = "Snap Discover Accounts";
-    TraceName["EvmDiscoverAccounts"] = "EVM Discover Accounts";
-})(TraceName || (exports.TraceName = TraceName = {}));
-//# sourceMappingURL=traces.cjs.map

package/dist/constants/traces.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.cjs","sourceRoot":"","sources":["../../src/constants/traces.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,4DAAiD,CAAA;IACjD,0DAA+C,CAAA;AACjD,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB","sourcesContent":["export enum TraceName {\n  'SnapDiscoverAccounts' = 'Snap Discover Accounts',\n  'EvmDiscoverAccounts' = 'EVM Discover Accounts',\n}\n"]}

package/dist/constants/traces.d.cts

@@ -1,5 +0,0 @@
-export declare enum TraceName {
-    'SnapDiscoverAccounts' = "Snap Discover Accounts",
-    'EvmDiscoverAccounts' = "EVM Discover Accounts"
-}
-//# sourceMappingURL=traces.d.cts.map

package/dist/constants/traces.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.d.cts","sourceRoot":"","sources":["../../src/constants/traces.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,sBAAsB,2BAA2B;IACjD,qBAAqB,0BAA0B;CAChD"}

package/dist/constants/traces.d.mts

@@ -1,5 +0,0 @@
-export declare enum TraceName {
-    'SnapDiscoverAccounts' = "Snap Discover Accounts",
-    'EvmDiscoverAccounts' = "EVM Discover Accounts"
-}
-//# sourceMappingURL=traces.d.mts.map

package/dist/constants/traces.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.d.mts","sourceRoot":"","sources":["../../src/constants/traces.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,sBAAsB,2BAA2B;IACjD,qBAAqB,0BAA0B;CAChD"}

package/dist/constants/traces.mjs

@@ -1,6 +0,0 @@
-export var TraceName;
-(function (TraceName) {
-    TraceName["SnapDiscoverAccounts"] = "Snap Discover Accounts";
-    TraceName["EvmDiscoverAccounts"] = "EVM Discover Accounts";
-})(TraceName || (TraceName = {}));
-//# sourceMappingURL=traces.mjs.map

package/dist/constants/traces.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.mjs","sourceRoot":"","sources":["../../src/constants/traces.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,4DAAiD,CAAA;IACjD,0DAA+C,CAAA;AACjD,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB","sourcesContent":["export enum TraceName {\n  'SnapDiscoverAccounts' = 'Snap Discover Accounts',\n  'EvmDiscoverAccounts' = 'EVM Discover Accounts',\n}\n"]}