@0xsequence/provider 0.42.8 → 0.42.9

package/dist/0xsequence-provider.cjs.dev.js

@@ -1719,6 +1719,114 @@ const hexlifyTransaction = (transaction, allowExtra) => {
   return result;
 };
 
+function messageIsExemptFromEIP191Prefix(message) {
+  return EIP_191_PREFIX_EXCEPTIONS.some(e => e.predicate(message));
+}
+const EIP_191_PREFIX_EXCEPTIONS = [// NOTE: Decentraland does not support 191 correctly.
+{
+  name: 'Decentraland Exception',
+  predicate: isDecentralandLoginMessage
+}, // NOTE: 0x v3 does not support 191 correctly.
+// See https://gov.0x.org/t/zeip-proposal-fix-v3-eip-191-non-compliance-when-validating-eip-1271-signatures/3396 for more info.
+{
+  name: '0x v3 Exception',
+  predicate: isZeroExV3Order
+}];
+const DCL_REGEX = /^Decentraland Login\nEphemeral address: 0x[a-fA-F0-9]{40}\nExpiration: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)((-(\d{2}):(\d{2})|Z)?)$/;
+function isDecentralandLoginMessage(bytes) {
+  try {
+    const stringified = ethers.ethers.utils.toUtf8String(bytes);
+    return DCL_REGEX.test(stringified);
+  } catch (_unused) {
+    return false;
+  }
+} // try to interpret bytes as abi-encoded 0x v3 OrderWithHash -
+// see https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md
+
+function isZeroExV3Order(bytes) {
+  const abi = new ethers.ethers.utils.Interface(ZeroXV3EIP1271OrderWithHashAbi);
+
+  try {
+    abi.decodeFunctionData('OrderWithHash', bytes);
+    return true;
+  } catch (err) {
+    // failed to decode ABI, so it's not a v3 order.
+    return false;
+  }
+}
+const ZeroXV3EIP1271OrderWithHashAbi = [{
+  inputs: [{
+    components: [{
+      internalType: 'address',
+      name: 'makerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'takerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'feeRecipientAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'senderAddress',
+      type: 'address'
+    }, {
+      internalType: 'uint256',
+      name: 'makerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'makerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'expirationTimeSeconds',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'salt',
+      type: 'uint256'
+    }, {
+      internalType: 'bytes',
+      name: 'makerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'makerFeeAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerFeeAssetData',
+      type: 'bytes'
+    }],
+    internalType: 'struct IEIP1271Data.Order',
+    name: 'order',
+    type: 'tuple'
+  }, {
+    internalType: 'bytes32',
+    name: 'orderHash',
+    type: 'bytes32'
+  }],
+  name: 'OrderWithHash',
+  outputs: [],
+  stateMutability: 'pure',
+  type: 'function'
+}];
+
 const eip191prefix = ethers.ethers.utils.toUtf8Bytes('\x19Ethereum Signed Message:\n');
 const messageToBytes = message => {
   if (ethers.ethers.utils.isBytes(message) || ethers.ethers.utils.isHexString(message)) {
@@ -1729,7 +1837,12 @@ const messageToBytes = message => {
 };
 const prefixEIP191Message = message => {
   const messageBytes = messageToBytes(message);
-  return ethers.ethers.utils.concat([eip191prefix, ethers.ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+
+  if (messageIsExemptFromEIP191Prefix(messageBytes)) {
+    return messageBytes;
+  } else {
+    return ethers.ethers.utils.concat([eip191prefix, ethers.ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+  }
 };
 const isValidSignature = async (address, digest, sig, provider, chainId, walletContext) => {
   if (!chainId) {

package/dist/0xsequence-provider.cjs.prod.js

@@ -1719,6 +1719,114 @@ const hexlifyTransaction = (transaction, allowExtra) => {
   return result;
 };
 
+function messageIsExemptFromEIP191Prefix(message) {
+  return EIP_191_PREFIX_EXCEPTIONS.some(e => e.predicate(message));
+}
+const EIP_191_PREFIX_EXCEPTIONS = [// NOTE: Decentraland does not support 191 correctly.
+{
+  name: 'Decentraland Exception',
+  predicate: isDecentralandLoginMessage
+}, // NOTE: 0x v3 does not support 191 correctly.
+// See https://gov.0x.org/t/zeip-proposal-fix-v3-eip-191-non-compliance-when-validating-eip-1271-signatures/3396 for more info.
+{
+  name: '0x v3 Exception',
+  predicate: isZeroExV3Order
+}];
+const DCL_REGEX = /^Decentraland Login\nEphemeral address: 0x[a-fA-F0-9]{40}\nExpiration: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)((-(\d{2}):(\d{2})|Z)?)$/;
+function isDecentralandLoginMessage(bytes) {
+  try {
+    const stringified = ethers.ethers.utils.toUtf8String(bytes);
+    return DCL_REGEX.test(stringified);
+  } catch (_unused) {
+    return false;
+  }
+} // try to interpret bytes as abi-encoded 0x v3 OrderWithHash -
+// see https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md
+
+function isZeroExV3Order(bytes) {
+  const abi = new ethers.ethers.utils.Interface(ZeroXV3EIP1271OrderWithHashAbi);
+
+  try {
+    abi.decodeFunctionData('OrderWithHash', bytes);
+    return true;
+  } catch (err) {
+    // failed to decode ABI, so it's not a v3 order.
+    return false;
+  }
+}
+const ZeroXV3EIP1271OrderWithHashAbi = [{
+  inputs: [{
+    components: [{
+      internalType: 'address',
+      name: 'makerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'takerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'feeRecipientAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'senderAddress',
+      type: 'address'
+    }, {
+      internalType: 'uint256',
+      name: 'makerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'makerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'expirationTimeSeconds',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'salt',
+      type: 'uint256'
+    }, {
+      internalType: 'bytes',
+      name: 'makerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'makerFeeAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerFeeAssetData',
+      type: 'bytes'
+    }],
+    internalType: 'struct IEIP1271Data.Order',
+    name: 'order',
+    type: 'tuple'
+  }, {
+    internalType: 'bytes32',
+    name: 'orderHash',
+    type: 'bytes32'
+  }],
+  name: 'OrderWithHash',
+  outputs: [],
+  stateMutability: 'pure',
+  type: 'function'
+}];
+
 const eip191prefix = ethers.ethers.utils.toUtf8Bytes('\x19Ethereum Signed Message:\n');
 const messageToBytes = message => {
   if (ethers.ethers.utils.isBytes(message) || ethers.ethers.utils.isHexString(message)) {
@@ -1729,7 +1837,12 @@ const messageToBytes = message => {
 };
 const prefixEIP191Message = message => {
   const messageBytes = messageToBytes(message);
-  return ethers.ethers.utils.concat([eip191prefix, ethers.ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+
+  if (messageIsExemptFromEIP191Prefix(messageBytes)) {
+    return messageBytes;
+  } else {
+    return ethers.ethers.utils.concat([eip191prefix, ethers.ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+  }
 };
 const isValidSignature = async (address, digest, sig, provider, chainId, walletContext) => {
   if (!chainId) {

package/dist/0xsequence-provider.esm.js

@@ -1715,6 +1715,114 @@ const hexlifyTransaction = (transaction, allowExtra) => {
   return result;
 };
 
+function messageIsExemptFromEIP191Prefix(message) {
+  return EIP_191_PREFIX_EXCEPTIONS.some(e => e.predicate(message));
+}
+const EIP_191_PREFIX_EXCEPTIONS = [// NOTE: Decentraland does not support 191 correctly.
+{
+  name: 'Decentraland Exception',
+  predicate: isDecentralandLoginMessage
+}, // NOTE: 0x v3 does not support 191 correctly.
+// See https://gov.0x.org/t/zeip-proposal-fix-v3-eip-191-non-compliance-when-validating-eip-1271-signatures/3396 for more info.
+{
+  name: '0x v3 Exception',
+  predicate: isZeroExV3Order
+}];
+const DCL_REGEX = /^Decentraland Login\nEphemeral address: 0x[a-fA-F0-9]{40}\nExpiration: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)((-(\d{2}):(\d{2})|Z)?)$/;
+function isDecentralandLoginMessage(bytes) {
+  try {
+    const stringified = ethers.utils.toUtf8String(bytes);
+    return DCL_REGEX.test(stringified);
+  } catch (_unused) {
+    return false;
+  }
+} // try to interpret bytes as abi-encoded 0x v3 OrderWithHash -
+// see https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md
+
+function isZeroExV3Order(bytes) {
+  const abi = new ethers.utils.Interface(ZeroXV3EIP1271OrderWithHashAbi);
+
+  try {
+    abi.decodeFunctionData('OrderWithHash', bytes);
+    return true;
+  } catch (err) {
+    // failed to decode ABI, so it's not a v3 order.
+    return false;
+  }
+}
+const ZeroXV3EIP1271OrderWithHashAbi = [{
+  inputs: [{
+    components: [{
+      internalType: 'address',
+      name: 'makerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'takerAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'feeRecipientAddress',
+      type: 'address'
+    }, {
+      internalType: 'address',
+      name: 'senderAddress',
+      type: 'address'
+    }, {
+      internalType: 'uint256',
+      name: 'makerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerAssetAmount',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'makerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'takerFee',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'expirationTimeSeconds',
+      type: 'uint256'
+    }, {
+      internalType: 'uint256',
+      name: 'salt',
+      type: 'uint256'
+    }, {
+      internalType: 'bytes',
+      name: 'makerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'makerFeeAssetData',
+      type: 'bytes'
+    }, {
+      internalType: 'bytes',
+      name: 'takerFeeAssetData',
+      type: 'bytes'
+    }],
+    internalType: 'struct IEIP1271Data.Order',
+    name: 'order',
+    type: 'tuple'
+  }, {
+    internalType: 'bytes32',
+    name: 'orderHash',
+    type: 'bytes32'
+  }],
+  name: 'OrderWithHash',
+  outputs: [],
+  stateMutability: 'pure',
+  type: 'function'
+}];
+
 const eip191prefix = ethers.utils.toUtf8Bytes('\x19Ethereum Signed Message:\n');
 const messageToBytes = message => {
   if (ethers.utils.isBytes(message) || ethers.utils.isHexString(message)) {
@@ -1725,7 +1833,12 @@ const messageToBytes = message => {
 };
 const prefixEIP191Message = message => {
   const messageBytes = messageToBytes(message);
-  return ethers.utils.concat([eip191prefix, ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+
+  if (messageIsExemptFromEIP191Prefix(messageBytes)) {
+    return messageBytes;
+  } else {
+    return ethers.utils.concat([eip191prefix, ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes]);
+  }
 };
 const isValidSignature = async (address, digest, sig, provider, chainId, walletContext) => {
   if (!chainId) {

package/dist/declarations/src/eip191exceptions.d.ts

@@ -0,0 +1,3 @@
+export declare function messageIsExemptFromEIP191Prefix(message: Uint8Array): boolean;
+export declare function isDecentralandLoginMessage(bytes: Uint8Array): boolean;
+export declare function isZeroExV3Order(bytes: Uint8Array): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.42.8",
+  "version": "0.42.9",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -9,17 +9,18 @@
   "author": "Horizon Blockchain Games",
   "license": "Apache-2.0",
   "scripts": {
-    "test": "echo",
+    "test": "yarn test:file tests/**/*.spec.ts",
+    "test:file": "TS_NODE_PROJECT=../../tsconfig.test.json mocha -r ts-node/register --timeout 30000",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@0xsequence/abi": "^0.42.8",
-    "@0xsequence/auth": "^0.42.8",
-    "@0xsequence/config": "^0.42.8",
-    "@0xsequence/network": "^0.42.8",
-    "@0xsequence/transactions": "^0.42.8",
-    "@0xsequence/utils": "^0.42.8",
-    "@0xsequence/wallet": "^0.42.8",
+    "@0xsequence/abi": "^0.42.9",
+    "@0xsequence/auth": "^0.42.9",
+    "@0xsequence/config": "^0.42.9",
+    "@0xsequence/network": "^0.42.9",
+    "@0xsequence/transactions": "^0.42.9",
+    "@0xsequence/utils": "^0.42.9",
+    "@0xsequence/wallet": "^0.42.9",
     "@ethersproject/abstract-signer": "^5.5.0",
     "@ethersproject/hash": "^5.5.0",
     "@ethersproject/providers": "^5.5.1",
@@ -34,4 +35,4 @@
     "src",
     "dist"
   ]
-}
+}

package/src/eip191exceptions.ts

@@ -0,0 +1,137 @@
+import { ethers } from 'ethers'
+
+export function messageIsExemptFromEIP191Prefix(message: Uint8Array): boolean {
+  return EIP_191_PREFIX_EXCEPTIONS.some(e => e.predicate(message))
+}
+
+const EIP_191_PREFIX_EXCEPTIONS: Array<{
+  name: string
+  predicate: (message: Uint8Array) => boolean
+}> = [
+  // NOTE: Decentraland does not support 191 correctly.
+  {
+    name: 'Decentraland Exception',
+    predicate: isDecentralandLoginMessage
+  },
+
+  // NOTE: 0x v3 does not support 191 correctly.
+  // See https://gov.0x.org/t/zeip-proposal-fix-v3-eip-191-non-compliance-when-validating-eip-1271-signatures/3396 for more info.
+  { name: '0x v3 Exception', predicate: isZeroExV3Order }
+]
+
+const DCL_REGEX =
+  /^Decentraland Login\nEphemeral address: 0x[a-fA-F0-9]{40}\nExpiration: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)((-(\d{2}):(\d{2})|Z)?)$/
+export function isDecentralandLoginMessage(bytes: Uint8Array): boolean {
+  try {
+    const stringified = ethers.utils.toUtf8String(bytes)
+    return DCL_REGEX.test(stringified)
+  } catch {
+    return false
+  }
+}
+
+// try to interpret bytes as abi-encoded 0x v3 OrderWithHash -
+// see https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md
+export function isZeroExV3Order(bytes: Uint8Array): boolean {
+  const abi = new ethers.utils.Interface(ZeroXV3EIP1271OrderWithHashAbi)
+  try {
+    abi.decodeFunctionData('OrderWithHash', bytes)
+    return true
+  } catch (err) {
+    // failed to decode ABI, so it's not a v3 order.
+    return false
+  }
+}
+
+const ZeroXV3EIP1271OrderWithHashAbi = [
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address',
+            name: 'makerAddress',
+            type: 'address'
+          },
+          {
+            internalType: 'address',
+            name: 'takerAddress',
+            type: 'address'
+          },
+          {
+            internalType: 'address',
+            name: 'feeRecipientAddress',
+            type: 'address'
+          },
+          {
+            internalType: 'address',
+            name: 'senderAddress',
+            type: 'address'
+          },
+          {
+            internalType: 'uint256',
+            name: 'makerAssetAmount',
+            type: 'uint256'
+          },
+          {
+            internalType: 'uint256',
+            name: 'takerAssetAmount',
+            type: 'uint256'
+          },
+          {
+            internalType: 'uint256',
+            name: 'makerFee',
+            type: 'uint256'
+          },
+          {
+            internalType: 'uint256',
+            name: 'takerFee',
+            type: 'uint256'
+          },
+          {
+            internalType: 'uint256',
+            name: 'expirationTimeSeconds',
+            type: 'uint256'
+          },
+          {
+            internalType: 'uint256',
+            name: 'salt',
+            type: 'uint256'
+          },
+          {
+            internalType: 'bytes',
+            name: 'makerAssetData',
+            type: 'bytes'
+          },
+          {
+            internalType: 'bytes',
+            name: 'takerAssetData',
+            type: 'bytes'
+          },
+          {
+            internalType: 'bytes',
+            name: 'makerFeeAssetData',
+            type: 'bytes'
+          },
+          {
+            internalType: 'bytes',
+            name: 'takerFeeAssetData',
+            type: 'bytes'
+          }
+        ],
+        internalType: 'struct IEIP1271Data.Order',
+        name: 'order',
+        type: 'tuple'
+      },
+      {
+        internalType: 'bytes32',
+        name: 'orderHash',
+        type: 'bytes32'
+      }
+    ],
+    name: 'OrderWithHash',
+    outputs: [],
+    stateMutability: 'pure',
+    type: 'function'
+  }
+]

package/src/utils/index.ts

@@ -113,7 +113,13 @@ export class WalletUtils {
     walletContext?: WalletContext
   ): Promise<WalletConfig> => {
     walletContext = walletContext || (await this.wallet.getWalletContext())
-    return recoverWalletConfig(address, encodeMessageDigest(prefixEIP191Message(message)), signature, chainId, walletContext)
+    return recoverWalletConfig(
+      address,
+      encodeMessageDigest(prefixEIP191Message(message)),
+      signature,
+      chainId,
+      walletContext
+    )
   }
 
   // Recover the WalletConfig from a signature of a typedData object

package/src/utils.ts

@@ -4,6 +4,7 @@ import { WalletConfig, addressOf, DecodedSignature, isConfigEqual } from '@0xseq
 import { packMessageData, encodeMessageDigest, TypedData, encodeTypedDataDigest } from '@0xsequence/utils'
 import { Web3Provider } from './provider'
 import { isValidSignature as _isValidSignature, recoverConfig, Signer } from '@0xsequence/wallet'
+import { messageIsExemptFromEIP191Prefix } from './eip191exceptions'
 
 const eip191prefix = ethers.utils.toUtf8Bytes('\x19Ethereum Signed Message:\n')
 
@@ -17,7 +18,11 @@ export const messageToBytes = (message: BytesLike): Uint8Array => {
 
 export const prefixEIP191Message = (message: BytesLike): Uint8Array => {
   const messageBytes = messageToBytes(message)
-  return ethers.utils.concat([eip191prefix, ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes])
+  if (messageIsExemptFromEIP191Prefix(messageBytes)) {
+    return messageBytes
+  } else {
+    return ethers.utils.concat([eip191prefix, ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes])
+  }
 }
 
 export const isValidSignature = async (