fix: miscellaneous issue credential v2 fixes (#769)

Signed-off-by: Mike Richardson <[email protected]>

packages/core/src/modules/credentials/CredentialServiceOptions.ts

@@ -48,7 +48,6 @@ export interface ServiceAcceptOfferOptions extends AcceptOfferOptions {
 export interface ServiceOfferCredentialOptions extends OfferCredentialOptions {
   connectionId?: string
   attachId?: string
-  // offerAttachment?: Attachment
 }
 
 export interface ServiceAcceptProposalOptions extends AcceptProposalOptions {
@@ -71,6 +70,7 @@ export interface ServiceRequestCredentialOptions extends RequestCredentialOption
   attachId?: string
   offerAttachment?: Attachment
   requestAttachment?: Attachment
+  holderDid?: string
 }
 
 export interface ServiceAcceptCredentialOptions {

packages/core/src/modules/credentials/CredentialsModule.ts

@@ -241,8 +241,9 @@ export class CredentialsModule implements CredentialsModule {
       const requestOptions: RequestCredentialOptions = {
         comment: options.comment,
         autoAcceptCredential: options.autoAcceptCredential,
+        holderDid: connection.did,
       }
-      const { message, credentialRecord } = await service.createRequest(record, requestOptions, connection.did)
+      const { message, credentialRecord } = await service.createRequest(record, requestOptions)
 
       await this.didCommMessageRepo.saveAgentMessage({
         agentMessage: message,
@@ -272,12 +273,9 @@ export class CredentialsModule implements CredentialsModule {
       const requestOptions: RequestCredentialOptions = {
         comment: options.comment,
         autoAcceptCredential: options.autoAcceptCredential,
+        holderDid: ourService.recipientKeys[0],
       }
-      const { message, credentialRecord } = await service.createRequest(
-        record,
-        requestOptions,
-        ourService.recipientKeys[0]
-      )
+      const { message, credentialRecord } = await service.createRequest(record, requestOptions)
 
       // Set and save ~service decorator to record (to remember our verkey)
       message.service = ourService
@@ -349,6 +347,9 @@ export class CredentialsModule implements CredentialsModule {
     if (!options.connectionId) {
       throw new AriesFrameworkError('Missing connectionId on offerCredential')
     }
+    if (!options.protocolVersion) {
+      throw new AriesFrameworkError('Missing protocol version in offerCredential')
+    }
     const connection = await this.connectionService.getById(options.connectionId)
 
     const service = this.getService(options.protocolVersion)

packages/core/src/modules/credentials/CredentialsModuleOptions.ts

@@ -26,8 +26,6 @@ interface ProposeCredentialOptions extends BaseOptions {
 }
 
 interface AcceptProposalOptions extends BaseOptions {
-  connectionId?: string
-  protocolVersion: CredentialProtocolVersion
   credentialRecordId: string
   credentialFormats: FormatServiceAcceptProposeCredentialFormats
 }
@@ -57,6 +55,7 @@ interface NegotiateOfferOptions extends ProposeCredentialOptions {
 interface RequestCredentialOptions extends BaseOptions {
   connectionId?: string
   credentialFormats?: FormatServiceRequestCredentialFormats
+  holderDid?: string
 }
 
 interface AcceptRequestOptions extends BaseOptions {

packages/core/src/modules/credentials/__tests__/V1CredentialService.cred.test.ts

@@ -292,8 +292,8 @@ describe('CredentialService', () => {
       // mock offer so that the request works
 
       // when
-      const options: RequestCredentialOptions = {}
-      await credentialService.createRequest(credentialRecord, options, 'holderDid')
+      const options: RequestCredentialOptions = { holderDid: 'holderDid' }
+      await credentialService.createRequest(credentialRecord, options)
 
       // then
       expect(repositoryUpdateSpy).toHaveBeenCalledTimes(1)
@@ -310,14 +310,11 @@ describe('CredentialService', () => {
       const options: RequestCredentialOptions = {
         connectionId: credentialRecord.connectionId,
         comment: 'credential request comment',
+        holderDid: 'holderDid',
       }
 
       // when
-      const { message: credentialRequest } = await credentialService.createRequest(
-        credentialRecord,
-        options,
-        'holderDid'
-      )
+      const { message: credentialRequest } = await credentialService.createRequest(credentialRecord, options)
 
       // then
       expect(credentialRequest.toJSON()).toMatchObject({
@@ -345,7 +342,7 @@ describe('CredentialService', () => {
       await Promise.all(
         invalidCredentialStates.map(async (state) => {
           await expect(
-            credentialService.createRequest(mockCredentialRecord({ state }), {}, 'holderDid')
+            credentialService.createRequest(mockCredentialRecord({ state }), { holderDid: 'holderDid' })
           ).rejects.toThrowError(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
         })
       )

packages/core/src/modules/credentials/__tests__/V2CredentialService.cred.test.ts

@@ -293,11 +293,12 @@ describe('CredentialService', () => {
 
       const requestOptions: RequestCredentialOptions = {
         credentialFormats: v2CredentialRequest,
+        holderDid: 'holderDid',
       }
 
       // when
 
-      await credentialService.createRequest(credentialRecord, requestOptions, 'holderDid')
+      await credentialService.createRequest(credentialRecord, requestOptions)
 
       // then
       expect(repositoryUpdateSpy).toHaveBeenCalledTimes(1)
@@ -314,13 +315,10 @@ describe('CredentialService', () => {
       const options: RequestCredentialOptions = {
         connectionId: credentialRecord.connectionId,
         comment: 'credential request comment',
+        holderDid: 'holderDid',
       }
       // when
-      const { message: credentialRequest } = await credentialService.createRequest(
-        credentialRecord,
-        options,
-        'holderDid'
-      )
+      const { message: credentialRequest } = await credentialService.createRequest(credentialRecord, options)
 
       // then
       expect(credentialRequest.toJSON()).toMatchObject({
@@ -348,7 +346,7 @@ describe('CredentialService', () => {
       await Promise.all(
         invalidCredentialStates.map(async (state) => {
           await expect(
-            credentialService.createRequest(mockCredentialRecord({ state }), {}, 'mockDid')
+            credentialService.createRequest(mockCredentialRecord({ state }), { holderDid: 'mockDid' })
           ).rejects.toThrowError(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
         })
       )

packages/core/src/modules/credentials/composeAutoAccept.ts

@@ -0,0 +1,15 @@
+/**
+ * Returns the credential auto accept config based on priority:
+ *	- The record config takes first priority
+ *	- Otherwise the agent config
+ *	- Otherwise {@link AutoAcceptCredential.Never} is returned
+ */
+
+import { AutoAcceptCredential } from './CredentialAutoAcceptType'
+
+export function composeAutoAccept(
+  recordConfig: AutoAcceptCredential | undefined,
+  agentConfig: AutoAcceptCredential | undefined
+) {
+  return recordConfig ?? agentConfig ?? AutoAcceptCredential.Never
+}

packages/core/src/modules/credentials/formats/indy/IndyCredentialFormatService.ts

@@ -19,7 +19,6 @@ import type { V1CredentialPreview } from '../../protocol/v1/V1CredentialPreview'
 import type { CredentialExchangeRecord } from '../../repository/CredentialExchangeRecord'
 import type {
   FormatServiceCredentialAttachmentFormats,
-  CredentialFormatSpec,
   HandlerAutoAcceptOptions,
   FormatServiceOfferAttachmentFormats,
   FormatServiceProposeAttachmentFormats,
@@ -38,15 +37,16 @@ import { uuid } from '../../../../utils/uuid'
 import { IndyHolderService, IndyIssuerService } from '../../../indy'
 import { IndyLedgerService } from '../../../ledger'
 import { AutoAcceptCredential } from '../../CredentialAutoAcceptType'
-import { CredentialResponseCoordinator } from '../../CredentialResponseCoordinator'
 import { CredentialUtils } from '../../CredentialUtils'
 import { CredentialFormatType } from '../../CredentialsModuleOptions'
+import { composeAutoAccept } from '../../composeAutoAccept'
 import { CredentialProblemReportError, CredentialProblemReportReason } from '../../errors'
 import { V2CredentialPreview } from '../../protocol/v2/V2CredentialPreview'
 import { CredentialMetadataKeys } from '../../repository/CredentialMetadataTypes'
 import { CredentialRepository } from '../../repository/CredentialRepository'
 import { CredentialFormatService } from '../CredentialFormatService'
 import { CredPropose } from '../models/CredPropose'
+import { CredentialFormatSpec } from '../models/CredentialFormatServiceOptions'
 
 @scoped(Lifecycle.ContainerScoped)
 export class IndyCredentialFormatService extends CredentialFormatService {
@@ -85,6 +85,7 @@ export class IndyCredentialFormatService extends CredentialFormatService {
       attachId: this.generateId(),
       format: 'hlindy/[email protected]',
     }
+
     if (!options.credentialFormats.indy?.payload) {
       throw new AriesFrameworkError('Missing payload in createProposal')
     }
@@ -111,26 +112,25 @@ export class IndyCredentialFormatService extends CredentialFormatService {
     options: ServiceAcceptProposalOptions,
     credentialRecord: CredentialExchangeRecord
   ): Promise<void> {
-    let credPropose = options.proposalAttachment?.getDataAsJson<CredPropose>()
-    credPropose = JsonTransformer.fromJSON(credPropose, CredPropose)
-
-    if (!credPropose) {
+    const credProposalJson = options.proposalAttachment?.getDataAsJson<CredPropose>()
+    if (!credProposalJson) {
       throw new AriesFrameworkError('Missing indy credential proposal data payload')
     }
-    await MessageValidator.validate(credPropose)
+    const credProposal = JsonTransformer.fromJSON(credProposalJson, CredPropose)
+    await MessageValidator.validate(credProposal)
 
-    if (credPropose.credentialDefinitionId) {
+    if (credProposal.credentialDefinitionId) {
       options.credentialFormats = {
         indy: {
-          credentialDefinitionId: credPropose?.credentialDefinitionId,
+          credentialDefinitionId: credProposal?.credentialDefinitionId,
           attributes: [],
         },
       }
     }
 
     credentialRecord.metadata.set(CredentialMetadataKeys.IndyCredential, {
-      schemaId: credPropose.schemaId,
-      credentialDefinitionId: credPropose.credentialDefinitionId,
+      schemaId: credProposal.schemaId,
+      credentialDefinitionId: credProposal.credentialDefinitionId,
     })
   }
 
@@ -143,10 +143,10 @@ export class IndyCredentialFormatService extends CredentialFormatService {
    *
    */
   public async createOffer(options: ServiceOfferCredentialOptions): Promise<FormatServiceOfferAttachmentFormats> {
-    const formats: CredentialFormatSpec = {
+    const formats = new CredentialFormatSpec({
       attachId: this.generateId(),
       format: 'hlindy/[email protected]',
-    }
+    })
     const offer = await this.createCredentialOffer(options)
 
     let preview: V2CredentialPreview | undefined
@@ -195,24 +195,29 @@ export class IndyCredentialFormatService extends CredentialFormatService {
    */
   public async createRequest(
     options: ServiceRequestCredentialOptions,
-    credentialRecord: CredentialExchangeRecord,
-    holderDid: string
+    credentialRecord: CredentialExchangeRecord
   ): Promise<FormatServiceCredentialAttachmentFormats> {
     if (!options.offerAttachment) {
       throw new AriesFrameworkError(
         `Missing attachment from offer message, credential record id = ${credentialRecord.id}`
       )
     }
+
+    if (!options.holderDid) {
+      throw new AriesFrameworkError(
+        `Missing holder DID from offer message, credential record id = ${credentialRecord.id}`
+      )
+    }
     const offer = options.offerAttachment.getDataAsJson<CredOffer>()
     const credDef = await this.getCredentialDefinition(offer)
 
-    const { credReq, credReqMetadata } = await this.createIndyCredentialRequest(offer, credDef, holderDid)
+    const { credReq, credReqMetadata } = await this.createIndyCredentialRequest(offer, credDef, options.holderDid)
     credentialRecord.metadata.set(CredentialMetadataKeys.IndyRequest, credReqMetadata)
 
-    const formats: CredentialFormatSpec = {
+    const formats = new CredentialFormatSpec({
       attachId: this.generateId(),
       format: 'hlindy/[email protected]',
-    }
+    })
 
     const attachmentId = options.attachId ?? formats.attachId
     const requestAttach: Attachment = this.getFormatData(credReq, attachmentId)
@@ -375,10 +380,10 @@ export class IndyCredentialFormatService extends CredentialFormatService {
       credentialValues: CredentialUtils.convertAttributesToValues(credentialAttributes),
     })
 
-    const formats: CredentialFormatSpec = {
+    const formats = new CredentialFormatSpec({
       attachId: this.generateId(),
       format: 'hlindy/[email protected]',
-    }
+    })
 
     const attachmentId = options.attachId ? options.attachId : formats.attachId
     const issueAttachment = this.getFormatData(credential, attachmentId)
@@ -439,7 +444,7 @@ export class IndyCredentialFormatService extends CredentialFormatService {
    */
 
   public shouldAutoRespondToProposal(handlerOptions: HandlerAutoAcceptOptions): boolean {
-    const autoAccept = CredentialResponseCoordinator.composeAutoAccept(
+    const autoAccept = composeAutoAccept(
       handlerOptions.credentialRecord.autoAcceptCredential,
       handlerOptions.autoAcceptType
     )
@@ -463,10 +468,7 @@ export class IndyCredentialFormatService extends CredentialFormatService {
  */
 
   public shouldAutoRespondToRequest(options: HandlerAutoAcceptOptions): boolean {
-    const autoAccept = CredentialResponseCoordinator.composeAutoAccept(
-      options.credentialRecord.autoAcceptCredential,
-      options.autoAcceptType
-    )
+    const autoAccept = composeAutoAccept(options.credentialRecord.autoAcceptCredential, options.autoAcceptType)
 
     if (!options.requestAttachment) {
       throw new AriesFrameworkError(`Missing Request Attachment for Credential Record ${options.credentialRecord.id}`)
@@ -489,10 +491,7 @@ export class IndyCredentialFormatService extends CredentialFormatService {
    */
 
   public shouldAutoRespondToCredential(options: HandlerAutoAcceptOptions): boolean {
-    const autoAccept = CredentialResponseCoordinator.composeAutoAccept(
-      options.credentialRecord.autoAcceptCredential,
-      options.autoAcceptType
-    )
+    const autoAccept = composeAutoAccept(options.credentialRecord.autoAcceptCredential, options.autoAcceptType)
 
     if (autoAccept === AutoAcceptCredential.ContentApproved) {
       if (options.credentialAttachment) {

packages/core/src/modules/credentials/formats/models/CredentialFormatServiceOptions.ts

@@ -41,6 +41,12 @@ export interface IndyIssueCredentialFormat {
 }
 
 export class CredentialFormatSpec {
+  public constructor(options: { attachId: string; format: string }) {
+    if (options) {
+      this.attachId = options.attachId
+      this.format = options.format
+    }
+  }
   @Expose({ name: 'attach_id' })
   @IsString()
   public attachId!: string

packages/core/src/modules/credentials/index.ts

@@ -7,4 +7,3 @@ export * from './CredentialState'
 export * from './CredentialEvents'
 export * from './CredentialAutoAcceptType'
 export * from './CredentialProtocolVersion'
-export * from './CredentialResponseCoordinator'