@0xsequence/provider 0.34.1 → 0.35.3

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

@@ -494,7 +494,54 @@ const recoverWalletConfig = async (address, digest, signature, chainId, walletCo
 
   return config$1;
 };
-const isBrowserExtension = () => window.location.protocol === 'chrome-extension:' || window.location.protocol === 'moz-extension:'; // window.localstorage helper
+const isBrowserExtension = () => window.location.protocol === 'chrome-extension:' || window.location.protocol === 'moz-extension:';
+/**
+ * Returns the status of a signer's wallet on given chain by checking wallet deployment and config status
+ *
+ * @param {Signer} signer
+ * @param {number} chainId
+ * @return {Promise<boolean>} Promise that returns true if the wallet is up to date, false otherwise
+ */
+
+const isWalletUpToDate = async (signer, chainId) => {
+  var _walletState$find;
+
+  const walletState = await signer.getWalletState();
+  const networks = await signer.getNetworks();
+  const walletStateForRequiredChain = walletState.find(state => state.chainId === chainId);
+
+  if (!walletStateForRequiredChain) {
+    throw new Error(`WalletRequestHandler: could not find wallet state for chainId ${chainId}`);
+  }
+
+  const isDeployed = walletStateForRequiredChain.deployed;
+
+  if (!networks) {
+    throw new Error(`isWalletUpToDate util: could not get networks from signer`);
+  }
+
+  const authChain = networks.find(network => network.isAuthChain);
+
+  if (!authChain) {
+    throw new Error(`isWalletUpToDate util: could not get auth chain network information`);
+  }
+
+  const authChainId = authChain.chainId;
+  const authChainConfig = (_walletState$find = walletState.find(state => state.chainId === authChainId)) == null ? void 0 : _walletState$find.config;
+
+  if (!authChainConfig) {
+    throw new Error(`isWalletUpToDate util: could not get auth chain config`);
+  }
+
+  const requiredChainConfig = walletStateForRequiredChain.config;
+
+  if (!requiredChainConfig) {
+    throw new Error(`isWalletUpToDate util: could not get config for chainId ${chainId}`);
+  }
+
+  const isUpToDate = config.isConfigEqual(authChainConfig, requiredChainConfig);
+  return isDeployed && isUpToDate;
+}; // window.localstorage helper
 
 class LocalStore {
   constructor(key, def) {
@@ -1403,8 +1450,20 @@ class WindowMessageProvider extends BaseProviderTransport {
       } // Open popup window on center of the app window
 
 
-      const windowSize = [450, 750];
-      const windowPos = [Math.abs(window.screenX + window.innerWidth / 2 - windowSize[0] / 2), Math.abs(window.screenY + window.innerHeight / 2 - windowSize[1] / 2)];
+      let windowSize;
+      let windowPos;
+
+      if (isBrowserExtension()) {
+        windowSize = [450, 750];
+        windowPos = [window.screenX, window.screenY]; // windowPos = [
+        //   Math.abs(window.screen.width / 2 - windowSize[0] / 2),
+        //   Math.abs(window.screen.height / 2 - windowSize[1] / 2)
+        // ]
+      } else {
+        windowSize = [450, 750];
+        windowPos = [Math.abs(window.screenX + window.innerWidth / 2 - windowSize[0] / 2), Math.abs(window.screenY + window.innerHeight / 2 - windowSize[1] / 2)];
+      }
+
       const windowFeatures = `toolbar=0,location=0,menubar=0,scrollbars=yes,status=yes` + `,width=${windowSize[0]},height=${windowSize[1]}` + `,left=${windowPos[0]},top=${windowPos[1]}`; // serialize params
 
       walletURL.search = windowSessionParams.toString();
@@ -1536,7 +1595,7 @@ class WindowMessageHandler extends BaseWalletTransport {
     this._init = exports.InitState.NIL;
   }
 
-  register() {
+  register(windowHref) {
     const isPopup = parent.window.opener !== null;
     this._isPopup = isPopup;
 
@@ -1548,7 +1607,7 @@ class WindowMessageHandler extends BaseWalletTransport {
     const {
       pathname,
       search: rawParams
-    } = new URL(window.location.href);
+    } = new URL(windowHref || window.location.href);
     let session = this.getWindowTransportSession(rawParams); // provider should always include sid when opening a new window
 
     const isNewWindowSession = !!session.sessionId; // attempt to restore previous session in the case of a redirect or window reload
@@ -1733,37 +1792,21 @@ class WalletRequestHandler {
             }
 
           case 'personal_sign':
+          case 'eth_sign':
             {
               // note: message from json-rpc input is in hex format
-              const [message, signingAddress] = request.params;
-              let sig = ''; // TODO:
-              // if (process.env.TEST_MODE === 'true' && this.prompter === null) {
+              let message; // there is a difference in the order of the params:
+              // personal_sign: [data, address]
+              // eth_sign: [address, data]
 
-              if (_this.prompter === null) {
-                // prompter is null, so we'll sign from here
-                sig = await signer.signMessage(ethers.ethers.utils.arrayify(message), chainId);
+              if (request.method === 'personal_sign') {
+                const [data, address] = request.params;
+                message = data;
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  message: message
-                });
+                const [address, data] = request.params;
+                message = data;
               }
 
-              if (sig && sig.length > 0) {
-                response.result = sig;
-              } else {
-                // The user has declined the request when value is null
-                throw new Error('declined by user');
-              }
-
-              break;
-            }
-
-          case 'eth_sign':
-            {
-              // note: message from json-rpc input is in hex format
-              const [signingAddress, message] = request.params;
               let sig = ''; // TODO:
               // if (process.env.TEST_MODE === 'true' && this.prompter === null) {
 
@@ -1771,11 +1814,14 @@ class WalletRequestHandler {
                 // prompter is null, so we'll sign from here
                 sig = await signer.signMessage(ethers.ethers.utils.arrayify(message), chainId);
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  message: message
-                });
+                const promptResultForDeployment = await _this.handleConfirmWalletDeployPrompt(_this.prompter, signer, chainId);
+
+                if (promptResultForDeployment) {
+                  sig = await _this.prompter.promptSignMessage({
+                    chainId: chainId,
+                    message: message
+                  });
+                }
               }
 
               if (sig && sig.length > 0) {
@@ -1814,11 +1860,14 @@ class WalletRequestHandler {
                 // prompter is null, so we'll sign from here
                 sig = await signer.signTypedData(typedData.domain, typedData.types, typedData.message, chainId);
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  typedData: typedData
-                });
+                const promptResultForDeployment = await _this.handleConfirmWalletDeployPrompt(_this.prompter, signer, chainId);
+
+                if (promptResultForDeployment) {
+                  sig = await _this.prompter.promptSignMessage({
+                    chainId: chainId,
+                    typedData: typedData
+                  });
+                }
               }
 
               if (sig && sig.length > 0) {
@@ -2346,6 +2395,35 @@ class WalletRequestHandler {
     this.signer = signer;
   }
 
+  async handleConfirmWalletDeployPrompt(prompter, signer, chainId) {
+    // check if wallet is deployed and up to date, if not, prompt user to deploy
+    // if no chainId is provided, we'll assume the wallet is auth chain wallet and is up to date
+    if (!chainId) {
+      return true;
+    }
+
+    const isUpToDate = await isWalletUpToDate(signer, chainId);
+
+    if (isUpToDate) {
+      return true;
+    }
+
+    const promptResult = await prompter.promptConfirmWalletDeploy(chainId); // if client returned true, check again to make sure wallet is deployed and up to date
+
+    if (promptResult) {
+      const isPromptResultCorrect = await isWalletUpToDate(signer, chainId);
+
+      if (!isPromptResultCorrect) {
+        utils.logger.error('WalletRequestHandler: result for promptConfirmWalletDeploy is not correct');
+        return false;
+      } else {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
 }
 const permittedJsonRpcMethods = ['net_version', 'eth_chainId', 'eth_getBalance', 'eth_getTransactionCount', 'eth_blockNumber', 'eth_getBlockByNumber', 'eth_getBlockByHash', 'eth_getTransactionByHash', 'eth_getCode', 'eth_estimateGas', 'eth_gasPrice', 'sequence_getWalletContext', 'sequence_getNetworks', 'sequence_setDefaultNetwork'];
 
@@ -3580,5 +3658,6 @@ exports.WindowSessionParams = WindowSessionParams;
 exports.isBrowserExtension = isBrowserExtension;
 exports.isSequenceProvider = isSequenceProvider;
 exports.isValidSignature = isValidSignature;
+exports.isWalletUpToDate = isWalletUpToDate;
 exports.nextMessageIdx = nextMessageIdx;
 exports.recoverWalletConfig = recoverWalletConfig;

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

@@ -494,7 +494,54 @@ const recoverWalletConfig = async (address, digest, signature, chainId, walletCo
 
   return config$1;
 };
-const isBrowserExtension = () => window.location.protocol === 'chrome-extension:' || window.location.protocol === 'moz-extension:'; // window.localstorage helper
+const isBrowserExtension = () => window.location.protocol === 'chrome-extension:' || window.location.protocol === 'moz-extension:';
+/**
+ * Returns the status of a signer's wallet on given chain by checking wallet deployment and config status
+ *
+ * @param {Signer} signer
+ * @param {number} chainId
+ * @return {Promise<boolean>} Promise that returns true if the wallet is up to date, false otherwise
+ */
+
+const isWalletUpToDate = async (signer, chainId) => {
+  var _walletState$find;
+
+  const walletState = await signer.getWalletState();
+  const networks = await signer.getNetworks();
+  const walletStateForRequiredChain = walletState.find(state => state.chainId === chainId);
+
+  if (!walletStateForRequiredChain) {
+    throw new Error(`WalletRequestHandler: could not find wallet state for chainId ${chainId}`);
+  }
+
+  const isDeployed = walletStateForRequiredChain.deployed;
+
+  if (!networks) {
+    throw new Error(`isWalletUpToDate util: could not get networks from signer`);
+  }
+
+  const authChain = networks.find(network => network.isAuthChain);
+
+  if (!authChain) {
+    throw new Error(`isWalletUpToDate util: could not get auth chain network information`);
+  }
+
+  const authChainId = authChain.chainId;
+  const authChainConfig = (_walletState$find = walletState.find(state => state.chainId === authChainId)) == null ? void 0 : _walletState$find.config;
+
+  if (!authChainConfig) {
+    throw new Error(`isWalletUpToDate util: could not get auth chain config`);
+  }
+
+  const requiredChainConfig = walletStateForRequiredChain.config;
+
+  if (!requiredChainConfig) {
+    throw new Error(`isWalletUpToDate util: could not get config for chainId ${chainId}`);
+  }
+
+  const isUpToDate = config.isConfigEqual(authChainConfig, requiredChainConfig);
+  return isDeployed && isUpToDate;
+}; // window.localstorage helper
 
 class LocalStore {
   constructor(key, def) {
@@ -1403,8 +1450,20 @@ class WindowMessageProvider extends BaseProviderTransport {
       } // Open popup window on center of the app window
 
 
-      const windowSize = [450, 750];
-      const windowPos = [Math.abs(window.screenX + window.innerWidth / 2 - windowSize[0] / 2), Math.abs(window.screenY + window.innerHeight / 2 - windowSize[1] / 2)];
+      let windowSize;
+      let windowPos;
+
+      if (isBrowserExtension()) {
+        windowSize = [450, 750];
+        windowPos = [window.screenX, window.screenY]; // windowPos = [
+        //   Math.abs(window.screen.width / 2 - windowSize[0] / 2),
+        //   Math.abs(window.screen.height / 2 - windowSize[1] / 2)
+        // ]
+      } else {
+        windowSize = [450, 750];
+        windowPos = [Math.abs(window.screenX + window.innerWidth / 2 - windowSize[0] / 2), Math.abs(window.screenY + window.innerHeight / 2 - windowSize[1] / 2)];
+      }
+
       const windowFeatures = `toolbar=0,location=0,menubar=0,scrollbars=yes,status=yes` + `,width=${windowSize[0]},height=${windowSize[1]}` + `,left=${windowPos[0]},top=${windowPos[1]}`; // serialize params
 
       walletURL.search = windowSessionParams.toString();
@@ -1536,7 +1595,7 @@ class WindowMessageHandler extends BaseWalletTransport {
     this._init = exports.InitState.NIL;
   }
 
-  register() {
+  register(windowHref) {
     const isPopup = parent.window.opener !== null;
     this._isPopup = isPopup;
 
@@ -1548,7 +1607,7 @@ class WindowMessageHandler extends BaseWalletTransport {
     const {
       pathname,
       search: rawParams
-    } = new URL(window.location.href);
+    } = new URL(windowHref || window.location.href);
     let session = this.getWindowTransportSession(rawParams); // provider should always include sid when opening a new window
 
     const isNewWindowSession = !!session.sessionId; // attempt to restore previous session in the case of a redirect or window reload
@@ -1733,37 +1792,21 @@ class WalletRequestHandler {
             }
 
           case 'personal_sign':
+          case 'eth_sign':
             {
               // note: message from json-rpc input is in hex format
-              const [message, signingAddress] = request.params;
-              let sig = ''; // TODO:
-              // if (process.env.TEST_MODE === 'true' && this.prompter === null) {
+              let message; // there is a difference in the order of the params:
+              // personal_sign: [data, address]
+              // eth_sign: [address, data]
 
-              if (_this.prompter === null) {
-                // prompter is null, so we'll sign from here
-                sig = await signer.signMessage(ethers.ethers.utils.arrayify(message), chainId);
+              if (request.method === 'personal_sign') {
+                const [data, address] = request.params;
+                message = data;
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  message: message
-                });
+                const [address, data] = request.params;
+                message = data;
               }
 
-              if (sig && sig.length > 0) {
-                response.result = sig;
-              } else {
-                // The user has declined the request when value is null
-                throw new Error('declined by user');
-              }
-
-              break;
-            }
-
-          case 'eth_sign':
-            {
-              // note: message from json-rpc input is in hex format
-              const [signingAddress, message] = request.params;
               let sig = ''; // TODO:
               // if (process.env.TEST_MODE === 'true' && this.prompter === null) {
 
@@ -1771,11 +1814,14 @@ class WalletRequestHandler {
                 // prompter is null, so we'll sign from here
                 sig = await signer.signMessage(ethers.ethers.utils.arrayify(message), chainId);
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  message: message
-                });
+                const promptResultForDeployment = await _this.handleConfirmWalletDeployPrompt(_this.prompter, signer, chainId);
+
+                if (promptResultForDeployment) {
+                  sig = await _this.prompter.promptSignMessage({
+                    chainId: chainId,
+                    message: message
+                  });
+                }
               }
 
               if (sig && sig.length > 0) {
@@ -1814,11 +1860,14 @@ class WalletRequestHandler {
                 // prompter is null, so we'll sign from here
                 sig = await signer.signTypedData(typedData.domain, typedData.types, typedData.message, chainId);
               } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  typedData: typedData
-                });
+                const promptResultForDeployment = await _this.handleConfirmWalletDeployPrompt(_this.prompter, signer, chainId);
+
+                if (promptResultForDeployment) {
+                  sig = await _this.prompter.promptSignMessage({
+                    chainId: chainId,
+                    typedData: typedData
+                  });
+                }
               }
 
               if (sig && sig.length > 0) {
@@ -2346,6 +2395,35 @@ class WalletRequestHandler {
     this.signer = signer;
   }
 
+  async handleConfirmWalletDeployPrompt(prompter, signer, chainId) {
+    // check if wallet is deployed and up to date, if not, prompt user to deploy
+    // if no chainId is provided, we'll assume the wallet is auth chain wallet and is up to date
+    if (!chainId) {
+      return true;
+    }
+
+    const isUpToDate = await isWalletUpToDate(signer, chainId);
+
+    if (isUpToDate) {
+      return true;
+    }
+
+    const promptResult = await prompter.promptConfirmWalletDeploy(chainId); // if client returned true, check again to make sure wallet is deployed and up to date
+
+    if (promptResult) {
+      const isPromptResultCorrect = await isWalletUpToDate(signer, chainId);
+
+      if (!isPromptResultCorrect) {
+        utils.logger.error('WalletRequestHandler: result for promptConfirmWalletDeploy is not correct');
+        return false;
+      } else {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
 }
 const permittedJsonRpcMethods = ['net_version', 'eth_chainId', 'eth_getBalance', 'eth_getTransactionCount', 'eth_blockNumber', 'eth_getBlockByNumber', 'eth_getBlockByHash', 'eth_getTransactionByHash', 'eth_getCode', 'eth_estimateGas', 'eth_gasPrice', 'sequence_getWalletContext', 'sequence_getNetworks', 'sequence_setDefaultNetwork'];
 
@@ -3580,5 +3658,6 @@ exports.WindowSessionParams = WindowSessionParams;
 exports.isBrowserExtension = isBrowserExtension;
 exports.isSequenceProvider = isSequenceProvider;
 exports.isValidSignature = isValidSignature;
+exports.isWalletUpToDate = isWalletUpToDate;
 exports.nextMessageIdx = nextMessageIdx;
 exports.recoverWalletConfig = recoverWalletConfig;