refactor!: didcomm module (openwallet-foundation#2127)

Signed-off-by: Ariel Gentile <[email protected]>
berendsliedrecht · Jan 28, 2025 · 897c834 · 897c834
1 parent 70c849d
commit 897c834
Show file tree

Hide file tree

Showing 770 changed files with 7,538 additions and 7,920 deletions.
diff --git a/.changeset/purple-donkeys-camp.md b/.changeset/purple-donkeys-camp.md
@@ -0,0 +1,67 @@
+---
+'@credo-ts/question-answer': minor
+'@credo-ts/bbs-signatures': minor
+'@credo-ts/action-menu': minor
+'@credo-ts/anoncreds': minor
+'@credo-ts/indy-vdr': minor
+'@credo-ts/didcomm': minor
+'@credo-ts/tenants': minor
+'@credo-ts/askar': minor
+'@credo-ts/cheqd': minor
+'@credo-ts/core': minor
+'@credo-ts/drpc': minor
+'@credo-ts/node': minor
+---
+
+DIDComm has been extracted out of the Core. This means that now all DIDComm related modules (e.g. proofs, credentials) must be explicitly added when creating an `Agent` instance. Therefore, their API will be accesable under `agent.modules.[moduleAPI]` instead of `agent.[moduleAPI]`. Some `Agent` DIDComm-related properties and methods where also moved to the API of a new DIDComm module (e.g. `agent.registerInboundTransport` turned into `agent.modules.didcomm.registerInboundTransport`).
+
+**Example of DIDComm Agent**
+
+Previously:
+
+```ts
+     const config = {
+      label: name,
+      endpoints: ['https://myendpoint'],
+      walletConfig: {
+        id: name,
+        key: name,
+      },
+    } satisfies InitConfig
+
+    const agent = new Agent({
+      config,
+      dependencies: agentDependencies,
+      modules: {
+        connections: new ConnectionsModule({
+           autoAcceptConnections: true,
+        })
+      })
+    this.agent.registerInboundTransport(new HttpInboundTransport({ port }))
+    this.agent.registerOutboundTransport(new HttpOutboundTransport())
+
+```
+
+Now:
+
+```ts
+     const config = {
+      label: name,
+      walletConfig: {
+        id: name,
+        key: name,
+      },
+    } satisfies InitConfig
+
+    const agent = new Agent({
+      config,
+      dependencies: agentDependencies,
+      modules: {
+        ...getDefaultDidcommModules({ endpoints: ['https://myendpoint'] }),
+        connections: new ConnectionsModule({
+           autoAcceptConnections: true,
+        })
+      })
+    agent.modules.didcomm.registerInboundTransport(new HttpInboundTransport({ port }))
+    agent.modules.didcomm.registerOutboundTransport(new HttpOutboundTransport())
+```
diff --git a/demo-openid/src/BaseAgent.ts b/demo-openid/src/BaseAgent.ts
@@ -1,16 +1,9 @@
 import type { InitConfig, KeyDidCreateOptions, ModulesMap, VerificationMethod } from '@credo-ts/core'
 import type { Express } from 'express'
+import type { Server } from 'http'
 
-import {
-  Agent,
-  ConsoleLogger,
-  DidKey,
-  HttpOutboundTransport,
-  KeyType,
-  LogLevel,
-  TypedArrayEncoder,
-} from '@credo-ts/core'
-import { HttpInboundTransport, agentDependencies } from '@credo-ts/node'
+import { Agent, ConsoleLogger, DidKey, KeyType, LogLevel, TypedArrayEncoder } from '@credo-ts/core'
+import { agentDependencies } from '@credo-ts/node'
 import express from 'express'
 
 import { greenText } from './OutputClass'
@@ -21,6 +14,7 @@ export class BaseAgent<AgentModules extends ModulesMap> {
   public name: string
   public config: InitConfig
   public agent: Agent<AgentModules>
+  public server?: Server
   public did!: string
   public didKey!: DidKey
   public kid!: string
@@ -41,17 +35,13 @@ export class BaseAgent<AgentModules extends ModulesMap> {
     this.config = config
 
     this.agent = new Agent({ config, dependencies: agentDependencies, modules })
-
-    const httpInboundTransport = new HttpInboundTransport({ app: this.app, port: this.port })
-    const httpOutboundTransport = new HttpOutboundTransport()
-
-    this.agent.registerInboundTransport(httpInboundTransport)
-    this.agent.registerOutboundTransport(httpOutboundTransport)
   }
 
   public async initializeAgent(secretPrivateKey: string) {
     await this.agent.initialize()
 
+    this.server = this.app.listen(this.port)
+
     const didCreateResult = await this.agent.dids.create<KeyDidCreateOptions>({
       method: 'key',
       options: { keyType: KeyType.Ed25519 },
@@ -68,4 +58,9 @@ export class BaseAgent<AgentModules extends ModulesMap> {
 
     console.log(greenText(`\nAgent ${this.name} created!\n`))
   }
+
+  public async shutdown() {
+    this.server?.close()
+    await this.agent.shutdown()
+  }
 }
diff --git a/demo-openid/src/Holder.ts b/demo-openid/src/Holder.ts
@@ -212,11 +212,11 @@ export class Holder extends BaseAgent<ReturnType<typeof getOpenIdHolderModules>>
 
   public async exit() {
     console.log(Output.Exit)
-    await this.agent.shutdown()
+    await this.shutdown()
     process.exit(0)
   }
 
   public async restart() {
-    await this.agent.shutdown()
+    await this.shutdown()
   }
 }
diff --git a/demo-openid/src/Issuer.ts b/demo-openid/src/Issuer.ts
@@ -345,12 +345,12 @@ export class Issuer extends BaseAgent<{
 
   public async exit() {
     console.log(Output.Exit)
-    await this.agent.shutdown()
+    await this.shutdown()
     process.exit(0)
   }
 
   public async restart() {
-    await this.agent.shutdown()
+    await this.shutdown()
   }
 }
 

diff --git a/demo-openid/src/Verifier.ts b/demo-openid/src/Verifier.ts
@@ -107,11 +107,11 @@ export class Verifier extends BaseAgent<{ askar: AskarModule; openId4VcVerifier:
 
   public async exit() {
     console.log(Output.Exit)
-    await this.agent.shutdown()
+    await this.shutdown()
     process.exit(0)
   }
 
   public async restart() {
-    await this.agent.shutdown()
+    await this.shutdown()
   }
 }
diff --git a/demo/package.json b/demo/package.json
@@ -22,6 +22,7 @@
     "@credo-ts/anoncreds": "workspace:*",
     "@credo-ts/askar": "workspace:*",
     "@credo-ts/core": "workspace:*",
+    "@credo-ts/didcomm": "workspace:*",
     "@credo-ts/indy-vdr": "workspace:*",
     "@credo-ts/cheqd": "workspace:*",
     "@credo-ts/node": "workspace:*",

diff --git a/demo/src/Alice.ts b/demo/src/Alice.ts
@@ -1,4 +1,4 @@
-import type { ConnectionRecord, CredentialExchangeRecord, ProofExchangeRecord } from '@credo-ts/core'
+import type { ConnectionRecord, CredentialExchangeRecord, ProofExchangeRecord } from '@credo-ts/didcomm'
 
 import { BaseAgent } from './BaseAgent'
 import { greenText, Output, redText } from './OutputClass'
@@ -22,19 +22,19 @@ export class Alice extends BaseAgent {
     if (!this.connectionRecordFaberId) {
       throw Error(redText(Output.MissingConnectionRecord))
     }
-    return await this.agent.connections.getById(this.connectionRecordFaberId)
+    return await this.agent.modules.connections.getById(this.connectionRecordFaberId)
   }
 
   private async receiveConnectionRequest(invitationUrl: string) {
-    const { connectionRecord } = await this.agent.oob.receiveInvitationFromUrl(invitationUrl)
+    const { connectionRecord } = await this.agent.modules.oob.receiveInvitationFromUrl(invitationUrl)
     if (!connectionRecord) {
       throw new Error(redText(Output.NoConnectionRecordFromOutOfBand))
     }
     return connectionRecord
   }
 
   private async waitForConnection(connectionRecord: ConnectionRecord) {
-    connectionRecord = await this.agent.connections.returnWhenIsConnected(connectionRecord.id)
+    connectionRecord = await this.agent.modules.connections.returnWhenIsConnected(connectionRecord.id)
     this.connected = true
     console.log(greenText(Output.ConnectionEstablished))
     return connectionRecord.id
@@ -46,17 +46,17 @@ export class Alice extends BaseAgent {
   }
 
   public async acceptCredentialOffer(credentialRecord: CredentialExchangeRecord) {
-    await this.agent.credentials.acceptOffer({
+    await this.agent.modules.credentials.acceptOffer({
       credentialRecordId: credentialRecord.id,
     })
   }
 
   public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
-    const requestedCredentials = await this.agent.proofs.selectCredentialsForRequest({
+    const requestedCredentials = await this.agent.modules.proofs.selectCredentialsForRequest({
       proofRecordId: proofRecord.id,
     })
 
-    await this.agent.proofs.acceptRequest({
+    await this.agent.modules.proofs.acceptRequest({
       proofRecordId: proofRecord.id,
       proofFormats: requestedCredentials.proofFormats,
     })
@@ -65,7 +65,7 @@ export class Alice extends BaseAgent {
 
   public async sendMessage(message: string) {
     const connectionRecord = await this.getConnectionRecord()
-    await this.agent.basicMessages.sendMessage(connectionRecord.id, message)
+    await this.agent.modules.basicMessages.sendMessage(connectionRecord.id, message)
   }
 
   public async exit() {

diff --git a/demo/src/AliceInquirer.ts b/demo/src/AliceInquirer.ts
@@ -1,4 +1,4 @@
-import type { CredentialExchangeRecord, ProofExchangeRecord } from '@credo-ts/core'
+import type { CredentialExchangeRecord, ProofExchangeRecord } from '@credo-ts/didcomm'
 
 import { clear } from 'console'
 import { textSync } from 'figlet'
@@ -72,7 +72,7 @@ export class AliceInquirer extends BaseInquirer {
   public async acceptCredentialOffer(credentialRecord: CredentialExchangeRecord) {
     const confirm = await prompt([this.inquireConfirmation(Title.CredentialOfferTitle)])
     if (confirm.options === ConfirmOptions.No) {
-      await this.alice.agent.credentials.declineOffer(credentialRecord.id)
+      await this.alice.agent.modules.credentials.declineOffer(credentialRecord.id)
     } else if (confirm.options === ConfirmOptions.Yes) {
       await this.alice.acceptCredentialOffer(credentialRecord)
     }
@@ -81,7 +81,7 @@ export class AliceInquirer extends BaseInquirer {
   public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
     const confirm = await prompt([this.inquireConfirmation(Title.ProofRequestTitle)])
     if (confirm.options === ConfirmOptions.No) {
-      await this.alice.agent.proofs.declineRequest({ proofRecordId: proofRecord.id })
+      await this.alice.agent.modules.proofs.declineRequest({ proofRecordId: proofRecord.id })
     } else if (confirm.options === ConfirmOptions.Yes) {
       await this.alice.acceptProofRequest(proofRecord)
     }

diff --git a/demo/src/BaseAgent.ts b/demo/src/BaseAgent.ts
@@ -1,4 +1,5 @@
 import type { InitConfig } from '@credo-ts/core'
+import type { DidCommModuleConfigOptions } from '@credo-ts/didcomm'
 import type { IndyVdrPoolConfig } from '@credo-ts/indy-vdr'
 
 import {
@@ -18,18 +19,18 @@ import {
   CheqdModule,
   CheqdModuleConfig,
 } from '@credo-ts/cheqd'
+import { DidsModule, Agent } from '@credo-ts/core'
 import {
   ConnectionsModule,
-  DidsModule,
   V2ProofProtocol,
   V2CredentialProtocol,
   ProofsModule,
   AutoAcceptProof,
   AutoAcceptCredential,
   CredentialsModule,
-  Agent,
   HttpOutboundTransport,
-} from '@credo-ts/core'
+  getDefaultDidcommModules,
+} from '@credo-ts/didcomm'
 import { IndyVdrIndyDidResolver, IndyVdrAnonCredsRegistry, IndyVdrModule } from '@credo-ts/indy-vdr'
 import { agentDependencies, HttpInboundTransport } from '@credo-ts/node'
 import { anoncreds } from '@hyperledger/anoncreds-nodejs'
@@ -68,18 +69,17 @@ export class BaseAgent {
         id: name,
         key: name,
       },
-      endpoints: [`http://localhost:${this.port}`],
     } satisfies InitConfig
 
     this.config = config
 
     this.agent = new Agent({
       config,
       dependencies: agentDependencies,
-      modules: getAskarAnonCredsIndyModules(),
+      modules: getAskarAnonCredsIndyModules({ endpoints: [`http://localhost:${this.port}`] }),
     })
-    this.agent.registerInboundTransport(new HttpInboundTransport({ port }))
-    this.agent.registerOutboundTransport(new HttpOutboundTransport())
+    this.agent.modules.didcomm.registerInboundTransport(new HttpInboundTransport({ port }))
+    this.agent.modules.didcomm.registerOutboundTransport(new HttpOutboundTransport())
   }
 
   public async initializeAgent() {
@@ -89,11 +89,12 @@ export class BaseAgent {
   }
 }
 
-function getAskarAnonCredsIndyModules() {
+function getAskarAnonCredsIndyModules(didcommConfig: DidCommModuleConfigOptions) {
   const legacyIndyCredentialFormatService = new LegacyIndyCredentialFormatService()
   const legacyIndyProofFormatService = new LegacyIndyProofFormatService()
 
   return {
+    ...getDefaultDidcommModules(didcommConfig),
     connections: new ConnectionsModule({
       autoAcceptConnections: true,
     }),

diff --git a/demo/src/Faber.ts b/demo/src/Faber.ts
@@ -1,9 +1,10 @@
 import type { RegisterCredentialDefinitionReturnStateFinished } from '@credo-ts/anoncreds'
-import type { ConnectionRecord, ConnectionStateChangedEvent } from '@credo-ts/core'
+import type { ConnectionRecord, ConnectionStateChangedEvent } from '@credo-ts/didcomm'
 import type { IndyVdrRegisterSchemaOptions, IndyVdrRegisterCredentialDefinitionOptions } from '@credo-ts/indy-vdr'
 import type BottomBar from 'inquirer/lib/ui/bottom-bar'
 
-import { ConnectionEventTypes, KeyType, TypedArrayEncoder, utils } from '@credo-ts/core'
+import { KeyType, TypedArrayEncoder, utils } from '@credo-ts/core'
+import { ConnectionEventTypes } from '@credo-ts/didcomm'
 import { ui } from 'inquirer'
 
 import { BaseAgent, indyNetworkConfig } from './BaseAgent'
@@ -58,7 +59,7 @@ export class Faber extends BaseAgent {
       throw Error(redText(Output.MissingConnectionRecord))
     }
 
-    const [connection] = await this.agent.connections.findAllByOutOfBandId(this.outOfBandId)
+    const [connection] = await this.agent.modules.connections.findAllByOutOfBandId(this.outOfBandId)
 
     if (!connection) {
       throw Error(redText(Output.MissingConnectionRecord))
@@ -68,7 +69,7 @@ export class Faber extends BaseAgent {
   }
 
   private async printConnectionInvite() {
-    const outOfBand = await this.agent.oob.createInvitation()
+    const outOfBand = await this.agent.modules.oob.createInvitation()
     this.outOfBandId = outOfBand.id
 
     console.log(
@@ -99,7 +100,7 @@ export class Faber extends BaseAgent {
         })
 
         // Also retrieve the connection record by invitation if the event has already fired
-        void this.agent.connections.findAllByOutOfBandId(outOfBandId).then(([connectionRecord]) => {
+        void this.agent.modules.connections.findAllByOutOfBandId(outOfBandId).then(([connectionRecord]) => {
           if (connectionRecord) {
             clearTimeout(timeoutId)
             resolve(connectionRecord)
@@ -110,7 +111,7 @@ export class Faber extends BaseAgent {
     const connectionRecord = await getConnectionRecord(this.outOfBandId)
 
     try {
-      await this.agent.connections.returnWhenIsConnected(connectionRecord.id)
+      await this.agent.modules.connections.returnWhenIsConnected(connectionRecord.id)
     } catch (e) {
       console.log(redText(`\nTimeout of 20 seconds reached.. Returning to home screen.\n`))
       return
@@ -200,7 +201,7 @@ export class Faber extends BaseAgent {
 
     this.ui.updateBottomBar('\nSending credential offer...\n')
 
-    await this.agent.credentials.offerCredential({
+    await this.agent.modules.credentials.offerCredential({
       connectionId: connectionRecord.id,
       protocolVersion: 'v2',
       credentialFormats: {
@@ -254,7 +255,7 @@ export class Faber extends BaseAgent {
     const proofAttribute = await this.newProofAttribute()
     await this.printProofFlow(greenText('\nRequesting proof...\n', false))
 
-    await this.agent.proofs.requestProof({
+    await this.agent.modules.proofs.requestProof({
       protocolVersion: 'v2',
       connectionId: connectionRecord.id,
       proofFormats: {
@@ -272,7 +273,7 @@ export class Faber extends BaseAgent {
 
   public async sendMessage(message: string) {
     const connectionRecord = await this.getConnectionRecord()
-    await this.agent.basicMessages.sendMessage(connectionRecord.id, message)
+    await this.agent.modules.basicMessages.sendMessage(connectionRecord.id, message)
   }
 
   public async exit() {