@metamask/connect-multichain 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0]
+
+### Fixed
+
+- Normalize `invokeMethod()` wallet errors across transports. Wallet-side JSON-RPC / EIP-1193 `code`, `message`, and `data` fields are now preserved in `RPCInvokeMethodErr` as `rpcCode`, `rpcMessage`, and `rpcData` whether the wallet error arrives as a resolved JSON-RPC error response or as a rejected transport error. Wrapped transport errors now walk a capped `cause` chain so wallet error details are not hidden by transport/API wrapper errors. ([#312](https://github.com/MetaMask/connect-monorepo/pull/312))
+- `DefaultTransport` and `MWPTransport` now preserve the wallet's JSON-RPC error `data` when parsing a failed wallet response. Previously both transports dropped `data` while constructing the rejected error, so revert reasons / custom-error bytes never reached `RequestRouter` (leaving `RPCInvokeMethodErr.rpcData` unset). ([#312](https://github.com/MetaMask/connect-monorepo/pull/312))
+
 ## [1.0.0]
 
 ### Added
@@ -309,7 +316,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@1.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@1.1.0...HEAD
+[1.1.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@1.0.0...@metamask/connect-multichain@1.1.0
 [1.0.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.15.0...@metamask/connect-multichain@1.0.0
 [0.15.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.14.0...@metamask/connect-multichain@0.15.0
 [0.14.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.13.0...@metamask/connect-multichain@0.14.0

package/dist/browser/es/connect-multichain.d.mts

@@ -1,7 +1,7 @@
+import { Json, CaipAccountId, CaipChainId } from '@metamask/utils';
 import debug from 'debug';
 import { SessionData, Transport, SessionProperties, TransportRequest, TransportResponse, MultichainApiClient } from '@metamask/multichain-api-client';
 export { SessionData } from '@metamask/multichain-api-client';
-import { CaipAccountId, CaipChainId, Json } from '@metamask/utils';
 import { SessionRequest, Session } from '@metamask/mobile-wallet-protocol-core';
 import { Components } from '@metamask/multichain-ui';
 
@@ -39,8 +39,17 @@ declare class RPCInvokeMethodErr extends BaseErr<'RPC', RPCErrorCodes> {
     readonly reason: string;
     readonly rpcCode?: number | undefined;
     readonly rpcMessage?: string | undefined;
+    readonly rpcData?: Json | undefined;
     static readonly code = 53;
-    constructor(reason: string, rpcCode?: number | undefined, rpcMessage?: string | undefined);
+    /**
+     * @param reason - MetaMask Connect invokeMethod reason.
+     * @param rpcCode - Original wallet JSON-RPC / EIP-1193 error code.
+     * @param rpcMessage - Original provider-facing wallet message, sourced only
+     * from the wallet's coded error. Unset when the wallet provides no message,
+     * so it may differ from `reason`, which can fall back through the cause chain.
+     * @param rpcData - Original JSON-RPC error data, when provided by the wallet.
+     */
+    constructor(reason: string, rpcCode?: number | undefined, rpcMessage?: string | undefined, rpcData?: Json | undefined);
 }
 
 type SDKEvents = {

package/dist/browser/es/connect-multichain.mjs

@@ -112,7 +112,15 @@ var init_rpc = __esm({
     _RPCReadonlyRequestErr.code = 52;
     RPCReadonlyRequestErr = _RPCReadonlyRequestErr;
     _RPCInvokeMethodErr = class _RPCInvokeMethodErr extends BaseErr {
-      constructor(reason, rpcCode, rpcMessage) {
+      /**
+       * @param reason - MetaMask Connect invokeMethod reason.
+       * @param rpcCode - Original wallet JSON-RPC / EIP-1193 error code.
+       * @param rpcMessage - Original provider-facing wallet message, sourced only
+       * from the wallet's coded error. Unset when the wallet provides no message,
+       * so it may differ from `reason`, which can fall back through the cause chain.
+       * @param rpcData - Original JSON-RPC error data, when provided by the wallet.
+       */
+      constructor(reason, rpcCode, rpcMessage, rpcData) {
         super(
           `RPCErr${_RPCInvokeMethodErr.code}: RPC Client invoke method reason (${reason})`,
           _RPCInvokeMethodErr.code
@@ -120,6 +128,7 @@ var init_rpc = __esm({
         this.reason = reason;
         this.rpcCode = rpcCode;
         this.rpcMessage = rpcMessage;
+        this.rpcData = rpcData;
       }
     };
     _RPCInvokeMethodErr.code = 53;
@@ -870,7 +879,7 @@ var init_utils = __esm({
   "src/domain/utils/index.ts"() {
     "use strict";
     init_analytics();
-    packageVersion = false ? "unknown" : "1.0.0";
+    packageVersion = false ? "unknown" : "1.1.0";
   }
 });
 
@@ -1177,7 +1186,7 @@ import {
   TransportTimeoutError
 } from "@metamask/multichain-api-client";
 import { JsonRpcError, providerErrors as providerErrors2, rpcErrors } from "@metamask/rpc-errors";
-import { createDeferredPromise } from "@metamask/utils";
+import { createDeferredPromise, isValidJson as isValidJson3 } from "@metamask/utils";
 var DEFAULT_REQUEST_TIMEOUT2, CONNECTION_GRACE_PERIOD, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_RESUME_TIMEOUT, SESSION_STORE_KEY, ACCOUNTS_STORE_KEY, CHAIN_STORE_KEY, PENDING_SESSION_REQUEST_KEY, CACHED_METHOD_LIST, CACHED_RESET_METHOD_LIST, logger, _MWPTransport_instances, onResumeHandler_fn, resumeSession_fn, startSession_fn, MWPTransport;
 var init_mwp = __esm({
   "src/multichain/transports/mwp/index.ts"() {
@@ -1284,10 +1293,12 @@ var init_mwp = __esm({
         const errorData = errorPayload;
         if (typeof errorData.code === "number" && typeof errorData.message === "string") {
           const { code, message: message2 } = errorData;
+          const rawData = errorData.data;
+          const data = isValidJson3(rawData) ? rawData : void 0;
           if (code >= 1e3 && code <= 4999) {
-            return providerErrors2.custom({ code, message: message2 });
+            return providerErrors2.custom({ code, message: message2, data });
           }
-          return new JsonRpcError(code, message2);
+          return new JsonRpcError(code, message2, data);
         }
         const message = errorPayload instanceof Error ? errorPayload.message : JSON.stringify(errorPayload);
         return rpcErrors.internal({ message });
@@ -2348,17 +2359,93 @@ import { analytics } from "@metamask/analytics";
 init_domain();
 init_utils2();
 init_analytics();
+
+// src/multichain/rpc/invocationError.ts
+init_domain();
+import { isValidJson } from "@metamask/utils";
+var MAX_ERROR_CAUSE_DEPTH = 5;
+function getErrorObject(value) {
+  if (typeof value === "object" && value !== null) {
+    return value;
+  }
+  return void 0;
+}
+function getNumericCode(value) {
+  return typeof value === "number" ? value : void 0;
+}
+function getNonEmptyMessage(value) {
+  return typeof value === "string" && value.length > 0 ? value : void 0;
+}
+function getJsonData(value) {
+  return value !== void 0 && isValidJson(value) ? value : void 0;
+}
+function getFirstNonEmptyMessage(values) {
+  for (const value of values) {
+    const message = getNonEmptyMessage(value);
+    if (message !== void 0) {
+      return message;
+    }
+  }
+  return void 0;
+}
+function getErrorObjectChain(errorObject) {
+  const chain = [];
+  let currentObject = errorObject;
+  for (let depth = 0; currentObject !== void 0 && depth < MAX_ERROR_CAUSE_DEPTH; depth += 1) {
+    chain.push(currentObject);
+    currentObject = getErrorObject(currentObject.cause);
+  }
+  return chain;
+}
+function getCodedErrorDetails(value) {
+  const code = getNumericCode(value == null ? void 0 : value.code);
+  if (code === void 0) {
+    return void 0;
+  }
+  const message = getNonEmptyMessage(value == null ? void 0 : value.message);
+  const data = getJsonData(value == null ? void 0 : value.data);
+  return __spreadValues(__spreadValues({
+    code
+  }, message === void 0 ? {} : { message }), data === void 0 ? {} : { data });
+}
+function getInvocationErrorDetails(error) {
+  var _a3, _b, _c, _d;
+  const errorObject = getErrorObject(error);
+  const errorObjectChain = getErrorObjectChain(errorObject);
+  const primitiveMessage = getNonEmptyMessage(error);
+  for (const [index, currentObject] of errorObjectChain.entries()) {
+    const codedDetails = getCodedErrorDetails(currentObject);
+    if (codedDetails) {
+      const descendantObjects = errorObjectChain.slice(index + 1);
+      const ancestorObjects = errorObjectChain.slice(0, index);
+      const descendantMessage = getFirstNonEmptyMessage(
+        descendantObjects.map((object) => object.message)
+      );
+      const ancestorMessage = getFirstNonEmptyMessage([
+        primitiveMessage,
+        ...ancestorObjects.map((object) => object.message)
+      ]);
+      const reason2 = (_c = (_b = (_a3 = codedDetails.message) != null ? _a3 : descendantMessage) != null ? _b : ancestorMessage) != null ? _c : "Unknown error";
+      return __spreadValues(__spreadValues({
+        reason: reason2,
+        rpcCode: codedDetails.code
+      }, codedDetails.message === void 0 ? {} : { rpcMessage: codedDetails.message }), codedDetails.data === void 0 ? {} : { rpcData: codedDetails.data });
+    }
+  }
+  const reason = (_d = primitiveMessage != null ? primitiveMessage : getFirstNonEmptyMessage(errorObjectChain.map((object) => object.message))) != null ? _d : "Unknown error";
+  return {
+    reason
+  };
+}
 function toRPCInvokeMethodErr(error) {
-  var _a3;
   if (error instanceof RPCInvokeMethodErr) {
     return error;
   }
-  const castError = error;
-  return new RPCInvokeMethodErr(
-    (_a3 = castError.message) != null ? _a3 : "Unknown error",
-    castError.code
-  );
+  const { reason, rpcCode, rpcMessage, rpcData } = getInvocationErrorDetails(error);
+  return new RPCInvokeMethodErr(reason, rpcCode, rpcMessage, rpcData);
 }
+
+// src/multichain/rpc/requestRouter.ts
 var _RequestRouter_instances, withAnalyticsTracking_fn, trackWalletActionRequested_fn, trackWalletActionSucceeded_fn, trackWalletActionFailed_fn, trackWalletActionRejected_fn;
 var RequestRouter = class {
   constructor(transport, rpcClient, config, transportType) {
@@ -2444,6 +2531,9 @@ var RequestRouter = class {
           }), 10);
         }
         const response = yield request;
+        if (response.error) {
+          throw toRPCInvokeMethodErr(response.error);
+        }
         return response.result;
       }));
     });
@@ -2496,13 +2586,15 @@ withAnalyticsTracking_fn = function(options, execute) {
       yield __privateMethod(this, _RequestRouter_instances, trackWalletActionSucceeded_fn).call(this, options);
       return result;
     } catch (error) {
-      const isRejection = isRejectionError(error);
+      const normalizedError = toRPCInvokeMethodErr(error);
+      const analyticsError = normalizedError.rpcCode === void 0 ? error : normalizedError;
+      const isRejection = isRejectionError(analyticsError);
       if (isRejection) {
         yield __privateMethod(this, _RequestRouter_instances, trackWalletActionRejected_fn).call(this, options);
       } else {
-        yield __privateMethod(this, _RequestRouter_instances, trackWalletActionFailed_fn).call(this, options, error);
+        yield __privateMethod(this, _RequestRouter_instances, trackWalletActionFailed_fn).call(this, options, analyticsError);
       }
-      throw toRPCInvokeMethodErr(error);
+      throw normalizedError;
     }
   });
 };
@@ -2557,6 +2649,7 @@ init_utils2();
 import {
   getDefaultTransport
 } from "@metamask/multichain-api-client";
+import { isValidJson as isValidJson2 } from "@metamask/utils";
 var DEFAULT_REQUEST_TIMEOUT = 60 * 1e3;
 var _notificationCallbacks, _transport, _defaultRequestOptions, _pendingRequests, _handleResponseListener, _handleNotificationListener, _DefaultTransport_instances, notifyCallbacks_fn, parseWalletError_fn, isMetamaskProviderEvent_fn, handleResponse_fn, handleNotification_fn, setupMessageListener_fn, init_fn;
 var DefaultTransport = class {
@@ -2750,6 +2843,10 @@ parseWalletError_fn = function(errorPayload) {
   if (typeof errorData.code === "number") {
     error.code = errorData.code;
   }
+  const { data } = errorData;
+  if (isValidJson2(data)) {
+    error.data = data;
+  }
   return error;
 };
 isMetamaskProviderEvent_fn = function(event) {