chore(deps): bump ethers (#1242)

BREAKING CHANGE: now using ethers v6 as a dependency which may need extra attention when merging. The output of `eth_signTransaction` algorithms may be slightly different as transactions are by default infered as type 1 (EIP1559)

__tests__/shared/didManager.ts

@@ -58,7 +58,7 @@ export default (testContext: {
       expect(identifier.controllerKeyId).toEqual(identifier.keys[0].kid)
     })
 
-    it('should create identifier using chainId 3', async () => {
+    it('should translate identifier using chainId 421613 to arbitrum', async () => {
       identifier = await agent.didManagerCreate({
         provider: 'did:ethr',
         options: {

__tests__/shared/keyManager.ts

@@ -8,9 +8,9 @@ import {
   TAgent,
   TKeyType,
 } from '../../packages/core-types/src'
-import { computeAddress, serialize } from '@ethersproject/transactions'
 import { mapIdentifierKeysToDoc } from '../../packages/utils/src'
 import { recoverTypedSignature, SignTypedDataVersion } from '@metamask/eth-sig-util'
+import {computeAddress, Transaction} from "ethers";
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver>
 
@@ -229,7 +229,7 @@ export default (testContext: {
       const rawTx = await agent.keyManagerSignEthTX({
         kid: key.kid,
         transaction: {
-          to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+          to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
           value: 300000,
           gasLimit: 43092000,
           gasPrice: 20000000000,
@@ -250,7 +250,7 @@ export default (testContext: {
       const rawTx = await agent.keyManagerSignEthTX({
         kid: key.kid,
         transaction: {
-          to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+          to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
           from: keyAddress,
           value: 300000,
           gasLimit: 43092000,
@@ -273,8 +273,8 @@ export default (testContext: {
         agent.keyManagerSignEthTX({
           kid: key.kid,
           transaction: {
-            to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
-            from: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+            to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
+            from: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
             value: 300000,
             gasLimit: 43092000,
             gasPrice: 20000000000,
@@ -358,15 +358,15 @@ export default (testContext: {
         const rawTx = await agent.keyManagerSignEthTX({
           kid: importedKey.kid,
           transaction: {
-            to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+            to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
             value: 300000,
             gasLimit: 43092000,
             gasPrice: 20000000000,
             nonce: 1,
           },
         })
         expect(rawTx).toEqual(
-          '0xf869018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e0801ba0f16e2206290181c3feaa04051dad19089105c24339dbdf0d80147b48a59fa152a0770e8751ec77ccc78e8b207023f168444f7cfb67055c55c70ef75234458a3d51',
+          '0x01f86b80018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e080c001a05a46cdfe2102e81e90f89d8896ddaf32aee5473bad994bc1767f0d2af9afa160a01c028daaf737d69f6933d2dfef5e739f459cfb9e8ce1d9ba9ea7bb0c6006518c',
         )
       })
 
@@ -383,14 +383,39 @@ export default (testContext: {
       })
 
       it('should sign EthTX using generic signer', async () => {
-        const txData = serialize({
-          to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+        const transaction = new Transaction()
+        transaction.to = '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3'
+        transaction.value = 300000
+        transaction.gasLimit = 43092000
+        transaction.gasPrice = 20000000000
+        transaction.nonce = 1
+
+        const txData = transaction.unsignedSerialized
+
+        const rawTx = await agent.keyManagerSign({
+          algorithm: 'eth_signTransaction',
+          data: txData,
+          encoding: 'hex',
+          keyRef: importedKey.kid,
+        })
+
+        expect(rawTx).toEqual(
+          '0x01f86b80018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e080c001a05a46cdfe2102e81e90f89d8896ddaf32aee5473bad994bc1767f0d2af9afa160a01c028daaf737d69f6933d2dfef5e739f459cfb9e8ce1d9ba9ea7bb0c6006518c',
+        )
+      })
+
+      it('should sign EthTX using generic signer and specific type', async () => {
+        const transaction = Transaction.from({
+          to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
           value: 300000,
           gasLimit: 43092000,
           gasPrice: 20000000000,
           nonce: 1,
+          type: 0, // enforce legacy serialization
         })
 
+        const txData = transaction.unsignedSerialized
+
         const rawTx = await agent.keyManagerSign({
           algorithm: 'eth_signTransaction',
           data: txData,
@@ -399,7 +424,7 @@ export default (testContext: {
         })
 
         expect(rawTx).toEqual(
-          '0xf869018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e0801ba0f16e2206290181c3feaa04051dad19089105c24339dbdf0d80147b48a59fa152a0770e8751ec77ccc78e8b207023f168444f7cfb67055c55c70ef75234458a3d51',
+            '0xf869018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e0801ba0f16e2206290181c3feaa04051dad19089105c24339dbdf0d80147b48a59fa152a0770e8751ec77ccc78e8b207023f168444f7cfb67055c55c70ef75234458a3d51',
         )
       })
     })

__tests__/utils/ethers-provider.ts

@@ -1,31 +1,32 @@
-import { Web3Provider, ExternalProvider } from '@ethersproject/providers'
-import { Wallet } from '@ethersproject/wallet'
+import { BrowserProvider, Eip1193Provider, Wallet } from 'ethers'
 
-export function createEthersProvider(): Web3Provider {
+export function createEthersProvider(): BrowserProvider {
   const privateKeyHex = '0x1da6847600b0ee25e9ad9a52abbd786dd2502fa4005dd5af9310b7cc7a3b25db'
   const wallet = new Wallet(privateKeyHex)
   const mockProvider = new MockWeb3Provider(wallet)
-  const provider = new Web3Provider(mockProvider)
+  const provider = new BrowserProvider(mockProvider)
   return provider
 }
 
+class MockWeb3Provider implements Eip1193Provider {
+  constructor(private wallet: Wallet) {}
 
-class MockWeb3Provider implements ExternalProvider {
-  constructor(private wallet: Wallet){
-
-  }
   async request(request: { method: string; params?: any[] }): Promise<any> {
 
     switch(request.method) {
       case 'personal_sign':
         // @ts-ignore
         return this.wallet.signMessage(request.params[1])
         break
-        case 'eth_signTypedData_v4':
+      case 'eth_signTypedData_v4':
         // @ts-ignore
         const {domain, types, message} = JSON.parse(request.params[1])
         delete(types.EIP712Domain)
-        return this.wallet._signTypedData(domain, types, message)
+        return this.wallet.signTypedData(domain, types, message)
+      case 'eth_accounts':
+        return [await this.wallet.getAddress()]
+      case 'eth_chainId':
+        return "1337"
       break
       default:
         throw Error(`not_available: method ${request.method}`)

__tests__/utils/ganache-provider.ts

@@ -1,5 +1,4 @@
-import { Web3Provider } from '@ethersproject/providers'
-import { Contract, ContractFactory } from '@ethersproject/contracts'
+import { BrowserProvider, Contract, ContractFactory } from 'ethers'
 import { EthereumDIDRegistry } from 'ethr-did-resolver'
 import ganache from 'ganache'
 
@@ -8,8 +7,8 @@ import ganache from 'ganache'
  *
  * This provider can only be used in a single test suite, because of some concurrency issues with ganache.
  */
-export async function createGanacheProvider(): Promise<{ provider: Web3Provider; registry: string }> {
-  const provider = new Web3Provider(
+export async function createGanacheProvider(): Promise<{ provider: BrowserProvider; registry: string }> {
+  const provider = new BrowserProvider(
     ganache.provider({
       logging: { quiet: true },
       accounts: [
@@ -57,13 +56,11 @@ export async function createGanacheProvider(): Promise<{ provider: Web3Provider;
     }) as any
   )
   await provider.ready
-  const factory = ContractFactory.fromSolidity(EthereumDIDRegistry).connect(provider.getSigner(0))
+  const factory = ContractFactory.fromSolidity(EthereumDIDRegistry).connect(await provider.getSigner(0))
 
   let registryContract: Contract = await factory.deploy()
-  registryContract = await registryContract.deployed()
+  registryContract = await registryContract.waitForDeployment()
 
-  await registryContract.deployTransaction.wait()
-
-  const registry = registryContract.address
+  const registry = await registryContract.getAddress()
   return { provider, registry }
 }

package.json

@@ -27,10 +27,6 @@
     "docs:pretty": "prettier --write docs/**/*.md"
   },
   "devDependencies": {
-    "@ethersproject/contracts": "^5.7.0",
-    "@ethersproject/providers": "^5.7.2",
-    "@ethersproject/transactions": "^5.7.0",
-    "@ethersproject/wallet": "^5.7.0",
     "@jest/globals": "29.7.0",
     "@metamask/eth-sig-util": "7.0.0",
     "@microsoft/api-documenter": "7.23.0",
@@ -51,7 +47,8 @@
     "did-jwt": "7.4.2",
     "did-jwt-vc": "3.2.11",
     "did-resolver": "4.1.0",
-    "ethr-did-resolver": "8.1.2",
+    "ethers": "6.7.1",
+    "ethr-did-resolver": "9.0.0",
     "express": "4.18.2",
     "ganache": "7.9.0",
     "jest": "29.7.0",

packages/did-comm/package.json

@@ -18,7 +18,6 @@
     }
   },
   "dependencies": {
-    "@ethersproject/signing-key": "^5.7.0",
     "@noble/curves": "^1.1.0",
     "@stablelib/aes": "^1.0.1",
     "@stablelib/aes-kw": "^1.0.1",

packages/did-provider-ethr/package.json

@@ -10,19 +10,10 @@
     "extract-api": "node ../cli/bin/veramo.js dev extract-api"
   },
   "dependencies": {
-    "@ethersproject/abstract-provider": "^5.7.0",
-    "@ethersproject/abstract-signer": "5.7.0",
-    "@ethersproject/address": "^5.7.0",
-    "@ethersproject/bignumber": "^5.7.0",
-    "@ethersproject/bytes": "^5.7.0",
-    "@ethersproject/properties": "^5.7.0",
-    "@ethersproject/providers": "^5.7.0",
-    "@ethersproject/signing-key": "^5.7.0",
-    "@ethersproject/transactions": "^5.7.0",
     "@veramo/core-types": "workspace:^",
     "@veramo/did-manager": "workspace:^",
     "debug": "^4.3.3",
-    "ethr-did": "^2.3.18"
+    "ethr-did": "^3.0.1"
   },
   "devDependencies": {
     "@types/debug": "4.1.8",