@0xsequence/provider 0.30.0 → 0.33.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @0xsequence/provider
 
+## 0.33.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @0xsequence/auth@0.33.0
+
+## 0.31.3
+
+### Patch Changes
+
+- @0xsequence/auth@0.31.3
+
+## 0.31.1
+
+### Patch Changes
+
+- @0xsequence/wallet@0.31.1
+- @0xsequence/auth@0.31.1
+
+## 0.31.0
+
+### Minor Changes
+
+- - upgrading to ethers v5.5
+
+### Patch Changes
+
+- Updated dependencies
+  - @0xsequence/abi@0.31.0
+  - @0xsequence/auth@0.31.0
+  - @0xsequence/config@0.31.0
+  - @0xsequence/network@0.31.0
+  - @0xsequence/transactions@0.31.0
+  - @0xsequence/utils@0.31.0
+  - @0xsequence/wallet@0.31.0
+
 ## 0.30.0
 
 ### Minor Changes

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

@@ -1732,6 +1732,34 @@ class WalletRequestHandler {
               break;
             }
 
+          case 'personal_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
+                });
+              }
+
+              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
@@ -2650,9 +2678,11 @@ class Web3Signer extends wallet.Signer {
   async signMessage(message, chainId, allSigners) {
     const provider = await this.getSender(network.maybeChainId(chainId) || this.defaultChainId);
     const data = typeof message === 'string' ? ethers.ethers.utils.toUtf8Bytes(message) : message;
-    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    const address = await this.getAddress(); // NOTE: as of ethers v5.5, it switched to using personal_sign, see
+    // https://github.com/ethers-io/ethers.js/pull/1542 and see
+    // https://github.com/WalletConnect/walletconnect-docs/issues/32 for additional info.
 
-    return await provider.send('eth_sign', [address, ethers.ethers.utils.hexlify(data)]);
+    return await provider.send('personal_sign', [ethers.ethers.utils.hexlify(data), address]);
   } // signTypedData matches implementation from ethers JsonRpcSigner for compatibility, but with
   // multi-chain support.
 
@@ -2760,6 +2790,15 @@ class Web3Signer extends wallet.Signer {
   //
 
 
+  async _legacySignMessage(message, chainId, allSigners) {
+    const provider = await this.getSender(network.maybeChainId(chainId) || this.defaultChainId);
+    const data = typeof message === 'string' ? ethers.ethers.utils.toUtf8Bytes(message) : message;
+    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    // NOTE: ethers since 5.5 has switched to using personal_sign, we should review, etc.
+
+    return await provider.send('eth_sign', [address, ethers.ethers.utils.hexlify(data)]);
+  }
+
   async _signTypedData(domain, types, message, chainId, allSigners) {
     return this.signTypedData(domain, types, message, chainId, allSigners);
   }

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

@@ -1732,6 +1732,34 @@ class WalletRequestHandler {
               break;
             }
 
+          case 'personal_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
+                });
+              }
+
+              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
@@ -2650,9 +2678,11 @@ class Web3Signer extends wallet.Signer {
   async signMessage(message, chainId, allSigners) {
     const provider = await this.getSender(network.maybeChainId(chainId) || this.defaultChainId);
     const data = typeof message === 'string' ? ethers.ethers.utils.toUtf8Bytes(message) : message;
-    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    const address = await this.getAddress(); // NOTE: as of ethers v5.5, it switched to using personal_sign, see
+    // https://github.com/ethers-io/ethers.js/pull/1542 and see
+    // https://github.com/WalletConnect/walletconnect-docs/issues/32 for additional info.
 
-    return await provider.send('eth_sign', [address, ethers.ethers.utils.hexlify(data)]);
+    return await provider.send('personal_sign', [ethers.ethers.utils.hexlify(data), address]);
   } // signTypedData matches implementation from ethers JsonRpcSigner for compatibility, but with
   // multi-chain support.
 
@@ -2760,6 +2790,15 @@ class Web3Signer extends wallet.Signer {
   //
 
 
+  async _legacySignMessage(message, chainId, allSigners) {
+    const provider = await this.getSender(network.maybeChainId(chainId) || this.defaultChainId);
+    const data = typeof message === 'string' ? ethers.ethers.utils.toUtf8Bytes(message) : message;
+    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    // NOTE: ethers since 5.5 has switched to using personal_sign, we should review, etc.
+
+    return await provider.send('eth_sign', [address, ethers.ethers.utils.hexlify(data)]);
+  }
+
   async _signTypedData(domain, types, message, chainId, allSigners) {
     return this.signTypedData(domain, types, message, chainId, allSigners);
   }

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

@@ -1728,6 +1728,34 @@ class WalletRequestHandler {
               break;
             }
 
+          case 'personal_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
+                });
+              }
+
+              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
@@ -2646,9 +2674,11 @@ class Web3Signer extends Signer {
   async signMessage(message, chainId, allSigners) {
     const provider = await this.getSender(maybeChainId(chainId) || this.defaultChainId);
     const data = typeof message === 'string' ? ethers.utils.toUtf8Bytes(message) : message;
-    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    const address = await this.getAddress(); // NOTE: as of ethers v5.5, it switched to using personal_sign, see
+    // https://github.com/ethers-io/ethers.js/pull/1542 and see
+    // https://github.com/WalletConnect/walletconnect-docs/issues/32 for additional info.
 
-    return await provider.send('eth_sign', [address, ethers.utils.hexlify(data)]);
+    return await provider.send('personal_sign', [ethers.utils.hexlify(data), address]);
   } // signTypedData matches implementation from ethers JsonRpcSigner for compatibility, but with
   // multi-chain support.
 
@@ -2756,6 +2786,15 @@ class Web3Signer extends Signer {
   //
 
 
+  async _legacySignMessage(message, chainId, allSigners) {
+    const provider = await this.getSender(maybeChainId(chainId) || this.defaultChainId);
+    const data = typeof message === 'string' ? ethers.utils.toUtf8Bytes(message) : message;
+    const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    // NOTE: ethers since 5.5 has switched to using personal_sign, we should review, etc.
+
+    return await provider.send('eth_sign', [address, ethers.utils.hexlify(data)]);
+  }
+
   async _signTypedData(domain, types, message, chainId, allSigners) {
     return this.signTypedData(domain, types, message, chainId, allSigners);
   }

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

@@ -1,5 +1,5 @@
 import { ethers } from 'ethers';
-import { BytesLike } from '@ethersproject/bytes';
+import { BytesLike, Bytes } from '@ethersproject/bytes';
 import { Web3Provider as EthersWeb3Provider, JsonRpcProvider } from '@ethersproject/providers';
 import { TypedDataDomain, TypedDataField, TypedDataSigner } from '@ethersproject/abstract-signer';
 import { NetworkConfig, Networks, WalletContext, ChainIdLike, JsonRpcHandler, JsonRpcFetchFunc, JsonRpcRequest, JsonRpcResponseCallback, JsonRpcSender } from '@0xsequence/network';
@@ -52,6 +52,7 @@ export declare class Web3Signer extends Signer implements TypedDataSigner {
     updateConfig(newConfig?: WalletConfig): Promise<[WalletConfig, TransactionResponse | undefined]>;
     publishConfig(): Promise<TransactionResponse | undefined>;
     isDeployed(chainId?: ChainIdLike): Promise<boolean>;
+    _legacySignMessage(message: Bytes | string, chainId?: ChainIdLike, allSigners?: boolean): Promise<string>;
     _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, message: Record<string, any>, chainId?: ChainIdLike, allSigners?: boolean): Promise<string>;
     sendUncheckedTransaction(transaction: Deferrable<TransactionRequest>, chainId?: ChainIdLike): Promise<string>;
     connectUnchecked(): ethers.providers.JsonRpcSigner;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.30.0",
+  "version": "0.33.0",
   "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.30.0",
-    "@0xsequence/auth": "^0.30.0",
-    "@0xsequence/config": "^0.30.0",
-    "@0xsequence/network": "^0.30.0",
-    "@0xsequence/transactions": "^0.30.0",
-    "@0xsequence/utils": "^0.30.0",
-    "@0xsequence/wallet": "^0.30.0",
-    "@ethersproject/abstract-signer": "5.0.14",
-    "@ethersproject/hash": "^5.0.12",
-    "@ethersproject/providers": "^5.0.24",
-    "@ethersproject/web": "^5.0.14",
-    "ethers": "^5.0.32",
+    "@0xsequence/abi": "^0.31.0",
+    "@0xsequence/auth": "^0.33.0",
+    "@0xsequence/config": "^0.31.0",
+    "@0xsequence/network": "^0.31.0",
+    "@0xsequence/transactions": "^0.31.0",
+    "@0xsequence/utils": "^0.31.0",
+    "@0xsequence/wallet": "^0.31.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",
     "eventemitter2": "^6.4.5",
     "webextension-polyfill-ts": "^0.26.0"
   },

package/src/provider.ts

@@ -1,5 +1,5 @@
 import { ethers } from 'ethers'
-import { BytesLike } from '@ethersproject/bytes'
+import { BytesLike, Bytes } from '@ethersproject/bytes'
 import { Web3Provider as EthersWeb3Provider, ExternalProvider, JsonRpcProvider, Networkish } from '@ethersproject/providers'
 import { TypedDataDomain, TypedDataField, TypedDataSigner } from '@ethersproject/abstract-signer'
 import {
@@ -230,8 +230,10 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     const data = typeof message === 'string' ? ethers.utils.toUtf8Bytes(message) : message
     const address = await this.getAddress()
 
-    // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
-    return await provider!.send('eth_sign', [address, ethers.utils.hexlify(data)])
+    // NOTE: as of ethers v5.5, it switched to using personal_sign, see
+    // https://github.com/ethers-io/ethers.js/pull/1542 and see
+    // https://github.com/WalletConnect/walletconnect-docs/issues/32 for additional info.
+    return await provider!.send('personal_sign', [ethers.utils.hexlify(data), address])
   }
 
   // signTypedData matches implementation from ethers JsonRpcSigner for compatibility, but with
@@ -363,6 +365,17 @@ export class Web3Signer extends Signer implements TypedDataSigner {
   // ethers JsonRpcSigner methods
   //
 
+  async _legacySignMessage(message: Bytes | string, chainId?: ChainIdLike, allSigners?: boolean): Promise<string> {
+    const provider = await this.getSender(maybeChainId(chainId) || this.defaultChainId)
+
+    const data = typeof message === 'string' ? ethers.utils.toUtf8Bytes(message) : message
+    const address = await this.getAddress()
+
+    // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
+    // NOTE: ethers since 5.5 has switched to using personal_sign, we should review, etc.
+    return await provider!.send('eth_sign', [address, ethers.utils.hexlify(data)])
+  }
+
   async _signTypedData(
     domain: TypedDataDomain,
     types: Record<string, Array<TypedDataField>>,

package/src/transports/base-wallet-transport.ts

@@ -244,7 +244,7 @@ export abstract class BaseWalletTransport implements WalletTransport {
       return false
     }
 
-    const { sessionId, nonce } = (message.data as any) as { sessionId: string; nonce: string }
+    const { sessionId, nonce } = message.data as any as { sessionId: string; nonce: string }
     if (!sessionId || sessionId.length === 0 || !nonce || nonce.length === 0) {
       logger.error('invalid init ack')
       return false

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

@@ -252,6 +252,30 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
           break
         }
 
+        case 'personal_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 })
+          }
+
+          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!