fix: tentative CJS build + ethers v6 (#1280)

* chore(deps): bump ethers (#1242) * fix(deps): patch tests and package.json files after the ethers bump Co-authored-by: Dennis von der Bey <[email protected]>
decentralized-identity · Oct 24, 2023 · b4e8b95 · b4e8b95
1 parent 977662a
commit b4e8b95
Show file tree

Hide file tree

Showing 59 changed files with 19,258 additions and 8,430 deletions.
diff --git a/.github/workflows/build-and-test-on-pr.yml b/.github/workflows/build-and-test-on-pr.yml
@@ -2,7 +2,7 @@ name: Build and Test PR
 on: [pull_request, workflow_dispatch]
 jobs:
   build-test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     services:
       postgres:
         image: postgres:15.1

diff --git a/.github/workflows/build-test-publish-on-push.yml b/.github/workflows/build-test-publish-on-push.yml
@@ -15,7 +15,7 @@ jobs:
       GH_TOKEN: ${{secrets.GH_TOKEN}}
       GH_USER: ${{secrets.GH_USER}}
       GH_EMAIL: ${{secrets.GH_EMAIL}}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     services:
       postgres:
         image: postgres:15.1
@@ -56,7 +56,7 @@ jobs:
 
       - name: setup git coordinates
         run: |
-          git remote set-url origin https://uport-project:$[email protected]/uport-project/veramo.git
+          git remote set-url origin https://${{secrets.GH_USER}}:${{secrets.GH_TOKEN}}@github.com/decentralized-identity/veramo.git
           git config user.name $GH_USER
           git config user.email $GH_EMAIL
 

diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -85,7 +85,7 @@ import didCommWithEthrDidFlow from './shared/didCommWithEthrDidFlow'
 import utils from './shared/utils'
 import web3 from './shared/web3'
 import credentialStatus from './shared/credentialStatus'
-import ethrDidFlowSigned from "./shared/ethrDidFlowSigned";
+import ethrDidFlowSigned from './shared/ethrDidFlowSigned'
 
 jest.setTimeout(60000)
 
@@ -207,7 +207,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
             {
               name: 'ganache',
               chainId: 1337,
-              provider,
+              provider: provider as any,
               registry,
             },
           ],

diff --git a/__tests__/shared/didCommWithEthrDidFlow.ts b/__tests__/shared/didCommWithEthrDidFlow.ts
@@ -76,7 +76,7 @@ export default (testContext: {
       const requestWithAgent = RequestWithAgentRouter({ agent })
 
       await new Promise((resolve) => {
-        //setup a server to receive HTTP messages and forward them to this agent to be processed as DIDComm messages
+        // set up a server to receive HTTP messages and forward them to this agent to be processed as DIDComm messages
         const app = express()
         // app.use(requestWithAgent)
         app.use(

diff --git a/__tests__/shared/didManager.ts b/__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: {

diff --git a/__tests__/shared/keyManager.ts b/__tests__/shared/keyManager.ts
@@ -1,9 +1,9 @@
 // noinspection ES6PreferShortImport
 
 import { IAgentOptions, IDIDManager, IKeyManager, IResolver, TAgent, TKeyType } from '../../packages/core/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>
 
@@ -222,7 +222,7 @@ export default (testContext: {
       const rawTx = await agent.keyManagerSignEthTX({
         kid: key.kid,
         transaction: {
-          to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+          to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
           value: 300000,
           gasLimit: 43092000,
           gasPrice: 20000000000,
@@ -243,7 +243,7 @@ export default (testContext: {
       const rawTx = await agent.keyManagerSignEthTX({
         kid: key.kid,
         transaction: {
-          to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+          to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
           from: keyAddress,
           value: 300000,
           gasLimit: 43092000,
@@ -266,8 +266,8 @@ export default (testContext: {
         agent.keyManagerSignEthTX({
           kid: key.kid,
           transaction: {
-            to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
-            from: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
+            to: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
+            from: '0xcE31a19193D4b23F4E9D6163d7247243BAF801C3',
             value: 300000,
             gasLimit: 43092000,
             gasPrice: 20000000000,
@@ -351,15 +351,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',
         )
       })
 
@@ -376,14 +376,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,
@@ -392,7 +417,7 @@ export default (testContext: {
         })
 
         expect(rawTx).toEqual(
-          '0xf869018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e0801ba0f16e2206290181c3feaa04051dad19089105c24339dbdf0d80147b48a59fa152a0770e8751ec77ccc78e8b207023f168444f7cfb67055c55c70ef75234458a3d51',
+            '0xf869018504a817c800840291882094ce31a19193d4b23f4e9d6163d7247243baf801c3830493e0801ba0f16e2206290181c3feaa04051dad19089105c24339dbdf0d80147b48a59fa152a0770e8751ec77ccc78e8b207023f168444f7cfb67055c55c70ef75234458a3d51',
         )
       })
     })

diff --git a/__tests__/utils/ethers-provider.ts b/__tests__/utils/ethers-provider.ts
@@ -1,34 +1,35 @@
-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':
-        //@ts-ignore
+      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}`)
     }
   }
-}
+}
diff --git a/__tests__/utils/ganache-provider.ts b/__tests__/utils/ganache-provider.ts
@@ -1,16 +1,14 @@
-import { Web3Provider } from '@ethersproject/providers'
-import { Contract, ContractFactory } from '@ethersproject/contracts'
-// @ts-ignore
-import DidRegistryContract from 'ethr-did-registry'
+import { BrowserProvider, Contract, ContractFactory } from 'ethers'
+import { EthereumDIDRegistry } from 'ethr-did-resolver'
 import ganache from 'ganache'
 
 /**
  * Creates a Web3Provider that connects to a local ganache instance with a bunch of known keys and an ERC1056 contract.
  *
  * 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: [
@@ -58,13 +56,11 @@ export async function createGanacheProvider(): Promise<{ provider: Web3Provider;
     }) as any
   )
   await provider.ready
-  const factory = ContractFactory.fromSolidity(DidRegistryContract).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 }
 }
diff --git a/lerna.json b/lerna.json
@@ -5,15 +5,16 @@
   ],
   "npmClient": "pnpm",
   "changelog": {
-    "repo": "uport-project/veramo",
+    "repo": "decentralized-identity/veramo",
     "cacheDir": ".changelog"
   },
   "command": {
     "publish": {
       "allowBranch": [
         "main",
         "next",
-        "master"
+        "master",
+        "unstable"
       ],
       "conventionalCommits": true,
       "gitRemote": "origin",

diff --git a/package.json b/package.json
@@ -4,8 +4,8 @@
   "scripts": {
     "build": "pnpm build:js && pnpm build:api && pnpm build:schema",
     "build:js": "pnpm -r --stream build",
-    "build:api": "pnpm --package=@veramo/cli -c dlx 'pnpm -r --stream extract-api'",
-    "build:schema": "pnpm --package=@veramo/cli -c dlx 'pnpm -r --stream generate-plugin-schema'",
+    "build:api": "pnpm -r --stream extract-api",
+    "build:schema": "pnpm -r --stream generate-plugin-schema",
     "lint": "echo \"linting not yet enabled\"",
     "test:integration-build": "pnpm test:integration-prepare && pnpm test:integration-pretty",
     "test:integration-prepare": "ts-node --project packages/tsconfig.settings.json ./scripts/prepare-integration-tests.ts",
@@ -15,26 +15,22 @@
     "test": "jest",
     "test:watch": "jest --watch --verbose",
     "test:browser": "cd packages/test-react-app && pnpm test:browser",
-    "veramo": "cross-env ./packages/cli/bin/veramo.js",
+    "veramo": "cross-env NODE_NO_WARNINGS=1 ./packages/cli/bin/veramo.js",
     "prettier": "prettier --write \"{packages,docs,__tests__,!build}/**/*.{ts,js,json,md,yml}\"",
-    "build-clean": "rimraf ./packages/*/build ./packages/*/api ./packages/*/node_modules ./packages/*/tsconfig.tsbuildinfo ./temp ./tmp && jest --clearCache",
-    "publish:latest": "lerna publish --conventional-commits --include-merged-tags --create-release github --yes --dist-tag latest --registry https://registry.npmjs.org/:_authToken=${NPM_TOKEN}",
-    "publish:next": "lerna publish --conventional-prerelease --force-publish --canary --no-git-tag-version --include-merged-tags --preid next --pre-dist-tag next --yes --registry https://registry.npmjs.org/:_authToken=${NPM_TOKEN}",
-    "publish:unstable": "lerna publish --conventional-prerelease --force-publish --canary --no-git-tag-version --include-merged-tags --preid unstable --pre-dist-tag unstable --yes --registry https://registry.npmjs.org/:_authToken=${NPM_TOKEN}",
+    "build-clean": "rimraf --glob ./packages/*/build ./packages/*/api ./packages/*/node_modules ./packages/*/tsconfig.tsbuildinfo ./temp ./tmp && jest --clearCache",
+    "publish:latest": "lerna publish --conventional-commits --include-merged-tags --create-release github --yes --dist-tag latest",
+    "publish:next": "lerna publish --conventional-prerelease --force-publish --canary --no-git-tag-version --include-merged-tags --preid next --pre-dist-tag next --yes",
+    "publish:unstable": "lerna publish --conventional-prerelease --force-publish --canary --no-git-tag-version --include-merged-tags --preid unstable --pre-dist-tag unstable --yes",
     "docs": "pnpm docs:copy && pnpm docs:build",
     "docs:copy": "ts-node ./scripts/docs-copy.ts",
     "docs:build": "ts-node ./scripts/docs-build.ts && pnpm docs:pretty",
-    "docs:pretty": "pretty-quick"
+    "docs:pretty": "prettier --write docs/**/*.md"
   },
   "workspaces": [
     "packages/*",
     "__browser_tests__/*"
   ],
   "devDependencies": {
-    "@ethersproject/contracts": "^5.7.0",
-    "@ethersproject/providers": "^5.7.2",
-    "@ethersproject/transactions": "^5.7.0",
-    "@ethersproject/wallet": "^5.7.0",
     "@metamask/eth-sig-util": "^5.0.0",
     "@microsoft/api-documenter": "7.19.27",
     "@microsoft/api-extractor": "7.33.7",
@@ -43,22 +39,23 @@
     "@transmute/credentials-context": "^0.7.0-unstable.77",
     "@types/express": "4.17.15",
     "@types/fs-extra": "9.0.13",
-    "@types/jest": "28.1.8",
+    "@types/jest": "29.5.6",
     "@types/node": "18.11.18",
     "@types/uuid": "^9.0.0",
     "caip": "^1.1.0",
     "credential-status": "^2.0.5",
     "cross-env": "7.0.3",
-    "did-jwt": "^6.11.0",
+    "did-jwt": "^6.11.6",
     "did-jwt-vc": "^3.1.0",
     "did-resolver": "^4.0.1",
+    "ethers": "^6.8.0",
     "ethr-did-registry": "0.0.3",
-    "ethr-did-resolver": "^8.0.0",
+    "ethr-did-resolver": "^9.0.0",
     "express": "^4.18.2",
-    "ganache": "7.4.4",
-    "jest": "28.1.3",
-    "jest-environment-jsdom": "28.1.3",
-    "jest-environment-node": "28.1.3",
+    "ganache": "7.9.1",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "jest-environment-node": "29.7.0",
     "json-schema": "0.4.0",
     "lerna": "5.1.1",
     "lerna-changelog": "2.2.0",
@@ -68,7 +65,7 @@
     "pretty-quick": "3.1.3",
     "rimraf": "3.0.2",
     "semantic-release": "19.0.5",
-    "ts-jest": "28.0.8",
+    "ts-jest": "29.1.1",
     "ts-json-schema-generator": "1.1.2",
     "ts-node": "10.9.1",
     "typeorm": "^0.3.10",
@@ -96,7 +93,8 @@
   "resolutions": {
     "@types/react": "^18.0.21",
     "@types/eslint": "^8.4.6",
-    "jsonld": "npm:@digitalcredentials/jsonld@^5.2.1"
+    "jsonld": "npm:@digitalcredentials/jsonld@^5.2.1",
+    "did-jwt": "6.11.6"
   },
   "engines": {
     "node": ">= 14.0.0"