Merge pull request #1114 from uport-project/next

chore: new major release

.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
@@ -23,7 +23,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           cache: 'pnpm'
 
       - run: pnpm install

.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
@@ -36,7 +36,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           cache: 'pnpm'
 
       - run: pnpm install
@@ -54,6 +54,8 @@ jobs:
       - name: run browser tests
         run: pnpm test:browser
 
+      - run: pnpm run docs
+
       - name: setup git coordinates
         run: |
           git remote set-url origin https://uport-project:[email protected]/uport-project/veramo.git

.github/workflows/sync-next-with-latest.yml

@@ -6,7 +6,7 @@ on:
       - 'main'
 jobs:
   merge-branch:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: everlytic/[email protected]

.gitignore

@@ -32,10 +32,11 @@ key-store.json
 
 .vscode/
 node_modules
-temp
+temp/
+tmp/
 
 agent.yml
 data
 .vscode-upload.json
 
-local-database*.json
+local-database*.json

README.md

@@ -66,6 +66,7 @@ This monorepo uses [pnpm](https://pnpm.io/) and [lerna](https://lerna.js.org/)
 Install dependencies
 
 ```bash
+npm -g i pnpm
 pnpm install
 ```
 

__tests__/initial.migration.test.ts

@@ -6,15 +6,15 @@
  */
 
 import {
-  createAgent,
   IDataStore,
   IDataStoreORM,
   IDIDManager,
   IKeyManager,
   IResolver,
   TAgent,
   VerifiableCredential,
-} from '../packages/core/src'
+} from '../packages/core-types/src'
+import { createAgent } from '../packages/core/src'
 import { DIDResolverPlugin } from '../packages/did-resolver/src'
 import { EthrDIDProvider } from '../packages/did-provider-ethr/src'
 import { WebDIDProvider } from '../packages/did-provider-web/src'
@@ -40,6 +40,13 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import * as fs from 'fs'
 
+import { jest } from '@jest/globals'
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
 jest.setTimeout(60000)
 
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'

__tests__/localAgent.test.ts

@@ -9,6 +9,8 @@
 
 import {
   createAgent,
+} from '../packages/core/src'
+import {
   IAgentOptions,
   ICredentialPlugin,
   IDataStore,
@@ -18,7 +20,7 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
-} from '../packages/core/src'
+} from '../packages/core-types/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager } from '../packages/key-manager/src'
 import { AliasDiscoveryProvider, DIDManager } from '../packages/did-manager/src'
@@ -66,6 +68,8 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

__tests__/localJsonStoreAgent.test.ts

@@ -6,7 +6,6 @@
  *
  */
 import {
-  createAgent,
   IAgentOptions,
   ICredentialPlugin,
   IDataStore,
@@ -16,6 +15,9 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
+} from '../packages/core-types/src'
+import {
+  createAgent
 } from '../packages/core/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager } from '../packages/key-manager/src'
@@ -56,6 +58,7 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
 
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'

__tests__/localMemoryStoreAgent.test.ts

@@ -6,7 +6,6 @@
  *
  */
 import {
-  createAgent,
   IAgentOptions,
   ICredentialPlugin,
   IDataStore,
@@ -16,6 +15,9 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
+} from '../packages/core-types/src'
+import {
+  createAgent
 } from '../packages/core/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager, MemoryKeyStore, MemoryPrivateKeyStore } from '../packages/key-manager/src'
@@ -52,6 +54,8 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

__tests__/restAgent.test.ts

@@ -8,10 +8,7 @@
  * This suite also runs a messaging server to run through some examples of DIDComm using did:fake identifiers.
  * See didWithFakeDidFlow() for more details.
  */
-import 'cross-fetch/polyfill'
 import {
-  Agent,
-  createAgent,
   IAgent,
   IAgentOptions,
   IDataStore,
@@ -21,6 +18,10 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
+} from '../packages/core-types/src'
+import {
+  Agent,
+  createAgent
 } from '../packages/core/src'
 import { MessageHandler } from '../packages/message-handler/src'
 import { KeyManager } from '../packages/key-manager/src'
@@ -77,6 +78,8 @@ import express from 'express'
 import { Server } from 'http'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

__tests__/shared/credentialStatus.ts

@@ -10,8 +10,9 @@ import {
   IDIDManager,
   IIdentifier,
   TAgent,
-} from '../../packages/core/src'
+} from '../../packages/core-types/src'
 import { CredentialStatusPlugin } from '../../packages/credential-status/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & ICredentialPlugin & IDataStore & IDataStoreORM>
 

__tests__/shared/dbInitOptions.ts

@@ -12,7 +12,7 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
-} from '../../packages/core/src'
+} from '../../packages/core-types/src'
 import { IDIDComm, IPackedDIDCommMessage } from '../../packages/did-comm/src'
 import { extractIssuer } from '../../packages/utils/src'
 

__tests__/shared/didCommAndDataStoreWithCredentials.ts

@@ -8,16 +8,17 @@ import {
   IKeyManager,
   IResolver,
   TAgent,
-} from '../../packages/core/src'
+} from '../../packages/core-types/src'
 import { IDIDComm, IPackedDIDCommMessage } from '../../packages/did-comm/src'
-import { v4 } from "uuid"
-import { VerifiableCredential } from '../../packages/core/src'
+import { v4 } from 'uuid'
+import { VerifiableCredential } from '../../packages/core-types/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {
@@ -129,18 +130,21 @@ export default (testContext: {
     }
 
     const packed = (vc: VerifiableCredential): Promise<IPackedDIDCommMessage> => {
-      return agent.packDIDCommMessage({ packing: 'none', message: {
-        id: v4(),
-        type: 'w3c.vc',
-        from: sender.did,
-        to: receiver.did,
-        body: vc
-      }})
+      return agent.packDIDCommMessage({
+        packing: 'none',
+        message: {
+          id: v4(),
+          type: 'w3c.vc',
+          from: sender.did,
+          to: receiver.did,
+          body: vc,
+        },
+      })
     }
 
     it('should save LDS credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
 
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
@@ -161,8 +165,7 @@ export default (testContext: {
 
     it('should save JWT credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
-
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
 
@@ -180,11 +183,9 @@ export default (testContext: {
       expect(vcs).toEqual(numVCsBefore + 1)
     })
 
-
     it('should save JWT credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
-
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
 

__tests__/shared/didCommPacking.ts

@@ -1,6 +1,6 @@
 // noinspection ES6PreferShortImport
 
-import { IDIDManager, IIdentifier, IKeyManager, IResolver, TAgent } from '../../packages/core/src'
+import { IDIDManager, IIdentifier, IKeyManager, IResolver, TAgent } from '../../packages/core-types/src'
 import { IDIDComm } from '../../packages/did-comm/src'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm>

__tests__/shared/didCommWithEthrDidFlow.ts

@@ -10,19 +10,20 @@ import {
   IMessageHandler,
   IResolver,
   TAgent,
-} from '../../packages/core/src'
+} from '../../packages/core-types/src'
 import { IDIDComm } from '../../packages/did-comm/src'
 import { MessagingRouter, RequestWithAgentRouter } from '../../packages/remote-server/src'
-import * as u8a from 'uint8arrays'
 // @ts-ignore
 import express from 'express'
 import { Server } from 'http'
+import { jest } from '@jest/globals'
+import { bytesToBase58, hexToBytes } from '../../packages/utils/src'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm & IMessageHandler>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {
@@ -585,9 +586,9 @@ export default (testContext: {
         key: newKey,
       })
 
-      expect(result.substr(0, 2)).toEqual('0x')
+      expect(result.substring(0, 2)).toEqual('0x')
       const resolution = await agent.resolveDid({ didUrl: alice.did })
-      const expectedBase58Key = u8a.toString(u8a.fromString(newKey.publicKeyHex, 'base16'), 'base58btc')
+      const expectedBase58Key = bytesToBase58(hexToBytes(newKey.publicKeyHex))
       expect(resolution?.didDocument?.verificationMethod?.[2].publicKeyBase58).toEqual(expectedBase58Key)
       expect(resolution?.didDocument?.keyAgreement?.[0]).toEqual(
         resolution?.didDocument?.verificationMethod?.[2].id,
@@ -692,7 +693,7 @@ export default (testContext: {
 
       expect(result.substr(0, 2)).toEqual('0x')
       const resolution = await agent.resolveDid({ didUrl: bob.did })
-      const expectedBase58Key = u8a.toString(u8a.fromString(newKey.publicKeyHex, 'base16'), 'base58btc')
+      const expectedBase58Key = bytesToBase58(hexToBytes(newKey.publicKeyHex))
       expect(resolution?.didDocument?.verificationMethod?.[2].publicKeyBase58).toEqual(expectedBase58Key)
       expect(resolution?.didDocument?.keyAgreement?.[0]).toEqual(
         resolution?.didDocument?.verificationMethod?.[2].id,

__tests__/shared/didCommWithFakeDidFlow.ts

@@ -8,14 +8,15 @@ import {
   IKeyManager,
   IResolver,
   TAgent,
-} from '../../packages/core/src'
+} from '../../packages/core-types/src'
 import { IDIDComm } from '../../packages/did-comm/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {

__tests__/shared/didDiscovery.ts

@@ -1,7 +1,7 @@
 // noinspection ES6PreferShortImport
 
 import { IDIDDiscovery } from '../../packages/did-discovery/src'
-import { IAgentOptions, ICredentialIssuer, IDataStoreORM, IDIDManager, TAgent } from '../../packages/core/src'
+import { IAgentOptions, ICredentialIssuer, IDataStoreORM, IDIDManager, TAgent } from '../../packages/core-types/src'
 
 type ConfiguredAgent = TAgent<IDIDManager & IDIDDiscovery & IDataStoreORM & ICredentialIssuer>