fix: IndyProofFormatService, V1ProofService

Signed-off-by: NB Prasad Katkar <[email protected]>

Author: NB-PrasadKatkar

packages/core/src/modules/proofs/ProofService.ts

@@ -1,20 +1,17 @@
 import type { AgentMessage } from '../../agent/AgentMessage'
-import type { HandlerInboundMessage } from '../../agent/Handler'
 import type { InboundMessageContext } from '../../agent/models/InboundMessageContext'
+import type { CreateRequestAsResponseOptions } from './interface'
+import type { ProofProtocolVersion } from './models/ProofProtocolVersion'
 import type {
-  CreateRequestOptions,
-  RequestProofOptions,
-  CreateProposalOptions,
+  CreatePresentationOptions,
   CreateProposalAsResponseOptions,
-  CreateRequestAsResponseOptions,
-} from './interface'
-import type { ProofProtocolVersion } from './models/ProofProtocolVersion'
-import type { ProofRequest, RetrievedCredentials } from './protocol/v1/models'
-import type { PresentationPreview } from './protocol/v1/models/PresentationPreview'
+  CreateProposalOptions,
+  RequestProofOptions,
+} from './models/ServiceOptions'
+import type { RetrievedCredentials } from './protocol/v1/models'
 import type { ProofRecord } from './repository'
 import type { PresentationRecordType } from './repository/PresentationExchangeRecord'
 import type { ProofFormatService } from './v2/formats/ProofFormatService'
-import type { V2ProposePresentationHandler } from './v2/handlers/V2ProposePresentationHandler'
 
 import { ConsoleLogger, LogLevel } from '../../logger'
 
@@ -72,7 +69,7 @@ export abstract class ProofService {
    */
   abstract processProposal(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
 
-  abstract createRequest(options: CreateRequestOptions): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  abstract createRequest(options: RequestProofOptions): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
 
   abstract createRequestAsResponse(
     options: CreateRequestAsResponseOptions

packages/core/src/modules/proofs/formats/IndyProofFormatsServiceOptions.ts

@@ -0,0 +1,35 @@
+import type { RevocationInterval } from '../../credentials/models/RevocationInterval'
+import type { ProofRequest, RequestedAttribute, RequestedPredicate } from '../protocol/v1/models'
+import type {
+  PresentationPreview,
+  PresentationPreviewAttribute,
+  PresentationPreviewPredicate,
+} from '../protocol/v1/models/PresentationPreview'
+import type { ProofAttributeInfo } from '../protocol/v1/models/ProofAttributeInfo'
+import type { ProofPredicateInfo } from '../protocol/v1/models/ProofPredicateInfo'
+
+export interface IndyProposeProofFormat {
+  attributes?: PresentationPreviewAttribute[]
+  predicates?: PresentationPreviewPredicate[]
+  nonce: string
+  name: string
+  version: string
+  proofPreview?: PresentationPreview
+}
+
+export interface IndyRequestProofFormat {
+  name: string
+  version: string
+  nonce: string
+  nonRevoked?: RevocationInterval
+  ver?: '1.0' | '2.0'
+  requestedAttributes?: Record<string, ProofAttributeInfo> | Map<string, ProofAttributeInfo>
+  requestedPredicates?: Record<string, ProofPredicateInfo> | Map<string, ProofPredicateInfo>
+  proofRequest?: ProofRequest
+}
+
+export interface IndyPresentationProofFormat {
+  requestedAttributes?: Record<string, RequestedAttribute>
+  requestedPredicates?: Record<string, RequestedPredicate>
+  selfAttestedAttributes?: Record<string, string>
+}

packages/core/src/modules/proofs/formats/ProofFormatService.ts

@@ -26,7 +26,7 @@ export class ProofFormatSpec {
 }
 
 export interface ProofAttachmentFormat {
-  // format: ProofFormatSpec
+  format: ProofFormatSpec
   attachment: Attachment
 }
 
@@ -41,7 +41,8 @@ export interface ProcessProposalOptions {
 }
 
 export interface CreateRequestOptions {
-  attachId: string
+  attachId?: string
+  messageType: string
   proofRequest: ProofRequest
 }
 
@@ -52,7 +53,8 @@ export interface ProcessRequestOptions {
 }
 
 export interface CreatePresentationOptions {
-  attachId: string
+  attachId?: string
+  messageType: string
   attachData: AttachmentData
 }
 

packages/core/src/modules/proofs/formats/ProofFormats.ts

@@ -11,6 +11,7 @@ const INDY_ATTACH_ID = 'indy'
 const PRES_20_PROPOSAL = 'hlindy/[email protected]'
 const PRES_20_REQUEST = 'hlindy/[email protected]'
 const PRES_20_PROOF = 'hlindy/[email protected]'
+const V1_PROOF = 'v1_proof'
 
 const LD_ATTACH_ID = '...' // MJR-TODO
 const LD_PROPOSE_FORMAT = '...' // MJR-TODO
@@ -46,6 +47,11 @@ const V2JsonLdProofFormat: ProofFormatSpec = {
   format: LD_REQUEST_FORMAT,
 }
 
+const V1IndyProofFormat: ProofFormatSpec = {
+  attachmentId: INDY_ATTACH_ID,
+  format: V1_PROOF,
+}
+
 export const ATTACHMENT_FORMAT: V2ProofAttachmentFormat = {
   PRES_20_PROPOSAL: {
     indy: V2IndyProposeProofFormat,
@@ -59,6 +65,10 @@ export const ATTACHMENT_FORMAT: V2ProofAttachmentFormat = {
     indy: V2IndyProofFormat,
     ldproof: V2JsonLdProofFormat,
   },
+  V1_PROOF: {
+    indy: V1IndyProofFormat,
+    ldproof: V1IndyProofFormat,
+  },
 
   // MJR-TODO
   // CRED_20_REQUEST: {

packages/core/src/modules/proofs/formats/indy/IndyProofFormatService.ts

@@ -4,15 +4,17 @@ import type {
   CreateRequestOptions,
   ProcessProposalOptions,
   ProofAttachmentFormat,
+  ProofFormatSpec,
 } from '../ProofFormatService'
 
+import { Attachment, AttachmentData } from '../../../../decorators/attachment/Attachment'
+import { JsonEncoder } from '../../../../utils/JsonEncoder'
 import { ProofFormatService } from '../ProofFormatService'
-
-import { Attachment, AttachmentData } from 'packages/core/src/decorators/attachment/Attachment'
-import { JsonEncoder } from 'packages/core/src/utils'
+import { ATTACHMENT_FORMAT } from '../ProofFormats'
 
 export class IndyProofFormatService extends ProofFormatService {
   public createProposal(options: CreateProposalOptions): ProofAttachmentFormat {
+    // Handle format in service
     throw new Error('Method not implemented.')
   }
 
@@ -21,32 +23,46 @@ export class IndyProofFormatService extends ProofFormatService {
   }
 
   public createRequest(options: CreateRequestOptions): ProofAttachmentFormat {
+    const format: ProofFormatSpec = this.getFormatIdentifier(options.messageType)
+
     const { attachId, proofRequest } = options
     const attachment = new Attachment({
-      id: attachId,
+      id: attachId ? attachId : undefined,
       mimeType: 'application/json',
       data: new AttachmentData({
         base64: JsonEncoder.toBase64(proofRequest),
       }),
     })
-    return { attachment }
+    return { format, attachment }
   }
 
   public processRequest(options: ProcessRequestOptions): void {
     throw new Error('Method not implemented.')
   }
 
   public createPresentation(options: CreatePresentationOptions): ProofAttachmentFormat {
+    const format: ProofFormatSpec = this.getFormatIdentifier(options.messageType)
+
     const { attachId, attachData } = options
     const attachment = new Attachment({
-      id: attachId,
+      id: attachId ? attachId : undefined,
       mimeType: 'application/json',
       data: attachData,
     })
-    return { attachment }
+    return { format, attachment }
   }
 
   public processPresentation(options: ProcessPresentationOptions): void {
     throw new Error('Method not implemented.')
   }
+
+  /**
+   * Get attachment format identifier for format and message combination
+   *
+   * @param messageType Message type for which to return the format identifier
+   * @return V2CredentialFormatSpec - Issue credential attachment format identifier
+   */
+  public getFormatIdentifier(messageType: string): ProofFormatSpec {
+    return ATTACHMENT_FORMAT[messageType].indy
+  }
 }

packages/core/src/modules/proofs/models/ServiceOptions.ts

@@ -1,7 +1,7 @@
 import type { AutoAcceptProof, ProofRecord } from '..'
 import type { ConnectionRecord } from '../../connections'
 import type { ProofProtocolVersion } from './ProofProtocolVersion'
-import type { ProposeProofFormats } from './SharedOptions'
+import type { CreatePresentationFormats, ProposeProofFormats, RequestProofFormats } from './SharedOptions'
 
 // ----- Create Proposal ----- //
 export interface CreateProposalOptions {
@@ -21,10 +21,10 @@ export interface CreateProposalAsResponseOptions {
 
 // ----- Request Proof ----- //
 export interface RequestProofOptions {
-  connectionId: string
+  connectionRecord: ConnectionRecord
   protocolVersion: ProofProtocolVersion
-  proofFormats: V2ProposeProofFormat
-  proofRequestOptions: CreateProofRequestOptions
+  proofFormats: RequestProofFormats
+  // proofRequestOptions: CreateProofRequestOptions
   comment?: string
   autoAcceptProof?: AutoAcceptProof
 }
@@ -37,8 +37,9 @@ export interface CreateRequestAsResponseOptions {
 }
 
 // ----- Create Presentation ----- //
-export interface CreatePresentationOptions {
+export interface PresentationOptions {
   proofRecord: ProofRecord
   proofFormats: CreatePresentationFormats
+  comment?: string
   // TODO: add other options such as comment, etc...
 }

packages/core/src/modules/proofs/models/SharedOptions.ts

@@ -1,20 +1,27 @@
-import type { IndyProposeProofFormat } from '../protocol/v1/models/ProofFormatsInterfaces'
-
-/**
- * Moved to protocol/v1/models
- */
-// export interface IndyProposeProofFormat {
-//   attributes?: PresentationPreviewAttribute[]
-//   predicates?: PresentationPreviewPredicate[]
-//   nonce: string
-//   name: string
-//   version: string
-//   proofPreview?: PresentationPreview
-// }
+import type { RequestedCredentials } from '..'
+import type {
+  IndyPresentationProofFormat,
+  IndyProposeProofFormat,
+  IndyRequestProofFormat,
+} from '../formats/IndyProofFormatsServiceOptions'
 
 export interface ProposeProofFormats {
   // If you want to propose an indy proof without attributes or
   // any of the other properties you should pass an empty object
   indy?: IndyProposeProofFormat
   presentationExchange?: never // TBD
 }
+
+export interface RequestProofFormats {
+  // If you want to propose an indy proof without attributes or
+  // any of the other properties you should pass an empty object
+  indy?: IndyRequestProofFormat
+  presentationExchange?: never // TBD
+}
+
+export interface CreatePresentationFormats {
+  // If you want to propose an indy proof without attributes or
+  // any of the other properties you should pass an empty object
+  indy?: RequestedCredentials
+  presentationExchange?: never // TBD
+}

packages/core/src/modules/proofs/protocol/v1/V1LegacyProofService.ts

@@ -2,10 +2,10 @@ import type { AgentMessage } from '../../../../agent/AgentMessage'
 import type { InboundMessageContext } from '../../../../agent/models/InboundMessageContext'
 import type { Logger } from '../../../../logger'
 import type { ConnectionRecord } from '../../../connections'
-import type { PresentationPreview, PresentationPreviewAttribute } from './models/PresentationPreview'
-import type { AutoAcceptProof } from '../../models/ProofAutoAcceptType'
 import type { ProofStateChangedEvent } from '../../ProofEvents'
+import type { AutoAcceptProof } from '../../models/ProofAutoAcceptType'
 import type { PresentationProblemReportMessage } from './messages/PresentationProblemReportMessage'
+import type { PresentationPreview, PresentationPreviewAttribute } from './models/PresentationPreview'
 import type { CredDef, IndyProof, Schema } from 'indy-sdk'
 
 import { validateOrReject } from 'class-validator'
@@ -26,8 +26,8 @@ import { CredentialUtils, Credential, CredentialRepository } from '../../../cred
 import { IndyHolderService, IndyVerifierService } from '../../../indy'
 import { IndyLedgerService } from '../../../ledger/services/IndyLedgerService'
 import { ProofEventTypes } from '../../ProofEvents'
-import { ProofState } from '../../models/ProofState'
 import { PresentationProblemReportError, PresentationProblemReportReason } from '../../errors'
+import { ProofState } from '../../models/ProofState'
 import { ProofRepository } from '../../repository'
 import { ProofRecord } from '../../repository/ProofRecord'