deprecate use of ethers-eip712, instead use signTypedData methods from ethers direct

Author: pkieltyka

packages/0xsequence/tests/browser/window-transport/dapp.test.ts

@@ -3,8 +3,6 @@ import { ethers } from 'ethers'
 import { Web3Provider } from '@ethersproject/providers'
 import { test, assert } from '../../utils/assert'
 
-import { TypedDataUtils } from 'ethers-eip712'
-
 import { isValidSignature, packMessageData, recoverConfig } from '@0xsequence/wallet'
 import { addressOf } from '@0xsequence/config'
 import { testWalletContext } from '../testutils'
@@ -129,15 +127,9 @@ export const tests = async () => {
 
     const typedData = {
       types: {
-        EIP712Domain: [
-          {name: "name", type: "string"},
-          {name: "version", type: "string"},
-          {name: "chainId", type: "uint256"},
-          {name: "verifyingContract", type: "address"},
-        ],
         Person: [
           {name: "name", type: "string"},
-          {name: "wallet", type: "address"},  
+          {name: "wallet", type: "address"},
         ]
       },
       primaryType: 'Person' as const,
@@ -172,8 +164,9 @@ export const tests = async () => {
     //
     // Verify the message signature
     //
-    const message = TypedDataUtils.encodeDigest(typedData)
-    const messageDigest = ethers.utils.arrayify(ethers.utils.keccak256(message))
+
+    const messageHash = ethers.utils._TypedDataEncoder.hash(typedData.domain, typedData.types, typedData.message)
+    const messageDigest = ethers.utils.arrayify(ethers.utils.keccak256(messageHash))
     const isValid = await isValidSignature(address, messageDigest, sig, provider, testWalletContext, await signer.getChainId())
     assert.true(isValid, 'signature is valid')
 

packages/provider/package.json

@@ -18,11 +18,11 @@
     "@0xsequence/transactions": "^0.7.0",
     "@0xsequence/utils": "^0.7.0",
     "@0xsequence/wallet": "^0.7.0",
+    "@ethersproject/abstract-signer": "5.0.11",
     "@ethersproject/hash": "^5.0.10",
     "@ethersproject/providers": "^5.0.17",
     "@ethersproject/web": "^5.0.12",
     "ethers": "^5.0.24",
-    "ethers-eip712": "^0.2.0",
     "eventemitter3": "^4.0.7",
     "platform": "^1.3.6"
   },

packages/provider/src/types.ts

@@ -1,4 +1,5 @@
 import { NetworkConfig, JsonRpcRequest, JsonRpcResponse, JsonRpcHandler } from '@0xsequence/network'
+import { TypedDataDomain, TypedDataField }  from '@ethersproject/abstract-signer'
 
 // export class SequenceError extends Error {}
 
@@ -100,6 +101,10 @@ export interface MessageToSign {
   chainId?: number
 }
 
-// TODO: deprecate
-import { TypedData } from 'ethers-eip712'
-export type { TypedData }
+export interface TypedData {
+  domain: TypedDataDomain
+  types: Record<string, Array<TypedDataField>>
+  value: Record<string, any>
+}
+
+export type { TypedDataDomain, TypedDataField }

packages/wallet/package.json

@@ -26,7 +26,6 @@
     "@ethersproject/properties": "^5.0.7",
     "@ethersproject/providers": "^5.0.17",
     "ethers": "^5.0.24",
-    "ethers-eip712": "^0.2.0",
     "eventemitter3": "^4.0.6",
     "fetch-ponyfill": "^7.0.0"
   },

packages/wallet/tests/wallet.spec.ts

@@ -35,7 +35,6 @@ const Web3 = require('web3')
 const { expect } = chai.use(chaiAsPromised)
 
 import hardhat from 'hardhat'
-import { TypedDataUtils } from 'ethers-eip712'
 
 type EthereumInstance = {
   chainId?: number
@@ -153,12 +152,6 @@ describe('Wallet integration', function () {
       it('Should sign a typed message', async () => {
         const typedData = {
           types: {
-            EIP712Domain: [
-              { name: "name", type: "string" },
-              { name: "version", type: "string" },
-              { name: "chainId", type: "uint256" },
-              { name: "verifyingContract", type: "address" },
-            ],
             Person: [
               { name: "name", type: "string" },
               { name: "wallet", type: "address" },
@@ -177,7 +170,7 @@ describe('Wallet integration', function () {
           }
         }
 
-        const digest = TypedDataUtils.encodeDigest(typedData)
+        const digest = ethers.utils._TypedDataEncoder.hash(typedData.domain, typedData.types, typedData.message)
 
         const sig = await wallet.signTypedData(typedData.domain, typedData.types, typedData.message)
 

yarn.lock

@@ -1150,6 +1150,17 @@
     "@ethersproject/transactions" "^5.0.9"
     "@ethersproject/web" "^5.0.12"
 
+"@ethersproject/abstract-signer@5.0.11":
+  version "5.0.11"
+  resolved "https://registry.yarnpkg.com/@ethersproject/abstract-signer/-/abstract-signer-5.0.11.tgz#675da9ec168905c60ee79a6da95f7157ca956f46"
+  integrity sha512-RKOgPSEYafknA62SrD3OCK42AllHE4YBfKYXyQeM+sBP7Nq3X5FpzeoY4uzC43P4wIhmNoTHCKQuwnX7fBqb6Q==
+  dependencies:
+    "@ethersproject/abstract-provider" "^5.0.8"
+    "@ethersproject/bignumber" "^5.0.13"
+    "@ethersproject/bytes" "^5.0.9"
+    "@ethersproject/logger" "^5.0.8"
+    "@ethersproject/properties" "^5.0.7"
+
 "@ethersproject/abstract-signer@5.0.9", "@ethersproject/abstract-signer@^5.0.4", "@ethersproject/abstract-signer@^5.0.6":
   version "5.0.9"
   resolved "https://registry.yarnpkg.com/@ethersproject/abstract-signer/-/abstract-signer-5.0.9.tgz#238ddc06031aeb9dfceee2add965292d7dd1acbf"