@hyperlane-xyz/sdk 44.0.2 → 45.0.1

package/dist/utils/contract.js

@@ -1,6 +1,18 @@
 import { compareVersions } from 'compare-versions';
 import { PackageVersioned__factory } from '@hyperlane-xyz/core';
 import { chunk, isNullish, rootLogger, strip0x, } from '@hyperlane-xyz/utils';
+import { getNestedJsonRpcError } from '../providers/SmartProvider/jsonRpcError.js';
+// Diamond fallbacks can use this custom error instead of empty revert data
+// when no facet implements the requested selector. The value is the selector of
+// FacetNotFound() (first 4 bytes of keccak256("FacetNotFound()")), which takes no
+// arguments, so the revert data is exactly the selector.
+const FACET_NOT_FOUND_REVERT_DATA = '0x800ab12c';
+// LSP17 extendable contracts revert with
+// NoExtensionFoundForFunctionSelector(bytes4) when no extension handles the
+// requested selector. The revert data is the error selector (first 4 bytes of
+// keccak256 of the signature) followed by the requested bytes4 selector
+// left-aligned in one 32-byte word.
+const LSP17_NO_EXTENSION_REVERT_DATA_PATTERN = /^0xbb370b2b([0-9a-f]{8})0{56}$/i;
 /**
  * Returns true when the deployed contract version is already at or above the
  * target version.
@@ -40,6 +52,24 @@ function findCallException(error) {
     }
     return undefined;
 }
+/**
+ * True for LSP17 NoExtensionFoundForFunctionSelector(bytes4) revert data. When
+ * the CALL_EXCEPTION carries the call (`transaction.data`), the embedded
+ * selector must be the called one, otherwise a getter that exists but reaches
+ * another contract's missing extension would read as absent. Without the call
+ * data the embedded selector cannot be verified and the revert is accepted.
+ */
+function isLsp17NoExtensionRevert(data, callException) {
+    const match = LSP17_NO_EXTENSION_REVERT_DATA_PATTERN.exec(data);
+    if (!match)
+        return false;
+    const callData = isRecord(callException.transaction)
+        ? callException.transaction.data
+        : undefined;
+    if (typeof callData !== 'string')
+        return true;
+    return callData.slice(0, 10).toLowerCase() === `0x${match[1].toLowerCase()}`;
+}
 export function isMissingSelectorCallException(error) {
     if (!isRecord(error))
         return false;
@@ -47,6 +77,51 @@ export function isMissingSelectorCallException(error) {
         return true;
     return isMissingSelectorRevert(error);
 }
+// EIP-1474 execution error
+const EXECUTION_REVERTED_JSON_RPC_CODE = 3;
+// Nethermind (before it adopted code 3) reports every VM failure as -32015
+// "VM execution error." and names the failure in the string `data`
+// ("revert", "err: revert (supplied gas N)", "err: OutOfGas ...").
+const NETHERMIND_VM_EXECUTION_ERROR_JSON_RPC_CODE = -32015;
+const NODE_REVERT_MESSAGE_PATTERN = /\brevert(ed)?\b/i;
+/**
+ * True for EVM call return/revert data with no payload ('0x' or ''). Not
+ * isStorageEmpty, which also accepts '0x0' as an empty storage slot.
+ */
+export function isReturnDataEmpty(data) {
+    return data === '0x' || data === '';
+}
+function nestedErrorReportsRevert(callException) {
+    const { code, message, data } = getNestedJsonRpcError(callException);
+    return (code === EXECUTION_REVERTED_JSON_RPC_CODE ||
+        (typeof message === 'string' &&
+            NODE_REVERT_MESSAGE_PATTERN.test(message)) ||
+        (code === NETHERMIND_VM_EXECUTION_ERROR_JSON_RPC_CODE &&
+            typeof data === 'string' &&
+            NODE_REVERT_MESSAGE_PATTERN.test(data)));
+}
+/**
+ * True for an ethers CALL_EXCEPTION produced by a call that executed and
+ * returned nothing: either ethers failed to decode an empty return (no nested
+ * error) or the node reported an execution revert without data.
+ *
+ * ethers wraps every eth_call failure without revert data as a CALL_EXCEPTION
+ * with data "0x", including transport failures (HTTP status errors, dropped
+ * connections, JSON-RPC errors such as "header not found"). Those carry the
+ * original error nested and must not be read as a missing selector. The
+ * formatted message also contains data="0x" for those wrapped failures, so
+ * the message fallback (for ethers/provider combinations that only expose
+ * empty return data there) applies only when there is no nested error. With a
+ * nested error, the call counts as a missing selector when the nested error
+ * reports a revert (JSON-RPC code 3, a revert message, or Nethermind's -32015
+ * with revert data), or when it reports empty data ("0x" or "") and carries
+ * neither a code nor a message. A nested error that pairs empty data with any
+ * other code (SERVER_ERROR, 429, -32000 "header not found") or with a
+ * non-revert message ("socket hang up", "timeout") is a transport failure.
+ * Failures that are not reverts (out of gas, invalid opcode) are not missing
+ * selectors. A diamond FacetNotFound() or an LSP17
+ * NoExtensionFoundForFunctionSelector(bytes4) revert is a missing selector.
+ */
 export function isMissingSelectorRevert(error) {
     const callException = findCallException(error);
     if (!callException)
@@ -57,12 +132,50 @@ export function isMissingSelectorRevert(error) {
     const data = typeof callException.data === 'string'
         ? callException.data
         : nestedError?.data;
-    if (data === '0x')
+    // A diamond or LSP17 miss is a known "no such function" revert, so unlike empty data
+    // it needs no transport gating.
+    if (typeof data === 'string' &&
+        (data.toLowerCase() === FACET_NOT_FOUND_REVERT_DATA ||
+            isLsp17NoExtensionRevert(data, callException))) {
         return true;
+    }
+    const { code: nestedCode, message: nestedMessage, data: nestedData, } = getNestedJsonRpcError(callException);
+    if (isReturnDataEmpty(nestedData)) {
+        return (nestedErrorReportsRevert(callException) ||
+            (isNullish(nestedCode) && isNullish(nestedMessage)));
+    }
     // Some ethers/provider combinations only expose empty return data in the
     // formatted message.
-    return (typeof callException.message === 'string' &&
-        callException.message.includes('data="0x"'));
+    const hasEmptyData = isReturnDataEmpty(data) ||
+        (typeof callException.message === 'string' &&
+            callException.message.includes('data="0x"'));
+    if (!hasEmptyData)
+        return false;
+    if (isNullish(callException.error))
+        return true;
+    return nestedErrorReportsRevert(callException);
+}
+const REVERT_DATA_PATTERN = /^0x[0-9a-fA-F]+$/;
+// Panic(uint256)
+const PANIC_SELECTOR = '0x4e487b71';
+/**
+ * True for a CALL_EXCEPTION whose revert data is a Panic(uint256). Unlike
+ * isMissingSelectorRevert, it treats the reverting probe as an answer rather
+ * than a failure to reach the contract.
+ */
+export function isPanicRevert(error) {
+    const callException = findCallException(error);
+    if (!callException)
+        return false;
+    const nestedError = isRecord(callException.error)
+        ? callException.error
+        : undefined;
+    const data = typeof callException.data === 'string'
+        ? callException.data
+        : nestedError?.data;
+    return (typeof data === 'string' &&
+        REVERT_DATA_PATTERN.test(data) &&
+        data.toLowerCase().startsWith(PANIC_SELECTOR));
 }
 export function throwIfNotMissingSelector(error) {
     if (!isMissingSelectorCallException(error))

package/dist/utils/contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/utils/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAGL,KAAK,EACL,SAAS,EACT,UAAU,EACV,OAAO,GACR,MAAM,sBAAsB,CAAC;AAE9B;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,cAAsB,EACtB,aAAqB;IAErB,OAAO,eAAe,CAAC,cAAc,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,KAAK;QAC3B,CAAC,CAAC,KAAK,CAAC,OAAO;QACf,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACpD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAc;IAC7C,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,mEAAmE;QACnE,yEAAyE;QACzE,0CAA0C;QAC1C,IAAI,eAAe,CAAC,OAAO,CAAC,KAAK,gCAAgC,EAAE,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAc;IAEd,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB;YAAE,OAAO,OAAO,CAAC;QACtD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,uBAAuB,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEhD,OAAO,uBAAuB,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,MAAM,aAAa,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa;QAAE,OAAO,KAAK,CAAC;IAEjC,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;QAC/C,CAAC,CAAC,aAAa,CAAC,KAAK;QACrB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,IAAI,GACR,OAAO,aAAa,CAAC,IAAI,KAAK,QAAQ;QACpC,CAAC,CAAC,aAAa,CAAC,IAAI;QACpB,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC;IACxB,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAE/B,yEAAyE;IACzE,qBAAqB;IACrB,OAAO,CACL,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ;QACzC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,IAAI,CAAC,8BAA8B,CAAC,KAAK,CAAC;QAAE,MAAM,KAAK,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,KAAc;IAC5D,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC;QAAE,MAAM,KAAK,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,QAA4B,EAC5B,OAAgB,EAChB,SAAiB;IAEjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,yEAAyE;IACzE,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE9C;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,QAA4B,EAC5B,OAAgB,EAChB,MAAM,GAAW,UAAU;IAE3B,IAAI,CAAC;QACH,OAAO,MAAM,yBAAyB,CAAC,OAAO,CAC5C,OAAO,EACP,QAAQ,CACT,CAAC,eAAe,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,8BAA8B,CAAC,KAAK,CAAC;YAAE,OAAO,sBAAsB,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sCAAsC,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;QACtE,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/utils/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAGL,KAAK,EACL,SAAS,EACT,UAAU,EACV,OAAO,GACR,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,4CAA4C,CAAC;AAEnF,2EAA2E;AAC3E,gFAAgF;AAChF,kFAAkF;AAClF,yDAAyD;AACzD,MAAM,2BAA2B,GAAG,YAAY,CAAC;AAEjD,yCAAyC;AACzC,4EAA4E;AAC5E,8EAA8E;AAC9E,wEAAwE;AACxE,oCAAoC;AACpC,MAAM,sCAAsC,GAC1C,iCAAiC,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,cAAsB,EACtB,aAAqB;IAErB,OAAO,eAAe,CAAC,cAAc,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,KAAK;QAC3B,CAAC,CAAC,KAAK,CAAC,OAAO;QACf,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACpD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAc;IAC7C,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,mEAAmE;QACnE,yEAAyE;QACzE,0CAA0C;QAC1C,IAAI,eAAe,CAAC,OAAO,CAAC,KAAK,gCAAgC,EAAE,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAc;IAEd,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB;YAAE,OAAO,OAAO,CAAC;QACtD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAC/B,IAAY,EACZ,aAAsC;IAEtC,MAAM,KAAK,GAAG,sCAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC;QAClD,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI;QAChC,CAAC,CAAC,SAAS,CAAC;IACd,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC9C,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,KAAc;IAC3D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,uBAAuB,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEhD,OAAO,uBAAuB,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAED,2BAA2B;AAC3B,MAAM,gCAAgC,GAAG,CAAC,CAAC;AAC3C,2EAA2E;AAC3E,mEAAmE;AACnE,mEAAmE;AACnE,MAAM,2CAA2C,GAAG,CAAC,KAAK,CAAC;AAC3D,MAAM,2BAA2B,GAAG,kBAAkB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAa;IAC7C,OAAO,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;AACtC,CAAC;AAED,SAAS,wBAAwB,CAAC,aAAsB;IACtD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IACrE,OAAO,CACL,IAAI,KAAK,gCAAgC;QACzC,CAAC,OAAO,OAAO,KAAK,QAAQ;YAC1B,2BAA2B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC,IAAI,KAAK,2CAA2C;YACnD,OAAO,IAAI,KAAK,QAAQ;YACxB,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAC1C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,MAAM,aAAa,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa;QAAE,OAAO,KAAK,CAAC;IAEjC,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;QAC/C,CAAC,CAAC,aAAa,CAAC,KAAK;QACrB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,IAAI,GACR,OAAO,aAAa,CAAC,IAAI,KAAK,QAAQ;QACpC,CAAC,CAAC,aAAa,CAAC,IAAI;QACpB,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC;IACxB,qFAAqF;IACrF,gCAAgC;IAChC,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,2BAA2B;YACjD,wBAAwB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,EAChD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EACJ,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,UAAU,GACjB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IACzC,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,OAAO,CACL,wBAAwB,CAAC,aAAa,CAAC;YACvC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,CACpD,CAAC;IACJ,CAAC;IAED,yEAAyE;IACzE,qBAAqB;IACrB,MAAM,YAAY,GAChB,iBAAiB,CAAC,IAAI,CAAC;QACvB,CAAC,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ;YACxC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IACjD,IAAI,CAAC,YAAY;QAAE,OAAO,KAAK,CAAC;IAEhC,IAAI,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEhD,OAAO,wBAAwB,CAAC,aAAa,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAC/C,iBAAiB;AACjB,MAAM,cAAc,GAAG,YAAY,CAAC;AAEpC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,aAAa,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa;QAAE,OAAO,KAAK,CAAC;IAEjC,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;QAC/C,CAAC,CAAC,aAAa,CAAC,KAAK;QACrB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,IAAI,GACR,OAAO,aAAa,CAAC,IAAI,KAAK,QAAQ;QACpC,CAAC,CAAC,aAAa,CAAC,IAAI;QACpB,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC;IACxB,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAC9C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,IAAI,CAAC,8BAA8B,CAAC,KAAK,CAAC;QAAE,MAAM,KAAK,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,KAAc;IAC5D,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC;QAAE,MAAM,KAAK,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,QAA4B,EAC5B,OAAgB,EAChB,SAAiB;IAEjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,yEAAyE;IACzE,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE9C;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,QAA4B,EAC5B,OAAgB,EAChB,MAAM,GAAW,UAAU;IAE3B,IAAI,CAAC;QACH,OAAO,MAAM,yBAAyB,CAAC,OAAO,CAC5C,OAAO,EACP,QAAQ,CACT,CAAC,eAAe,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,8BAA8B,CAAC,KAAK,CAAC;YAAE,OAAO,sBAAsB,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sCAAsC,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;QACtE,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/utils/contract.test.js

@@ -3,9 +3,15 @@ import sinon from 'sinon';
 import { TestChainName } from '../consts/testChains.js';
 import { MultiProvider } from '../providers/MultiProvider.js';
 import { stubPackageVersion } from '../test/contractStubs.js';
-import { missingSelectorError, networkError, wrappedError, } from '../test/errors.js';
+import { errorStringRevertError, ethersCallExceptionWithNestedError, lsp17NoExtensionError, missingSelectorError, networkError, panicRevertError, wrappedError, } from '../test/errors.js';
 import { randomAddress } from '../test/testUtils.js';
-import { LEGACY_PACKAGE_VERSION, fetchPackageVersion, isMissingSelectorCallException, isMissingSelectorRevert, } from './contract.js';
+import { LEGACY_PACKAGE_VERSION, fetchPackageVersion, isMissingSelectorCallException, isMissingSelectorRevert, isPanicRevert, isReturnDataEmpty, } from './contract.js';
+function facetNotFoundError() {
+    return Object.assign(new Error('call reverted with FacetNotFound()'), {
+        code: 'CALL_EXCEPTION',
+        data: '0x800ab12c',
+    });
+}
 describe('contract utils', () => {
     describe('isMissingSelectorCallException', () => {
         it('matches empty call exceptions', () => {
@@ -17,6 +23,20 @@ describe('contract utils', () => {
         it('matches deeply wrapped empty call exceptions', () => {
             expect(isMissingSelectorCallException(wrappedError(wrappedError(missingSelectorError())))).to.equal(true);
         });
+        it('matches direct and wrapped diamond FacetNotFound reverts', () => {
+            expect(isMissingSelectorCallException(facetNotFoundError())).to.equal(true);
+            expect(isMissingSelectorCallException(wrappedError(facetNotFoundError()))).to.equal(true);
+        });
+        it('matches FacetNotFound revert data nested in the underlying error but not with trailing bytes', () => {
+            expect(isMissingSelectorCallException(Object.assign(new Error('call revert exception'), {
+                code: 'CALL_EXCEPTION',
+                error: { data: '0x800ab12c' },
+            }))).to.equal(true);
+            expect(isMissingSelectorCallException(Object.assign(new Error('call revert exception'), {
+                code: 'CALL_EXCEPTION',
+                data: `0x800ab12c${'00'.repeat(32)}`,
+            }))).to.equal(false);
+        });
         it('matches HyperlaneJsonRpcProvider empty responses', () => {
             expect(isMissingSelectorCallException(new Error('Invalid response from provider'))).to.equal(true);
             expect(isMissingSelectorRevert(new Error('Invalid response from provider'))).to.equal(false);
@@ -28,6 +48,449 @@ describe('contract utils', () => {
             expect(isMissingSelectorCallException(new Error('request failed with data="0x"'))).to.equal(false);
         });
     });
+    describe('isMissingSelectorRevert LSP17 NoExtensionFoundForFunctionSelector', () => {
+        const NO_EXTENSION_SELECTOR = '0xbb370b2b';
+        const FEE_HOOK_SELECTOR = 'f11f4461';
+        const lsp17Data = `${NO_EXTENSION_SELECTOR}${FEE_HOOK_SELECTOR}${'00'.repeat(28)}`;
+        const cases = [
+            {
+                name: 'an embedded selector equal to the called selector',
+                data: lsp17Data,
+                callData: `0x${FEE_HOOK_SELECTOR}`,
+                expected: true,
+            },
+            {
+                name: 'an embedded selector equal to the called selector, case-insensitively',
+                data: lsp17Data,
+                callData: `0x${FEE_HOOK_SELECTOR.toUpperCase()}${'00'.repeat(32)}`,
+                expected: true,
+            },
+            {
+                name: 'an embedded selector of another call than the one made',
+                data: lsp17Data,
+                callData: '0x46904840',
+                expected: false,
+            },
+            {
+                name: 'a left-aligned bytes4 argument',
+                data: `${NO_EXTENSION_SELECTOR}${FEE_HOOK_SELECTOR}${'00'.repeat(28)}`,
+                expected: true,
+            },
+            {
+                name: 'a different 4+32 byte custom error',
+                data: `0xdeadbeef${FEE_HOOK_SELECTOR}${'00'.repeat(28)}`,
+                expected: false,
+            },
+            {
+                name: 'the error selector without the argument',
+                data: NO_EXTENSION_SELECTOR,
+                expected: false,
+            },
+            {
+                name: 'the error selector with a truncated argument',
+                data: `${NO_EXTENSION_SELECTOR}${FEE_HOOK_SELECTOR}${'00'.repeat(27)}`,
+                expected: false,
+            },
+            {
+                name: 'the error selector with trailing bytes',
+                data: `${NO_EXTENSION_SELECTOR}${FEE_HOOK_SELECTOR}${'00'.repeat(29)}`,
+                expected: false,
+            },
+        ];
+        for (const c of cases) {
+            it(`returns ${c.expected} for ${c.name}`, () => {
+                const error = Object.assign(new Error('call revert exception'), {
+                    code: 'CALL_EXCEPTION',
+                    data: c.data,
+                });
+                if (c.callData !== undefined) {
+                    Object.assign(error, { transaction: { data: c.callData } });
+                }
+                expect(isMissingSelectorRevert(error)).to.equal(c.expected);
+                expect(isMissingSelectorRevert(wrappedError(error))).to.equal(c.expected);
+            });
+        }
+    });
+    describe('isMissingSelectorCallException with nested ethers errors', () => {
+        const cases = [
+            {
+                name: 'JSON-RPC code 3 revert without data',
+                nested: Object.assign(new Error('execution reverted'), {
+                    code: 3,
+                    data: '0x',
+                }),
+                expected: true,
+            },
+            {
+                name: 'JSON-RPC -32000 execution reverted',
+                nested: Object.assign(new Error('execution reverted'), {
+                    code: -32000,
+                }),
+                expected: true,
+            },
+            {
+                name: 'hardhat VM exception revert',
+                nested: Object.assign(new Error("VM Exception while processing transaction: reverted with reason string ''"), { code: -32603 }),
+                expected: true,
+            },
+            {
+                name: 'revert JSON body inside an HTTP error response (transient, like SmartProvider)',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'processing response error',
+                    body: '{"jsonrpc":"2.0","id":1,"error":{"code":3,"message":"x"}}',
+                },
+                expected: false,
+            },
+            {
+                name: 'HTTP 500 server error',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'processing response error (body="Internal Server Error", responseText="Internal Server Error", requestBody="{}", requestMethod="POST", url="http://x", code=SERVER_ERROR, version=web/5.8.0)',
+                    body: 'Internal Server Error',
+                    status: 500,
+                },
+                expected: false,
+            },
+            {
+                name: 'JSON-RPC -32000 header not found',
+                nested: Object.assign(new Error('header not found'), { code: -32000 }),
+                expected: false,
+            },
+            {
+                name: 'connection reset (missing response)',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'missing response (requestBody="{}", requestMethod="POST", serverError={"code":"ECONNRESET"}, url="http://x", code=SERVER_ERROR, version=web/5.8.0)',
+                },
+                expected: false,
+            },
+            {
+                name: 'request timeout',
+                nested: {
+                    code: 'TIMEOUT',
+                    message: 'timeout (requestBody="{}", timeout=120000)',
+                },
+                expected: false,
+            },
+            {
+                name: 'HTTP 429 rate limit',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'bad response (status=429, headers={}, body="Too Many Requests")',
+                    status: 429,
+                },
+                expected: false,
+            },
+            {
+                name: 'JSON-RPC rate limit error',
+                nested: Object.assign(new Error('rate limit exceeded'), {
+                    code: -32005,
+                }),
+                expected: false,
+            },
+            {
+                name: 'nested data 0x with header not found',
+                nested: Object.assign(new Error('header not found'), {
+                    code: -32000,
+                    data: '0x',
+                }),
+                expected: false,
+            },
+            {
+                name: 'nested empty-string data with HTTP 429',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'bad response (status=429, headers={}, body="Too Many Requests")',
+                    status: 429,
+                    data: '',
+                },
+                expected: false,
+            },
+            {
+                name: 'nested data 0x with an HTTP 500 body',
+                nested: {
+                    code: 'SERVER_ERROR',
+                    message: 'processing response error',
+                    body: 'Internal Server Error',
+                    status: 500,
+                    data: '0x',
+                },
+                expected: false,
+            },
+            {
+                name: 'nested data 0x with JSON-RPC code 3',
+                nested: Object.assign(new Error('execution reverted'), {
+                    code: 3,
+                    data: '0x',
+                }),
+                expected: true,
+            },
+            // Captured from https://rpc.fuse.io (Nethermind 1.29.0) for an unknown
+            // selector sent to a deployed Mailbox.
+            {
+                name: 'Nethermind -32015 revert with a supplied-gas data string',
+                nested: {
+                    error: {
+                        code: -32015,
+                        message: 'VM execution error.',
+                        data: 'err: revert (supplied gas 20000000)',
+                    },
+                },
+                expected: true,
+            },
+            // Captured from https://fuse.liquify.com (Nethermind 1.29.0).
+            {
+                name: 'Nethermind -32015 revert with a bare revert data string',
+                nested: {
+                    error: {
+                        code: -32015,
+                        message: 'VM execution error.',
+                        data: 'revert',
+                    },
+                },
+                expected: true,
+            },
+            // Captured from https://rpc.fuse.io and https://fuse.liquify.com.
+            {
+                name: 'Nethermind -32015 out of gas',
+                nested: {
+                    error: {
+                        code: -32015,
+                        message: 'VM execution error.',
+                        data: 'err: OutOfGas (supplied gas 30000)',
+                    },
+                },
+                expected: false,
+            },
+            // Captured from https://fuse.liquify.com for eth_call against code 0xfe.
+            {
+                name: 'Nethermind -32015 invalid instruction',
+                nested: {
+                    error: {
+                        code: -32015,
+                        message: 'VM execution error.',
+                        data: 'err: BadInstruction (supplied gas 20000000)',
+                    },
+                },
+                expected: false,
+            },
+            {
+                name: 'revert data string under a non-Nethermind code',
+                nested: {
+                    error: { code: -32005, message: 'rate limit', data: 'revert' },
+                },
+                expected: false,
+            },
+            // Captured from https://ethereum.publicnode.com (Geth 1.17.1) for eth_call
+            // against code 0xfe and against an infinite loop with a 30000 gas cap.
+            {
+                name: 'Geth invalid opcode',
+                nested: Object.assign(new Error('invalid opcode: INVALID'), {
+                    code: -32000,
+                }),
+                expected: false,
+            },
+            {
+                name: 'Geth out of gas',
+                nested: Object.assign(new Error('out of gas'), { code: -32000 }),
+                expected: false,
+            },
+        ];
+        for (const c of cases) {
+            it(`returns ${c.expected} for ${c.name}`, () => {
+                const error = ethersCallExceptionWithNestedError(c.nested);
+                expect(isMissingSelectorCallException(error)).to.equal(c.expected);
+                expect(isMissingSelectorRevert(error)).to.equal(c.expected);
+                expect(isMissingSelectorCallException(wrappedError(error))).to.equal(c.expected);
+            });
+        }
+    });
+    describe('isMissingSelectorRevert empty-data signals', () => {
+        const cases = [
+            {
+                name: 'nested error reporting data 0x without top-level data',
+                error: () => ({ code: 'CALL_EXCEPTION', error: { data: '0x' } }),
+                expected: true,
+            },
+            {
+                name: 'nested error data 0x alongside a non-revert message and no code',
+                error: () => ethersCallExceptionWithNestedError(Object.assign(new Error('boom'), { data: '0x' })),
+                expected: false,
+            },
+            {
+                name: 'nested transport message ECONNRESET with data 0x',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    error: { message: 'ECONNRESET', data: '0x' },
+                }),
+                expected: false,
+            },
+            {
+                name: 'nested transport message socket hang up with empty-string data',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    error: { message: 'socket hang up', data: '' },
+                }),
+                expected: false,
+            },
+            {
+                name: 'nested error reporting empty-string data',
+                error: () => ({ code: 'CALL_EXCEPTION', error: { data: '' } }),
+                expected: true,
+            },
+            {
+                name: 'nested error data 0x with SERVER_ERROR and no message',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    error: { code: 'SERVER_ERROR', data: '0x' },
+                }),
+                expected: false,
+            },
+            {
+                name: 'nested error data "" with HTTP 429 status',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    error: { code: 'SERVER_ERROR', status: 429, data: '' },
+                }),
+                expected: false,
+            },
+            {
+                name: 'top-level empty-string data without nested error',
+                error: () => ({ code: 'CALL_EXCEPTION', data: '' }),
+                expected: true,
+            },
+            {
+                name: 'top-level empty-string data with nested transport error',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    data: '',
+                    error: { code: 'SERVER_ERROR', status: 500 },
+                }),
+                expected: false,
+            },
+            {
+                name: 'message-only data="0x" without nested error',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    message: 'call reverted with data="0x"',
+                }),
+                expected: true,
+            },
+            {
+                name: 'message data="0x" with nested transport error',
+                error: () => ethersCallExceptionWithNestedError(Object.assign(new Error('header not found'), { code: -32000 })),
+                expected: false,
+            },
+            {
+                name: 'message data="0x" with nested HTTP 500 and no top-level data',
+                error: () => ({
+                    code: 'CALL_EXCEPTION',
+                    message: 'call reverted with data="0x"',
+                    error: { code: 'SERVER_ERROR', status: 500 },
+                }),
+                expected: false,
+            },
+            {
+                name: 'non-empty revert data',
+                error: () => ({ code: 'CALL_EXCEPTION', data: '0x08c379a0abcd' }),
+                expected: false,
+            },
+        ];
+        for (const c of cases) {
+            it(`returns ${c.expected} for ${c.name}`, () => {
+                expect(isMissingSelectorRevert(c.error())).to.equal(c.expected);
+                expect(isMissingSelectorCallException(c.error())).to.equal(c.expected);
+            });
+        }
+    });
+    describe('isReturnDataEmpty', () => {
+        const cases = [
+            { name: '0x', data: '0x', expected: true },
+            { name: 'empty string', data: '', expected: true },
+            { name: '0x0', data: '0x0', expected: false },
+            { name: 'undefined', data: undefined, expected: false },
+            { name: 'null', data: null, expected: false },
+            { name: 'a number', data: 0, expected: false },
+            { name: 'non-empty hex', data: '0x08c379a0', expected: false },
+        ];
+        for (const c of cases) {
+            it(`returns ${c.expected} for ${c.name}`, () => {
+                expect(isReturnDataEmpty(c.data)).to.equal(c.expected);
+            });
+        }
+    });
+    describe('isPanicRevert', () => {
+        const cases = [
+            { name: 'panic revert', error: panicRevertError, expected: true },
+            {
+                name: 'wrapped panic revert',
+                error: () => wrappedError(panicRevertError()),
+                expected: true,
+            },
+            {
+                name: 'panic data on nested error.data',
+                error: () => Object.assign(new Error('call revert exception'), {
+                    code: 'CALL_EXCEPTION',
+                    error: { data: `0x4e487b71${'0'.repeat(62)}11` },
+                }),
+                expected: true,
+            },
+            {
+                name: 'Error(string) revert',
+                error: errorStringRevertError,
+                expected: false,
+            },
+            {
+                name: 'LSP17 no-extension revert',
+                error: lsp17NoExtensionError,
+                expected: false,
+            },
+            {
+                name: 'empty data (missing selector)',
+                error: missingSelectorError,
+                expected: false,
+            },
+            { name: 'network error', error: networkError, expected: false },
+            {
+                name: 'empty provider response',
+                error: () => new Error('Invalid response from provider'),
+                expected: false,
+            },
+            {
+                name: 'data shorter than the Panic selector',
+                error: () => Object.assign(new Error('call revert exception'), {
+                    code: 'CALL_EXCEPTION',
+                    data: '0x4e487b',
+                }),
+                expected: false,
+            },
+            {
+                name: 'non-hex data',
+                error: () => Object.assign(new Error('call revert exception'), {
+                    code: 'CALL_EXCEPTION',
+                    data: '0x4e487b71zz',
+                }),
+                expected: false,
+            },
+            {
+                name: 'call exception without data',
+                error: () => Object.assign(new Error('call revert exception'), {
+                    code: 'CALL_EXCEPTION',
+                }),
+                expected: false,
+            },
+        ];
+        for (const c of cases) {
+            it(`returns ${c.expected} for ${c.name}`, () => {
+                expect(isPanicRevert(c.error())).to.equal(c.expected);
+            });
+        }
+        it('is not a missing selector for data-carrying reverts', () => {
+            expect(isMissingSelectorRevert(panicRevertError())).to.equal(false);
+            expect(isMissingSelectorCallException(panicRevertError())).to.equal(false);
+        });
+    });
     describe('fetchPackageVersion', () => {
         let sandbox;
         beforeEach(() => {