feat(did-comm): didcomm messaging using did:ethr (#744)

* test: fix test async setup

* chore(deps): bump DID dependencies

* feat(did-provider-ethr): add X25519 keys to `keyAgreement` section
  fixes #743

* fix(did-comm): use more specific error messages for keyAgreement

* fix(did-comm): compare compressed keys for secp256k1
  fixes `packDidCommMessage()` using `jws` packing for Secp256k1 keys.

* test(did-comm): cover more corner cases with tests

__tests__/initial.migration.test.ts

@@ -1,3 +1,8 @@
+/**
+ * This suite runs through a few agent operations using data that was created before
+ * TypeORM migrations were available (before Veramo 3.0.0)
+ */
+
 import { createAgent, TAgent, IDIDManager, IResolver, IKeyManager, IDataStore } from '../packages/core/src'
 import { DIDResolverPlugin } from '../packages/did-resolver/src'
 import { EthrDIDProvider } from '../packages/did-provider-ethr/src'

__tests__/localAgent.test.ts

@@ -1,3 +1,10 @@
+/**
+ * This runs a suite of ./shared tests using an agent configured for local operations,
+ * using a SQLite db for storage of credentials, presentations, messages as well as keys and DIDs.
+ * 
+ * This suite also runs a ganache local blockchain to run through some examples of DIDComm using did:ethr identifiers.
+ */
+
 import {
   createAgent,
   TAgent,
@@ -41,6 +48,7 @@ import {
 import { createConnection, Connection } from 'typeorm'
 
 import { FakeDidProvider, FakeDidResolver } from './utils/fake-did'
+import { createGanacheProvider } from './utils/ganache-provider'
 import { Resolver } from 'did-resolver'
 import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
@@ -57,10 +65,11 @@ import saveClaims from './shared/saveClaims'
 import documentationExamples from './shared/documentationExamples'
 import keyManager from './shared/keyManager'
 import didManager from './shared/didManager'
-import didComm from './shared/didcomm'
+import didCommPacking from './shared/didCommPacking'
 import messageHandler from './shared/messageHandler'
 import didDiscovery from './shared/didDiscovery'
 import dbInitOptions from './shared/dbInitOptions'
+import didCommWithEthrDidFlow from './shared/didCommWithEthrDidFlow'
 
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'
 const secretKey = '29739248cad1bd1a0fc4d9b75cd4d2990de535baf5caadfdf8d8f86664aa830c'
@@ -81,7 +90,7 @@ let dbConnection: Promise<Connection>
 let databaseFile: string
 
 const setup = async (options?: IAgentOptions): Promise<boolean> => {
-  databaseFile = options?.context?.databaseFile || 'local-database.sqlite'
+  databaseFile = options?.context?.databaseFile || `./tmp/local-database-${Math.random().toPrecision(5)}.sqlite`
   dbConnection = createConnection({
     name: options?.context?.['dbName'] || 'test',
     type: 'sqlite',
@@ -95,6 +104,8 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
     ...options?.context?.dbConnectionOptions,
   })
 
+  const { provider, registry } = await createGanacheProvider()
+
   agent = createAgent<
     IDIDManager &
       IKeyManager &
@@ -142,6 +153,12 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
             rpcUrl: 'https://arbitrum-rinkeby.infura.io/v3/' + infuraProjectId,
             registry: '0x8f54f62CA28D481c3C30b1914b52ef935C1dF820',
           }),
+          'did:ethr:ganache': new EthrDIDProvider({
+            defaultKms: 'local',
+            network: 1337,
+            web3Provider: provider,
+            registry,
+          }),
           'did:web': new WebDIDProvider({
             defaultKms: 'local',
           }),
@@ -153,7 +170,17 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       }),
       new DIDResolverPlugin({
         resolver: new Resolver({
-          ...ethrDidResolver({ infuraProjectId }),
+          ...ethrDidResolver({
+            infuraProjectId,
+            networks: [
+              {
+                name: 'ganache',
+                chainId: 1337,
+                provider,
+                registry,
+              },
+            ],
+          }),
           ...webDidResolver(),
           ...getDidKeyResolver(),
           ...new FakeDidResolver(() => agent).getDidFakeResolver(),
@@ -210,7 +237,8 @@ describe('Local integration tests', () => {
   keyManager(testContext)
   didManager(testContext)
   messageHandler(testContext)
-  didComm(testContext)
+  didCommPacking(testContext)
   didDiscovery(testContext)
   dbInitOptions(testContext)
+  didCommWithEthrDidFlow(testContext)
 })

__tests__/localMemoryStoreAgent.test.ts

@@ -1,3 +1,8 @@
+/**
+ * This runs a suite of ./shared tests using an agent configured for local operations,
+ * using a SQLite db for storage of credentials and an in-memory store for keys and DIDs.
+ * 
+ */
 import {
   createAgent,
   TAgent,
@@ -45,10 +50,10 @@ import saveClaims from './shared/saveClaims'
 import documentationExamples from './shared/documentationExamples'
 import keyManager from './shared/keyManager'
 import didManager from './shared/didManager'
-import didComm from './shared/didcomm'
+import didCommPacking from './shared/didCommPacking'
 import messageHandler from './shared/messageHandler'
 
-const databaseFile = 'local-database2.sqlite'
+const databaseFile = `./tmp/local-database2-${Math.random().toPrecision(5)}.sqlite`
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'
 
 let agent: TAgent<
@@ -187,5 +192,5 @@ describe('Local in-memory integration tests', () => {
   keyManager(testContext)
   didManager(testContext)
   messageHandler(testContext)
-  didComm(testContext)
+  didCommPacking(testContext)
 })

__tests__/restAgent.test.ts

@@ -1,3 +1,10 @@
+/**
+ * This runs a suite of ./shared tests using an agent configured for remote operations.
+ * There is a local agent that only uses @veramo/remove-client and a remote agent that provides the actual functionality.
+ * 
+ * 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,
@@ -62,12 +69,12 @@ import webDidFlow from './shared/webDidFlow'
 import documentationExamples from './shared/documentationExamples'
 import keyManager from './shared/keyManager'
 import didManager from './shared/didManager'
-import didComm from './shared/didcomm'
-import didCommRemote from './shared/didcommRemote'
+import didCommPacking from './shared/didCommPacking'
+import didWithFakeDidFlow from './shared/didCommWithFakeDidFlow'
 import messageHandler from './shared/messageHandler'
 import didDiscovery from './shared/didDiscovery'
 
-const databaseFile = 'rest-database.sqlite'
+const databaseFile = `./tmp/rest-database-${Math.random().toPrecision(5)}.sqlite`
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'
 const secretKey = '29739248cad1bd1a0fc4d9b75cd4d2990de535baf5caadfdf8d8f86664aa830c'
 const port = 3002
@@ -234,7 +241,7 @@ describe('REST integration tests', () => {
   keyManager(testContext)
   didManager(testContext)
   messageHandler(testContext)
-  didComm(testContext)
-  didCommRemote(testContext)
+  didCommPacking(testContext)
+  didWithFakeDidFlow(testContext)
   didDiscovery(testContext)
 })