@0xsequence/provider 0.33.3 → 0.35.1

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @0xsequence/provider
 
+## 0.35.1
+
+### Patch Changes
+
+- wallet: update config on undeployed too
+- Updated dependencies
+  - @0xsequence/abi@0.35.1
+  - @0xsequence/auth@0.35.1
+  - @0xsequence/config@0.35.1
+  - @0xsequence/network@0.35.1
+  - @0xsequence/transactions@0.35.1
+  - @0xsequence/utils@0.35.1
+  - @0xsequence/wallet@0.35.1
+
+## 0.35.0
+
+### Minor Changes
+
+- - config: add buildStubSignature
+  - provider: add checks to signing cases for wallet deployment and config statuses
+  - provider: add prompt for wallet deployment
+  - relayer: add BaseRelayer.prependWalletDeploy
+  - relayer: add Relayer.feeOptions
+  - relayer: account for wallet deployment in fee estimation
+  - transactions: add fromTransactionish
+  - wallet: add Account.prependConfigUpdate
+  - wallet: add Account.getFeeOptions
+
+### Patch Changes
+
+- Updated dependencies
+  - @0xsequence/abi@0.35.0
+  - @0xsequence/auth@0.35.0
+  - @0xsequence/config@0.35.0
+  - @0xsequence/network@0.35.0
+  - @0xsequence/transactions@0.35.0
+  - @0xsequence/utils@0.35.0
+  - @0xsequence/wallet@0.35.0
+
+## 0.34.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @0xsequence/auth@0.34.1
+
+## 0.34.0
+
+### Minor Changes
+
+- - upgrade deps
+
+### Patch Changes
+
+- Updated dependencies
+  - @0xsequence/abi@0.34.0
+  - @0xsequence/auth@0.34.0
+  - @0xsequence/config@0.34.0
+  - @0xsequence/network@0.34.0
+  - @0xsequence/transactions@0.34.0
+  - @0xsequence/utils@0.34.0
+  - @0xsequence/wallet@0.34.0
+
 ## 0.33.3
 
 ### Patch Changes

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) {
@@ -1733,37 +1780,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) {
-
-              if (_this.prompter === null) {
-                // 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
-                });
-              }
+              let message; // there is a difference in the order of the params:
+              // personal_sign: [data, address]
+              // eth_sign: [address, data]
 
-              if (sig && sig.length > 0) {
-                response.result = sig;
+              if (request.method === 'personal_sign') {
+                const [data, address] = request.params;
+                message = data;
               } else {
-                // The user has declined the request when value is null
-                throw new Error('declined by user');
+                const [address, data] = request.params;
+                message = data;
               }
 
-              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 +1802,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 +1848,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 +2383,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 +3646,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) {
@@ -1733,37 +1780,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) {
-
-              if (_this.prompter === null) {
-                // 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
-                });
-              }
+              let message; // there is a difference in the order of the params:
+              // personal_sign: [data, address]
+              // eth_sign: [address, data]
 
-              if (sig && sig.length > 0) {
-                response.result = sig;
+              if (request.method === 'personal_sign') {
+                const [data, address] = request.params;
+                message = data;
               } else {
-                // The user has declined the request when value is null
-                throw new Error('declined by user');
+                const [address, data] = request.params;
+                message = data;
               }
 
-              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 +1802,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 +1848,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 +2383,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 +3646,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.esm.js

@@ -1,7 +1,7 @@
 import { EventEmitter2 } from 'eventemitter2';
 import { logger, packMessageData, sanitizeNumberString, sanitizeHost, sanitizeAlphanumeric, base64EncodeObject, base64DecodeObject, shallowCopy, resolveProperties, encodeMessageDigest, encodeTypedDataDigest } from '@0xsequence/utils';
 import { ethers, BigNumber } from 'ethers';
-import { addressOf } from '@0xsequence/config';
+import { addressOf, isConfigEqual } from '@0xsequence/config';
 import { isValidSignature as isValidSignature$1, recoverConfig, Signer, resolveArrayProperties } from '@0xsequence/wallet';
 import { isSignedTransactions } from '@0xsequence/transactions';
 import { signAuthorization } from '@0xsequence/auth';
@@ -490,7 +490,54 @@ const recoverWalletConfig = async (address, digest, signature, chainId, walletCo
 
   return config;
 };
-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 = isConfigEqual(authChainConfig, requiredChainConfig);
+  return isDeployed && isUpToDate;
+}; // window.localstorage helper
 
 class LocalStore {
   constructor(key, def) {
@@ -1729,37 +1776,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) {
-
-              if (_this.prompter === null) {
-                // prompter is null, so we'll sign from here
-                sig = await signer.signMessage(ethers.utils.arrayify(message), chainId);
-              } else {
-                // prompt user to provide the response
-                sig = await _this.prompter.promptSignMessage({
-                  chainId: chainId,
-                  message: message
-                });
-              }
+              let message; // there is a difference in the order of the params:
+              // personal_sign: [data, address]
+              // eth_sign: [address, data]
 
-              if (sig && sig.length > 0) {
-                response.result = sig;
+              if (request.method === 'personal_sign') {
+                const [data, address] = request.params;
+                message = data;
               } else {
-                // The user has declined the request when value is null
-                throw new Error('declined by user');
+                const [address, data] = request.params;
+                message = data;
               }
 
-              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) {
 
@@ -1767,11 +1798,14 @@ class WalletRequestHandler {
                 // prompter is null, so we'll sign from here
                 sig = await signer.signMessage(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) {
@@ -1810,11 +1844,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) {
@@ -2342,6 +2379,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) {
+        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'];
 
@@ -3549,4 +3615,4 @@ const DefaultProviderConfig = {
   }
 };
 
-export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStore, LocalWeb3Provider, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, Wallet, WalletRequestHandler, Web3Provider, Web3Signer, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, isBrowserExtension, isSequenceProvider, isValidSignature, nextMessageIdx, recoverWalletConfig };
+export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStore, LocalWeb3Provider, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, Wallet, WalletRequestHandler, Web3Provider, Web3Signer, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, isBrowserExtension, isSequenceProvider, isValidSignature, isWalletUpToDate, nextMessageIdx, recoverWalletConfig };

package/dist/declarations/src/transports/wallet-request-handler.d.ts

@@ -42,8 +42,10 @@ export declare class WalletRequestHandler implements ExternalProvider, JsonRpcHa
     isSignedIn(): boolean;
     getSigner(): Signer | null;
     setSigner(signer: Signer | null): void;
+    private handleConfirmWalletDeployPrompt;
 }
 export interface WalletUserPrompter {
+    promptConfirmWalletDeploy(chainId: number): Promise<boolean>;
     promptConnect(options?: ConnectOptions): Promise<PromptConnectDetails>;
     promptSignMessage(message: MessageToSign): Promise<string>;
     promptSignTransaction(txn: TransactionRequest, chaindId?: number): Promise<string>;

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

@@ -2,9 +2,18 @@ import { BigNumberish, BytesLike } from 'ethers';
 import { WalletContext } from '@0xsequence/network';
 import { WalletConfig, DecodedSignature } from '@0xsequence/config';
 import { Web3Provider } from './provider';
+import { Signer } from '@0xsequence/wallet';
 export declare const isValidSignature: (address: string, digest: Uint8Array, sig: string, provider: Web3Provider, chainId?: number | undefined, walletContext?: WalletContext | undefined) => Promise<boolean | undefined>;
 export declare const recoverWalletConfig: (address: string, digest: BytesLike, signature: string | DecodedSignature, chainId: BigNumberish, walletContext?: WalletContext | undefined) => Promise<WalletConfig>;
 export declare const isBrowserExtension: () => boolean;
+/**
+ * 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
+ */
+export declare const isWalletUpToDate: (signer: Signer, chainId: number) => Promise<boolean>;
 export declare class LocalStore<T extends Object = string> {
     def?: T | undefined;
     readonly key: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.33.3",
+  "version": "0.35.1",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -13,18 +13,18 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@0xsequence/abi": "^0.31.0",
-    "@0xsequence/auth": "^0.33.3",
-    "@0xsequence/config": "^0.31.0",
-    "@0xsequence/network": "^0.31.0",
-    "@0xsequence/transactions": "^0.33.2",
-    "@0xsequence/utils": "^0.31.0",
-    "@0xsequence/wallet": "^0.33.3",
+    "@0xsequence/abi": "^0.35.1",
+    "@0xsequence/auth": "^0.35.1",
+    "@0xsequence/config": "^0.35.1",
+    "@0xsequence/network": "^0.35.1",
+    "@0xsequence/transactions": "^0.35.1",
+    "@0xsequence/utils": "^0.35.1",
+    "@0xsequence/wallet": "^0.35.1",
     "@ethersproject/abstract-signer": "^5.5.0",
     "@ethersproject/hash": "^5.5.0",
-    "@ethersproject/providers": "^5.5.0",
-    "@ethersproject/web": "^5.5.0",
-    "ethers": "^5.5.1",
+    "@ethersproject/providers": "^5.5.1",
+    "@ethersproject/web": "^5.5.1",
+    "ethers": "^5.5.2",
     "eventemitter2": "^6.4.5",
     "webextension-polyfill-ts": "^0.26.0"
   },

package/src/transports/wallet-request-handler.ts

@@ -1,10 +1,8 @@
 import { EventEmitter2 as EventEmitter } from 'eventemitter2'
 
 import {
-  ProviderMessage,
   ProviderMessageRequest,
   ProviderMessageResponse,
-  ProviderMessageResponseCallback,
   ProviderMessageRequestHandler,
   MessageToSign,
   ProviderRpcError,
@@ -18,7 +16,7 @@ import {
 } from '../types'
 
 import { BigNumber, ethers } from 'ethers'
-import { JsonRpcProvider, ExternalProvider } from '@ethersproject/providers'
+import { ExternalProvider } from '@ethersproject/providers'
 
 import {
   Networks,
@@ -28,14 +26,13 @@ import {
   JsonRpcResponseCallback,
   JsonRpcResponse
 } from '@0xsequence/network'
-
-import { Signer, Account } from '@0xsequence/wallet'
-import { isSignedTransactions, SignedTransactions, TransactionRequest } from '@0xsequence/transactions'
-
+import { Signer } from '@0xsequence/wallet'
+import { isSignedTransactions, TransactionRequest } from '@0xsequence/transactions'
 import { signAuthorization, AuthorizationOptions } from '@0xsequence/auth'
-
 import { logger, TypedData } from '@0xsequence/utils'
 
+import { isWalletUpToDate } from '../utils'
+
 export interface WalletSignInOptions {
   connect?: boolean
   mainnetNetworks?: Networks
@@ -252,43 +249,34 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
           break
         }
 
-        case 'personal_sign': {
+        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) {
-          if (this.prompter === null) {
-            // prompter is null, so we'll sign from here
-            sig = await signer.signMessage(ethers.utils.arrayify(message), chainId)
+          let message: any
+
+          // there is a difference in the order of the params:
+          // personal_sign: [data, address]
+          // eth_sign: [address, data]
+          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) {
           if (this.prompter === null) {
             // prompter is null, so we'll sign from here
             sig = await signer.signMessage(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) {
@@ -320,12 +308,15 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
           }
 
           let sig = ''
+
           if (this.prompter === null) {
             // 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) {
@@ -698,9 +689,38 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
   setSigner(signer: Signer | null) {
     this.signer = signer
   }
+
+  private async handleConfirmWalletDeployPrompt(
+    prompter: WalletUserPrompter,
+    signer: Signer,
+    chainId?: number
+  ): Promise<boolean> {
+    // 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) {
+        logger.error('WalletRequestHandler: result for promptConfirmWalletDeploy is not correct')
+        return false
+      } else {
+        return true
+      }
+    }
+    return false
+  }
 }
 
 export interface WalletUserPrompter {
+  promptConfirmWalletDeploy(chainId: number): Promise<boolean>
   promptConnect(options?: ConnectOptions): Promise<PromptConnectDetails>
   promptSignMessage(message: MessageToSign): Promise<string>
   promptSignTransaction(txn: TransactionRequest, chaindId?: number): Promise<string>

package/src/utils.ts

@@ -1,9 +1,9 @@
 import { BigNumberish, BytesLike } from 'ethers'
 import { WalletContext } from '@0xsequence/network'
-import { WalletConfig, addressOf, DecodedSignature } from '@0xsequence/config'
+import { WalletConfig, addressOf, DecodedSignature, isConfigEqual } from '@0xsequence/config'
 import { packMessageData } from '@0xsequence/utils'
 import { Web3Provider } from './provider'
-import { isValidSignature as _isValidSignature, recoverConfig } from '@0xsequence/wallet'
+import { isValidSignature as _isValidSignature, recoverConfig, Signer } from '@0xsequence/wallet'
 
 export const isValidSignature = async (
   address: string,
@@ -13,15 +13,15 @@ export const isValidSignature = async (
   chainId?: number,
   walletContext?: WalletContext
 ): Promise<boolean | undefined> => {
-  chainId = chainId || await provider.getChainId()
-  walletContext = walletContext || await provider.getSigner().getWalletContext()
+  chainId = chainId || (await provider.getChainId())
+  walletContext = walletContext || (await provider.getSigner().getWalletContext())
   return _isValidSignature(address, digest, sig, provider, walletContext, chainId)
 }
 
 export const recoverWalletConfig = async (
   address: string,
   digest: BytesLike,
-  signature: string | DecodedSignature,
+  signature: string | DecodedSignature,
   chainId: BigNumberish,
   walletContext?: WalletContext
 ): Promise<WalletConfig> => {
@@ -40,7 +40,48 @@ export const recoverWalletConfig = async (
   return config
 }
 
-export const isBrowserExtension = (): boolean => window.location.protocol === 'chrome-extension:' || window.location.protocol === 'moz-extension:'
+export const isBrowserExtension = (): boolean =>
+  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
+ */
+export const isWalletUpToDate = async (signer: Signer, chainId: number): Promise<boolean> => {
+  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(state => state.chainId === authChainId)?.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 = isConfigEqual(authChainConfig, requiredChainConfig)
+
+  return isDeployed && isUpToDate
+}
 
 // window.localstorage helper
 export class LocalStore<T extends Object = string> {