refactor(proofs)!: rename ProofRecord to ProofExchangeRecord (#1071)

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

demo/src/Alice.ts

@@ -1,4 +1,4 @@
-import type { ConnectionRecord, CredentialExchangeRecord, ProofRecord } from '@aries-framework/core'
+import type { ConnectionRecord, CredentialExchangeRecord, ProofExchangeRecord } from '@aries-framework/core'
 
 import { BaseAgent } from './BaseAgent'
 import { greenText, Output, redText } from './OutputClass'
@@ -51,7 +51,7 @@ export class Alice extends BaseAgent {
     })
   }
 
-  public async acceptProofRequest(proofRecord: ProofRecord) {
+  public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
     const requestedCredentials = await this.agent.proofs.autoSelectCredentialsForProofRequest({
       proofRecordId: proofRecord.id,
       config: {

demo/src/AliceInquirer.ts

@@ -1,4 +1,4 @@
-import type { CredentialExchangeRecord, ProofRecord } from '@aries-framework/core'
+import type { CredentialExchangeRecord, ProofExchangeRecord } from '@aries-framework/core'
 
 import { clear } from 'console'
 import { textSync } from 'figlet'
@@ -78,7 +78,7 @@ export class AliceInquirer extends BaseInquirer {
     }
   }
 
-  public async acceptProofRequest(proofRecord: ProofRecord) {
+  public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
     const confirm = await inquirer.prompt([this.inquireConfirmation(Title.ProofRequestTitle)])
     if (confirm.options === ConfirmOptions.No) {
       await this.alice.agent.proofs.declineRequest(proofRecord.id)

demo/src/Listener.ts

@@ -7,7 +7,7 @@ import type {
   BasicMessageStateChangedEvent,
   CredentialExchangeRecord,
   CredentialStateChangedEvent,
-  ProofRecord,
+  ProofExchangeRecord,
   ProofStateChangedEvent,
 } from '@aries-framework/core'
 import type BottomBar from 'inquirer/lib/ui/bottom-bar'
@@ -78,7 +78,7 @@ export class Listener {
     })
   }
 
-  private async newProofRequestPrompt(proofRecord: ProofRecord, aliceInquirer: AliceInquirer) {
+  private async newProofRequestPrompt(proofRecord: ProofExchangeRecord, aliceInquirer: AliceInquirer) {
     this.turnListenerOn()
     await aliceInquirer.acceptProofRequest(proofRecord)
     this.turnListenerOff()

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

@@ -1,6 +1,6 @@
 import type { BaseEvent } from '../../agent/Events'
 import type { ProofState } from './models/ProofState'
-import type { ProofRecord } from './repository'
+import type { ProofExchangeRecord } from './repository'
 
 export enum ProofEventTypes {
   ProofStateChanged = 'ProofStateChanged',
@@ -9,7 +9,7 @@ export enum ProofEventTypes {
 export interface ProofStateChangedEvent extends BaseEvent {
   type: typeof ProofEventTypes.ProofStateChanged
   payload: {
-    proofRecord: ProofRecord
+    proofRecord: ProofExchangeRecord
     previousState: ProofState | null
   }
 }

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

@@ -1,5 +1,5 @@
 import type { AgentContext } from '../../agent/context/AgentContext'
-import type { ProofRecord } from './repository'
+import type { ProofExchangeRecord } from './repository'
 
 import { injectable } from '../../plugins'
 
@@ -34,7 +34,7 @@ export class ProofResponseCoordinator {
   /**
    * Checks whether it should automatically respond to a proposal
    */
-  public shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofRecord) {
+  public shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
     const autoAccept = ProofResponseCoordinator.composeAutoAccept(
       proofRecord.autoAcceptProof,
       agentContext.config.autoAcceptProofs
@@ -54,7 +54,7 @@ export class ProofResponseCoordinator {
   /**
    * Checks whether it should automatically respond to a request
    */
-  public shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofRecord) {
+  public shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
     const autoAccept = ProofResponseCoordinator.composeAutoAccept(
       proofRecord.autoAcceptProof,
       agentContext.config.autoAcceptProofs
@@ -74,7 +74,7 @@ export class ProofResponseCoordinator {
   /**
    * Checks whether it should automatically respond to a presentation of proof
    */
-  public shouldAutoRespondToPresentation(agentContext: AgentContext, proofRecord: ProofRecord) {
+  public shouldAutoRespondToPresentation(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
     const autoAccept = ProofResponseCoordinator.composeAutoAccept(
       proofRecord.autoAcceptProof,
       agentContext.config.autoAcceptProofs

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

@@ -29,7 +29,7 @@ import type {
   ProofRequestFromProposalOptions,
 } from './models/ProofServiceOptions'
 import type { ProofState } from './models/ProofState'
-import type { ProofRecord, ProofRepository } from './repository'
+import type { ProofExchangeRecord, ProofRepository } from './repository'
 
 import { JsonTransformer } from '../../utils/JsonTransformer'
 
@@ -64,7 +64,11 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
     return await this.wallet.generateNonce()
   }
 
-  public emitStateChangedEvent(agentContext: AgentContext, proofRecord: ProofRecord, previousState: ProofState | null) {
+  public emitStateChangedEvent(
+    agentContext: AgentContext,
+    proofRecord: ProofExchangeRecord,
+    previousState: ProofState | null
+  ) {
     const clonedProof = JsonTransformer.clone(proofRecord)
 
     this.eventEmitter.emit<ProofStateChangedEvent>(agentContext, {
@@ -84,15 +88,15 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
    * @param newState The state to update to
    *
    */
-  public async updateState(agentContext: AgentContext, proofRecord: ProofRecord, newState: ProofState) {
+  public async updateState(agentContext: AgentContext, proofRecord: ProofExchangeRecord, newState: ProofState) {
     const previousState = proofRecord.state
     proofRecord.state = newState
     await this.proofRepository.update(agentContext, proofRecord)
 
     this.emitStateChangedEvent(agentContext, proofRecord, previousState)
   }
 
-  public update(agentContext: AgentContext, proofRecord: ProofRecord) {
+  public update(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
     return this.proofRepository.update(agentContext, proofRecord)
   }
 
@@ -107,7 +111,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
   abstract createProposal(
     agentContext: AgentContext,
     options: CreateProposalOptions<PFs>
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
   /**
    * Create a proposal message in response to a received proof request message
@@ -122,7 +126,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
   abstract createProposalAsResponse(
     agentContext: AgentContext,
     options: CreateProposalAsResponseOptions<PFs>
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
   /**
    * Process a received proposal message (does not accept yet)
@@ -142,48 +146,54 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
    *    4. Loop through all format services to process proposal message
    *    5. Save & return record
    */
-  abstract processProposal(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
+  abstract processProposal(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
 
   abstract createRequest(
     agentContext: AgentContext,
     options: CreateRequestOptions<PFs>
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
   abstract createRequestAsResponse(
     agentContext: AgentContext,
     options: CreateRequestAsResponseOptions<PFs>
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
-  abstract processRequest(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
+  abstract processRequest(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
 
   abstract createPresentation(
     agentContext: AgentContext,
     options: CreatePresentationOptions<PFs>
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
-  abstract processPresentation(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
+  abstract processPresentation(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
 
   abstract createAck(
     agentContext: AgentContext,
     options: CreateAckOptions
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
-  abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
+  abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
 
   abstract createProblemReport(
     agentContext: AgentContext,
     options: CreateProblemReportOptions
-  ): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
+  ): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
 
-  abstract processProblemReport(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
+  abstract processProblemReport(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
 
-  public abstract shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofRecord): Promise<boolean>
+  public abstract shouldAutoRespondToProposal(
+    agentContext: AgentContext,
+    proofRecord: ProofExchangeRecord
+  ): Promise<boolean>
 
-  public abstract shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofRecord): Promise<boolean>
+  public abstract shouldAutoRespondToRequest(
+    agentContext: AgentContext,
+    proofRecord: ProofExchangeRecord
+  ): Promise<boolean>
 
   public abstract shouldAutoRespondToPresentation(
     agentContext: AgentContext,
-    proofRecord: ProofRecord
+    proofRecord: ProofExchangeRecord
   ): Promise<boolean>
 
   public abstract registerHandlers(
@@ -204,7 +214,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
   public async saveOrUpdatePresentationMessage(
     agentContext: AgentContext,
     options: {
-      proofRecord: ProofRecord
+      proofRecord: ProofExchangeRecord
       message: AgentMessage
       role: DidCommMessageRole
     }
@@ -218,7 +228,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
 
   public async delete(
     agentContext: AgentContext,
-    proofRecord: ProofRecord,
+    proofRecord: ProofExchangeRecord,
     options?: DeleteProofOptions
   ): Promise<void> {
     await this.proofRepository.delete(agentContext, proofRecord)