refactor(proofs): remove ProofProtocolVersion enum in 0.3.0-pre (openwallet-foundation#1062)

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

Author: NB-MikeRichardson

demo/src/Faber.ts

@@ -5,7 +5,6 @@ import type BottomBar from 'inquirer/lib/ui/bottom-bar'
 import {
   AttributeFilter,
   ProofAttributeInfo,
-  ProofProtocolVersion,
   utils,
   V1CredentialPreview,
   ConnectionEventTypes,
@@ -190,7 +189,7 @@ export class Faber extends BaseAgent {
     await this.printProofFlow(greenText('\nRequesting proof...\n', false))
 
     await this.agent.proofs.requestProof({
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
       connectionId: connectionRecord.id,
       proofFormats: {
         indy: {

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

@@ -164,7 +164,7 @@ export class ProofsApi<
    * to include in the message
    * @returns Proof record associated with the sent proposal message
    */
-  public async proposeProof(options: ProposeProofOptions): Promise<ProofRecord> {
+  public async proposeProof(options: ProposeProofOptions<PFs, PSs>): Promise<ProofRecord> {
     const service = this.getService(options.protocolVersion)
 
     const { connectionId } = options
@@ -247,7 +247,7 @@ export class ProofsApi<
    * @param options multiple properties like connection id, protocol version, proof Formats to build the proof request
    * @returns Proof record associated with the sent request message
    */
-  public async requestProof(options: RequestProofOptions): Promise<ProofRecord> {
+  public async requestProof(options: RequestProofOptions<PFs, PSs>): Promise<ProofRecord> {
     const service = this.getService(options.protocolVersion)
 
     const connection = await this.connectionService.getById(this.agentContext, options.connectionId)
@@ -456,6 +456,7 @@ export class ProofsApi<
   /**
    * Create a {@link RetrievedCredentials} object. Given input proof request and presentation proposal,
    * use credentials in the wallet to build indy requested credentials object for input to proof creation.
+   *
    * If restrictions allow, self attested attributes will be used.
    *
    * @param options multiple properties like proof record id and optional configuration

packages/core/src/modules/proofs/__tests__/V1ProofService.test.ts

@@ -18,7 +18,6 @@ import { IndyLedgerService } from '../../ledger/services'
 import { ProofEventTypes } from '../ProofEvents'
 import { PresentationProblemReportReason } from '../errors/PresentationProblemReportReason'
 import { IndyProofFormatService } from '../formats/indy/IndyProofFormatService'
-import { ProofProtocolVersion } from '../models/ProofProtocolVersion'
 import { ProofState } from '../models/ProofState'
 import { V1ProofService } from '../protocol/v1'
 import { INDY_PROOF_REQUEST_ATTACHMENT_ID, V1RequestPresentationMessage } from '../protocol/v1/messages'
@@ -83,7 +82,7 @@ const mockProofRecord = ({
   })
 
   const proofRecord = new ProofRecord({
-    protocolVersion: ProofProtocolVersion.V1,
+    protocolVersion: 'v1',
     id,
     state: state || ProofState.RequestSent,
     threadId: threadId ?? requestPresentationMessage.id,

packages/core/src/modules/proofs/__tests__/V2ProofService.test.ts

@@ -16,7 +16,6 @@ import { ProofEventTypes } from '../ProofEvents'
 import { PresentationProblemReportReason } from '../errors/PresentationProblemReportReason'
 import { V2_INDY_PRESENTATION, V2_INDY_PRESENTATION_REQUEST } from '../formats/ProofFormatConstants'
 import { IndyProofFormatService } from '../formats/indy/IndyProofFormatService'
-import { ProofProtocolVersion } from '../models/ProofProtocolVersion'
 import { ProofState } from '../models/ProofState'
 import { V2ProofService } from '../protocol/v2/V2ProofService'
 import { V2PresentationProblemReportMessage, V2RequestPresentationMessage } from '../protocol/v2/messages'
@@ -85,7 +84,7 @@ const mockProofRecord = ({
   })
 
   const proofRecord = new ProofRecord({
-    protocolVersion: ProofProtocolVersion.V2,
+    protocolVersion: 'v2',
     id,
     state: state || ProofState.RequestSent,
     threadId: threadId ?? requestPresentationMessage.id,

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

@@ -1,4 +1,3 @@
 export * from './GetRequestedCredentialsConfig'
 export * from './ProofAutoAcceptType'
-export * from './ProofProtocolVersion'
 export * from './ProofState'

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

@@ -55,7 +55,6 @@ import { IndyProofFormatService } from '../../formats/indy/IndyProofFormatServic
 import { IndyProofUtils } from '../../formats/indy/IndyProofUtils'
 import { ProofRequest } from '../../formats/indy/models/ProofRequest'
 import { RequestedCredentials } from '../../formats/indy/models/RequestedCredentials'
-import { ProofProtocolVersion } from '../../models/ProofProtocolVersion'
 import { ProofState } from '../../models/ProofState'
 import { ProofRecord } from '../../repository/ProofRecord'
 import { ProofRepository } from '../../repository/ProofRepository'
@@ -148,7 +147,7 @@ export class V1ProofService extends ProofService<[IndyProofFormat]> {
       parentThreadId: proposalMessage.thread?.parentThreadId,
       state: ProofState.ProposalSent,
       autoAcceptProof: options?.autoAcceptProof,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
 
     await this.didCommMessageRepository.saveOrUpdateAgentMessage(agentContext, {
@@ -244,7 +243,7 @@ export class V1ProofService extends ProofService<[IndyProofFormat]> {
         threadId: proposalMessage.threadId,
         parentThreadId: proposalMessage.thread?.parentThreadId,
         state: ProofState.ProposalReceived,
-        protocolVersion: ProofProtocolVersion.V1,
+        protocolVersion: 'v1',
       })
 
       // Assert
@@ -337,7 +336,7 @@ export class V1ProofService extends ProofService<[IndyProofFormat]> {
       parentThreadId: requestPresentationMessage.thread?.parentThreadId,
       state: ProofState.RequestSent,
       autoAcceptProof: options?.autoAcceptProof,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
 
     await this.didCommMessageRepository.saveOrUpdateAgentMessage(agentContext, {
@@ -424,7 +423,7 @@ export class V1ProofService extends ProofService<[IndyProofFormat]> {
         threadId: proofRequestMessage.threadId,
         parentThreadId: proofRequestMessage.thread?.parentThreadId,
         state: ProofState.RequestReceived,
-        protocolVersion: ProofProtocolVersion.V1,
+        protocolVersion: 'v1',
       })
 
       await this.didCommMessageRepository.saveOrUpdateAgentMessage(messageContext.agentContext, {

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

@@ -6,7 +6,6 @@ import type { PresentationPreview } from '../models/V1PresentationPreview'
 import { setupProofsTest, waitForProofRecord } from '../../../../../../tests/helpers'
 import testLogger from '../../../../../../tests/logger'
 import { DidCommMessageRepository } from '../../../../../storage/didcomm'
-import { ProofProtocolVersion } from '../../../models/ProofProtocolVersion'
 import { ProofState } from '../../../models/ProofState'
 import { V1PresentationMessage, V1ProposePresentationMessage, V1RequestPresentationMessage } from '../messages'
 
@@ -44,7 +43,7 @@ describe('Present Proof', () => {
 
     aliceProofRecord = await aliceAgent.proofs.proposeProof({
       connectionId: aliceConnection.id,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
       proofFormats: {
         indy: {
           name: 'ProofRequest',
@@ -100,7 +99,7 @@ describe('Present Proof', () => {
       id: expect.anything(),
       threadId: faberProofRecord.threadId,
       state: ProofState.ProposalReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 
@@ -146,7 +145,7 @@ describe('Present Proof', () => {
       id: expect.anything(),
       threadId: faberProofRecord.threadId,
       state: ProofState.RequestReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 
@@ -207,7 +206,7 @@ describe('Present Proof', () => {
     expect(faberProofRecord).toMatchObject({
       threadId: faberProofRecord.threadId,
       state: ProofState.PresentationReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 

packages/core/src/modules/proofs/protocol/v1/__tests__/indy-proof-presentation.test.ts

@@ -1,13 +1,14 @@
 import type { Agent } from '../../../../../agent/Agent'
 import type { ConnectionRecord } from '../../../../connections/repository/ConnectionRecord'
 import type { ProposeProofOptions } from '../../../ProofsApiOptions'
+import type { IndyProofFormat } from '../../../formats/indy/IndyProofFormat'
 import type { ProofRecord } from '../../../repository/ProofRecord'
+import type { V1ProofService } from '../V1ProofService'
 import type { PresentationPreview } from '../models/V1PresentationPreview'
 
 import { setupProofsTest, waitForProofRecord } from '../../../../../../tests/helpers'
 import testLogger from '../../../../../../tests/logger'
 import { DidCommMessageRepository } from '../../../../../storage'
-import { ProofProtocolVersion } from '../../../models/ProofProtocolVersion'
 import { ProofState } from '../../../models/ProofState'
 import { V1ProposePresentationMessage } from '../messages'
 
@@ -38,9 +39,13 @@ describe('Present Proof', () => {
   test(`Alice Creates and sends Proof Proposal to Faber`, async () => {
     testLogger.test('Alice sends proof proposal to Faber')
 
-    const proposeOptions: ProposeProofOptions = {
+    const faberProofRecordPromise = waitForProofRecord(faberAgent, {
+      state: ProofState.ProposalReceived,
+    })
+
+    await aliceAgent.proofs.proposeProof({
       connectionId: aliceConnection.id,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
       proofFormats: {
         indy: {
           name: 'ProofRequest',
@@ -51,14 +56,8 @@ describe('Present Proof', () => {
         },
       },
       comment: 'V1 propose proof test',
-    }
-
-    const faberProofRecordPromise = waitForProofRecord(faberAgent, {
-      state: ProofState.ProposalReceived,
     })
 
-    await aliceAgent.proofs.proposeProof(proposeOptions)
-
     testLogger.test('Faber waits for presentation from Alice')
     faberProofRecord = await faberProofRecordPromise
 
@@ -102,7 +101,7 @@ describe('Present Proof', () => {
       id: expect.anything(),
       threadId: faberProofRecord.threadId,
       state: ProofState.ProposalReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 })

packages/core/src/modules/proofs/protocol/v1/__tests__/indy-proof-proposal.test.ts

@@ -1,13 +1,14 @@
 import type { Agent } from '../../../../../agent/Agent'
 import type { ConnectionRecord } from '../../../../connections/repository/ConnectionRecord'
-import type { ProposeProofOptions, AcceptProposalOptions } from '../../../ProofsApiOptions'
+import type { AcceptProposalOptions, ProposeProofOptions } from '../../../ProofsApiOptions'
+import type { IndyProofFormat } from '../../../formats/indy/IndyProofFormat'
 import type { ProofRecord } from '../../../repository/ProofRecord'
+import type { V1ProofService } from '../V1ProofService'
 import type { PresentationPreview } from '../models/V1PresentationPreview'
 
 import { setupProofsTest, waitForProofRecord } from '../../../../../../tests/helpers'
 import testLogger from '../../../../../../tests/logger'
 import { DidCommMessageRepository } from '../../../../../storage/didcomm'
-import { ProofProtocolVersion } from '../../../models/ProofProtocolVersion'
 import { ProofState } from '../../../models/ProofState'
 import { V1ProposePresentationMessage, V1RequestPresentationMessage } from '../messages'
 
@@ -39,9 +40,13 @@ describe('Present Proof', () => {
   test(`Alice Creates and sends Proof Proposal to Faber`, async () => {
     testLogger.test('Alice sends proof proposal to Faber')
 
-    const proposeOptions: ProposeProofOptions = {
+    const faberProofRecordPromise = waitForProofRecord(faberAgent, {
+      state: ProofState.ProposalReceived,
+    })
+
+    aliceProofRecord = await aliceAgent.proofs.proposeProof({
       connectionId: aliceConnection.id,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
       proofFormats: {
         indy: {
           name: 'ProofRequest',
@@ -52,14 +57,8 @@ describe('Present Proof', () => {
         },
       },
       comment: 'V1 propose proof test',
-    }
-
-    const faberProofRecordPromise = waitForProofRecord(faberAgent, {
-      state: ProofState.ProposalReceived,
     })
 
-    aliceProofRecord = await aliceAgent.proofs.proposeProof(proposeOptions)
-
     testLogger.test('Faber waits for presentation from Alice')
     faberProofRecord = await faberProofRecordPromise
 
@@ -102,7 +101,7 @@ describe('Present Proof', () => {
       id: expect.anything(),
       threadId: faberProofRecord.threadId,
       state: ProofState.ProposalReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 
@@ -150,7 +149,7 @@ describe('Present Proof', () => {
       id: expect.anything(),
       threadId: faberProofRecord.threadId,
       state: ProofState.RequestReceived,
-      protocolVersion: ProofProtocolVersion.V1,
+      protocolVersion: 'v1',
     })
   })
 })