feat: default return route (#1327)

Signed-off-by: Mike Richardson <mike.richardson@ontario.ca>

packages/anoncreds/src/protocols/proofs/v1/__tests__/v1-connectionless-proofs.e2e.test.ts

@@ -43,7 +43,8 @@ describe('V1 Proofs - Connectionless - Indy', () => {
     }
   })
 
-  test('Faber starts with connection-less proof requests to Alice', async () => {
+  // new method to test the return route and mediator together
+  const connectionlessTest = async (returnRoute?: boolean) => {
     const {
       holderAgent: aliceAgent,
       issuerAgent: faberAgent,
@@ -134,6 +135,7 @@ describe('V1 Proofs - Connectionless - Indy', () => {
 
     await aliceAgent.proofs.acceptRequest({
       proofRecordId: aliceProofExchangeRecord.id,
+      useReturnRoute: returnRoute,
       proofFormats: { indy: requestedCredentials.proofFormats.indy },
     })
 
@@ -143,6 +145,7 @@ describe('V1 Proofs - Connectionless - Indy', () => {
       state: ProofState.PresentationReceived,
     })
 
+    const sentPresentationMessage = aliceAgent.proofs.findPresentationMessage(aliceProofExchangeRecord.id)
     // assert presentation is valid
     expect(faberProofExchangeRecord.isVerified).toBe(true)
 
@@ -154,6 +157,11 @@ describe('V1 Proofs - Connectionless - Indy', () => {
       threadId: aliceProofExchangeRecord.threadId,
       state: ProofState.Done,
     })
+    return sentPresentationMessage
+  }
+
+  test('Faber starts with connection-less proof requests to Alice', async () => {
+    await connectionlessTest()
   })
 
   test('Faber starts with connection-less proof requests to Alice with auto-accept enabled', async () => {

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

@@ -550,7 +550,7 @@ export class CredentialsApi<CPs extends CredentialProtocol[]> implements Credent
           serviceParams: {
             service: recipientService.resolvedDidCommService,
             senderKey: ourService.resolvedDidCommService.recipientKeys[0],
-            returnRoute: true,
+            returnRoute: false, // hard wire to be false since it's the end of the protocol so not needed here
           },
         })
       )

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

@@ -341,26 +341,23 @@ export class ProofsApi<PPs extends ProofProtocol[]> implements ProofsApi<PPs> {
         autoAcceptProof: options.autoAcceptProof,
         goalCode: options.goalCode,
       })
-
       // Set and save ~service decorator to record (to remember our verkey)
       message.service = ourService
       await this.didCommMessageRepository.saveOrUpdateAgentMessage(this.agentContext, {
         agentMessage: message,
         role: DidCommMessageRole.Sender,
         associatedRecordId: proofRecord.id,
       })
-
       await this.messageSender.sendMessageToService(
         new OutboundMessageContext(message, {
           agentContext: this.agentContext,
           serviceParams: {
             service: recipientService.resolvedDidCommService,
             senderKey: ourService.resolvedDidCommService.recipientKeys[0],
-            returnRoute: true,
+            returnRoute: options.useReturnRoute ?? true, // defaults to true if missing
           },
         })
       )
-
       return proofRecord
     }
     // Cannot send message without connectionId or ~service decorator
@@ -495,7 +492,7 @@ export class ProofsApi<PPs extends ProofProtocol[]> implements ProofsApi<PPs> {
           serviceParams: {
             service: recipientService.resolvedDidCommService,
             senderKey: ourService.resolvedDidCommService.recipientKeys[0],
-            returnRoute: true,
+            returnRoute: false, // hard wire to be false since it's the end of the protocol so not needed here
           },
         })
       )

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

@@ -94,6 +94,12 @@ export interface RequestProofOptions<PPs extends ProofProtocol[] = ProofProtocol
  */
 export interface AcceptProofRequestOptions<PPs extends ProofProtocol[] = ProofProtocol[]> extends BaseOptions {
   proofRecordId: string
+
+  /**
+   * whether to enable return routing on the send presentation message. This value only
+   * has an effect for connectionless exchanges.
+   */
+  useReturnRoute?: boolean
   proofFormats?: ProofFormatPayload<ProofFormatsFromProtocols<PPs>, 'acceptRequest'>
 
   goalCode?: string

packages/core/src/modules/proofs/protocol/v2/__tests__/v2-indy-connectionless-proofs.e2e.test.ts

@@ -38,7 +38,7 @@ describe('V2 Connectionless Proofs - Indy', () => {
     }
   })
 
-  test('Faber starts with connection-less proof requests to Alice', async () => {
+  const connectionlessTest = async (returnRoute?: boolean) => {
     const {
       issuerAgent: faberAgent,
       issuerReplay: faberReplay,
@@ -128,8 +128,9 @@ describe('V2 Connectionless Proofs - Indy', () => {
       proofRecordId: aliceProofExchangeRecord.id,
     })
 
-    await aliceAgent.proofs.acceptRequest({
+    aliceProofExchangeRecord = await aliceAgent.proofs.acceptRequest({
       proofRecordId: aliceProofExchangeRecord.id,
+      useReturnRoute: returnRoute,
       proofFormats: { indy: requestedCredentials.proofFormats.indy },
     })
 
@@ -139,17 +140,24 @@ describe('V2 Connectionless Proofs - Indy', () => {
       state: ProofState.PresentationReceived,
     })
 
+    const sentPresentationMessage = aliceAgent.proofs.findPresentationMessage(aliceProofExchangeRecord.id)
+
     // assert presentation is valid
     expect(faberProofExchangeRecord.isVerified).toBe(true)
 
     // Faber accepts presentation
     await faberAgent.proofs.acceptPresentation({ proofRecordId: faberProofExchangeRecord.id })
 
-    // Alice waits till it receives presentation ack
+    // Alice waits until it receives presentation ack
     aliceProofExchangeRecord = await waitForProofExchangeRecordSubject(aliceReplay, {
       threadId: aliceProofExchangeRecord.threadId,
       state: ProofState.Done,
     })
+    return sentPresentationMessage
+  }
+
+  test('Faber starts with connection-less proof requests to Alice', async () => {
+    await connectionlessTest()
   })
 
   test('Faber starts with connection-less proof requests to Alice with auto-accept enabled', async () => {