feat(present-proof): add support for aries RFC 510 (#1676)

Signed-off-by: Berend Sliedrecht <sliedrecht@berend.io>

packages/core/package.json

@@ -33,6 +33,9 @@
     "@stablelib/ed25519": "^1.0.2",
     "@stablelib/random": "^1.0.1",
     "@stablelib/sha256": "^1.0.1",
+    "@sphereon/pex": "^2.2.2",
+    "@sphereon/pex-models": "^2.1.2",
+    "@sphereon/ssi-types": "^0.17.5",
     "@types/ws": "^8.5.4",
     "abort-controller": "^3.0.0",
     "big-integer": "^1.6.51",

packages/core/src/agent/AgentModules.ts

@@ -7,6 +7,7 @@ import { CacheModule } from '../modules/cache'
 import { ConnectionsModule } from '../modules/connections'
 import { CredentialsModule } from '../modules/credentials'
 import { DidsModule } from '../modules/dids'
+import { DifPresentationExchangeModule } from '../modules/dif-presentation-exchange'
 import { DiscoverFeaturesModule } from '../modules/discover-features'
 import { GenericRecordsModule } from '../modules/generic-records'
 import { MessagePickupModule } from '../modules/message-pickup'
@@ -131,6 +132,7 @@ function getDefaultAgentModules() {
     oob: () => new OutOfBandModule(),
     w3cCredentials: () => new W3cCredentialsModule(),
     cache: () => new CacheModule(),
+    pex: () => new DifPresentationExchangeModule(),
   } as const
 }
 

packages/core/src/agent/__tests__/AgentModules.test.ts

@@ -5,6 +5,7 @@ import { CacheModule } from '../../modules/cache'
 import { ConnectionsModule } from '../../modules/connections'
 import { CredentialsModule } from '../../modules/credentials'
 import { DidsModule } from '../../modules/dids'
+import { DifPresentationExchangeModule } from '../../modules/dif-presentation-exchange'
 import { DiscoverFeaturesModule } from '../../modules/discover-features'
 import { GenericRecordsModule } from '../../modules/generic-records'
 import { MessagePickupModule } from '../../modules/message-pickup'
@@ -62,6 +63,7 @@ describe('AgentModules', () => {
         mediationRecipient: expect.any(MediationRecipientModule),
         messagePickup: expect.any(MessagePickupModule),
         basicMessages: expect.any(BasicMessagesModule),
+        pex: expect.any(DifPresentationExchangeModule),
         genericRecords: expect.any(GenericRecordsModule),
         discovery: expect.any(DiscoverFeaturesModule),
         dids: expect.any(DidsModule),
@@ -86,6 +88,7 @@ describe('AgentModules', () => {
         mediationRecipient: expect.any(MediationRecipientModule),
         messagePickup: expect.any(MessagePickupModule),
         basicMessages: expect.any(BasicMessagesModule),
+        pex: expect.any(DifPresentationExchangeModule),
         genericRecords: expect.any(GenericRecordsModule),
         discovery: expect.any(DiscoverFeaturesModule),
         dids: expect.any(DidsModule),
@@ -113,6 +116,7 @@ describe('AgentModules', () => {
         mediationRecipient: expect.any(MediationRecipientModule),
         messagePickup: expect.any(MessagePickupModule),
         basicMessages: expect.any(BasicMessagesModule),
+        pex: expect.any(DifPresentationExchangeModule),
         genericRecords: expect.any(GenericRecordsModule),
         discovery: expect.any(DiscoverFeaturesModule),
         dids: expect.any(DidsModule),

packages/core/src/decorators/attachment/Attachment.ts

@@ -4,6 +4,7 @@ import { Expose, Type } from 'class-transformer'
 import { IsDate, IsHash, IsInstance, IsInt, IsMimeType, IsOptional, IsString, ValidateNested } from 'class-validator'
 
 import { AriesFrameworkError } from '../../error'
+import { JsonValue } from '../../types'
 import { JsonEncoder } from '../../utils/JsonEncoder'
 import { uuid } from '../../utils/uuid'
 
@@ -19,7 +20,7 @@ export interface AttachmentOptions {
 
 export interface AttachmentDataOptions {
   base64?: string
-  json?: Record<string, unknown>
+  json?: JsonValue
   links?: string[]
   jws?: JwsDetachedFormat | JwsFlattenedDetachedFormat
   sha256?: string
@@ -40,7 +41,7 @@ export class AttachmentData {
    *  Directly embedded JSON data, when representing content inline instead of via links, and when the content is natively conveyable as JSON. Optional.
    */
   @IsOptional()
-  public json?: Record<string, unknown>
+  public json?: JsonValue
 
   /**
    * A list of zero or more locations at which the content may be fetched. Optional.

packages/core/src/modules/dif-presentation-exchange/DifPresentationExchangeError.ts

@@ -0,0 +1,13 @@
+import { AriesFrameworkError } from '../../error'
+
+export class DifPresentationExchangeError extends AriesFrameworkError {
+  public additionalMessages?: Array<string>
+
+  public constructor(
+    message: string,
+    { cause, additionalMessages }: { cause?: Error; additionalMessages?: Array<string> } = {}
+  ) {
+    super(message, { cause })
+    this.additionalMessages = additionalMessages
+  }
+}

packages/core/src/modules/dif-presentation-exchange/DifPresentationExchangeModule.ts

@@ -0,0 +1,25 @@
+import type { DependencyManager, Module } from '../../plugins'
+
+import { AgentConfig } from '../../agent/AgentConfig'
+
+import { DifPresentationExchangeService } from './DifPresentationExchangeService'
+
+/**
+ * @public
+ */
+export class DifPresentationExchangeModule implements Module {
+  /**
+   * Registers the dependencies of the presentation-exchange module on the dependency manager.
+   */
+  public register(dependencyManager: DependencyManager) {
+    // Warn about experimental module
+    dependencyManager
+      .resolve(AgentConfig)
+      .logger.warn(
+        "The 'DifPresentationExchangeModule' module is experimental and could have unexpected breaking changes. When using this module, make sure to use strict versions for all @aries-framework packages."
+      )
+
+    // service
+    dependencyManager.registerSingleton(DifPresentationExchangeService)
+  }
+}