Skip to content

Commit f777b3d

Browse files
NB-MikeRichardsonNB-MikeRichardson
authored
refactor(proofs)!: rename ProofRecord to ProofExchangeRecord (openwallet-foundation#1071)
Signed-off-by: Mike Richardson <[email protected]>
1 parent d4fd1ae commit f777b3d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+919
-1393
lines changed

Diff for: ‎demo/src/Alice.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { ConnectionRecord, CredentialExchangeRecord, ProofRecord } from '@aries-framework/core'
1+
import type { ConnectionRecord, CredentialExchangeRecord, ProofExchangeRecord } from '@aries-framework/core'
22

33
import { BaseAgent } from './BaseAgent'
44
import { greenText, Output, redText } from './OutputClass'
@@ -51,7 +51,7 @@ export class Alice extends BaseAgent {
5151
})
5252
}
5353

54-
public async acceptProofRequest(proofRecord: ProofRecord) {
54+
public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
5555
const requestedCredentials = await this.agent.proofs.autoSelectCredentialsForProofRequest({
5656
proofRecordId: proofRecord.id,
5757
config: {

Diff for: ‎demo/src/AliceInquirer.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { CredentialExchangeRecord, ProofRecord } from '@aries-framework/core'
1+
import type { CredentialExchangeRecord, ProofExchangeRecord } from '@aries-framework/core'
22

33
import { clear } from 'console'
44
import { textSync } from 'figlet'
@@ -78,7 +78,7 @@ export class AliceInquirer extends BaseInquirer {
7878
}
7979
}
8080

81-
public async acceptProofRequest(proofRecord: ProofRecord) {
81+
public async acceptProofRequest(proofRecord: ProofExchangeRecord) {
8282
const confirm = await inquirer.prompt([this.inquireConfirmation(Title.ProofRequestTitle)])
8383
if (confirm.options === ConfirmOptions.No) {
8484
await this.alice.agent.proofs.declineRequest(proofRecord.id)

Diff for: ‎demo/src/Listener.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type {
77
BasicMessageStateChangedEvent,
88
CredentialExchangeRecord,
99
CredentialStateChangedEvent,
10-
ProofRecord,
10+
ProofExchangeRecord,
1111
ProofStateChangedEvent,
1212
} from '@aries-framework/core'
1313
import type BottomBar from 'inquirer/lib/ui/bottom-bar'
@@ -78,7 +78,7 @@ export class Listener {
7878
})
7979
}
8080

81-
private async newProofRequestPrompt(proofRecord: ProofRecord, aliceInquirer: AliceInquirer) {
81+
private async newProofRequestPrompt(proofRecord: ProofExchangeRecord, aliceInquirer: AliceInquirer) {
8282
this.turnListenerOn()
8383
await aliceInquirer.acceptProofRequest(proofRecord)
8484
this.turnListenerOff()

Diff for: ‎packages/core/src/modules/proofs/ProofEvents.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { BaseEvent } from '../../agent/Events'
22
import type { ProofState } from './models/ProofState'
3-
import type { ProofRecord } from './repository'
3+
import type { ProofExchangeRecord } from './repository'
44

55
export enum ProofEventTypes {
66
ProofStateChanged = 'ProofStateChanged',
@@ -9,7 +9,7 @@ export enum ProofEventTypes {
99
export interface ProofStateChangedEvent extends BaseEvent {
1010
type: typeof ProofEventTypes.ProofStateChanged
1111
payload: {
12-
proofRecord: ProofRecord
12+
proofRecord: ProofExchangeRecord
1313
previousState: ProofState | null
1414
}
1515
}

Diff for: ‎packages/core/src/modules/proofs/ProofResponseCoordinator.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { AgentContext } from '../../agent/context/AgentContext'
2-
import type { ProofRecord } from './repository'
2+
import type { ProofExchangeRecord } from './repository'
33

44
import { injectable } from '../../plugins'
55

@@ -34,7 +34,7 @@ export class ProofResponseCoordinator {
3434
/**
3535
* Checks whether it should automatically respond to a proposal
3636
*/
37-
public shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofRecord) {
37+
public shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
3838
const autoAccept = ProofResponseCoordinator.composeAutoAccept(
3939
proofRecord.autoAcceptProof,
4040
agentContext.config.autoAcceptProofs
@@ -54,7 +54,7 @@ export class ProofResponseCoordinator {
5454
/**
5555
* Checks whether it should automatically respond to a request
5656
*/
57-
public shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofRecord) {
57+
public shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
5858
const autoAccept = ProofResponseCoordinator.composeAutoAccept(
5959
proofRecord.autoAcceptProof,
6060
agentContext.config.autoAcceptProofs
@@ -74,7 +74,7 @@ export class ProofResponseCoordinator {
7474
/**
7575
* Checks whether it should automatically respond to a presentation of proof
7676
*/
77-
public shouldAutoRespondToPresentation(agentContext: AgentContext, proofRecord: ProofRecord) {
77+
public shouldAutoRespondToPresentation(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
7878
const autoAccept = ProofResponseCoordinator.composeAutoAccept(
7979
proofRecord.autoAcceptProof,
8080
agentContext.config.autoAcceptProofs

Diff for: ‎packages/core/src/modules/proofs/ProofService.ts

+31-21
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import type {
2929
ProofRequestFromProposalOptions,
3030
} from './models/ProofServiceOptions'
3131
import type { ProofState } from './models/ProofState'
32-
import type { ProofRecord, ProofRepository } from './repository'
32+
import type { ProofExchangeRecord, ProofRepository } from './repository'
3333

3434
import { JsonTransformer } from '../../utils/JsonTransformer'
3535

@@ -64,7 +64,11 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
6464
return await this.wallet.generateNonce()
6565
}
6666

67-
public emitStateChangedEvent(agentContext: AgentContext, proofRecord: ProofRecord, previousState: ProofState | null) {
67+
public emitStateChangedEvent(
68+
agentContext: AgentContext,
69+
proofRecord: ProofExchangeRecord,
70+
previousState: ProofState | null
71+
) {
6872
const clonedProof = JsonTransformer.clone(proofRecord)
6973

7074
this.eventEmitter.emit<ProofStateChangedEvent>(agentContext, {
@@ -84,15 +88,15 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
8488
* @param newState The state to update to
8589
*
8690
*/
87-
public async updateState(agentContext: AgentContext, proofRecord: ProofRecord, newState: ProofState) {
91+
public async updateState(agentContext: AgentContext, proofRecord: ProofExchangeRecord, newState: ProofState) {
8892
const previousState = proofRecord.state
8993
proofRecord.state = newState
9094
await this.proofRepository.update(agentContext, proofRecord)
9195

9296
this.emitStateChangedEvent(agentContext, proofRecord, previousState)
9397
}
9498

95-
public update(agentContext: AgentContext, proofRecord: ProofRecord) {
99+
public update(agentContext: AgentContext, proofRecord: ProofExchangeRecord) {
96100
return this.proofRepository.update(agentContext, proofRecord)
97101
}
98102

@@ -107,7 +111,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
107111
abstract createProposal(
108112
agentContext: AgentContext,
109113
options: CreateProposalOptions<PFs>
110-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
114+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
111115

112116
/**
113117
* Create a proposal message in response to a received proof request message
@@ -122,7 +126,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
122126
abstract createProposalAsResponse(
123127
agentContext: AgentContext,
124128
options: CreateProposalAsResponseOptions<PFs>
125-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
129+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
126130

127131
/**
128132
* Process a received proposal message (does not accept yet)
@@ -142,48 +146,54 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
142146
* 4. Loop through all format services to process proposal message
143147
* 5. Save & return record
144148
*/
145-
abstract processProposal(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
149+
abstract processProposal(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
146150

147151
abstract createRequest(
148152
agentContext: AgentContext,
149153
options: CreateRequestOptions<PFs>
150-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
154+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
151155

152156
abstract createRequestAsResponse(
153157
agentContext: AgentContext,
154158
options: CreateRequestAsResponseOptions<PFs>
155-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
159+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
156160

157-
abstract processRequest(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
161+
abstract processRequest(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
158162

159163
abstract createPresentation(
160164
agentContext: AgentContext,
161165
options: CreatePresentationOptions<PFs>
162-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
166+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
163167

164-
abstract processPresentation(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
168+
abstract processPresentation(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
165169

166170
abstract createAck(
167171
agentContext: AgentContext,
168172
options: CreateAckOptions
169-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
173+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
170174

171-
abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
175+
abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
172176

173177
abstract createProblemReport(
174178
agentContext: AgentContext,
175179
options: CreateProblemReportOptions
176-
): Promise<{ proofRecord: ProofRecord; message: AgentMessage }>
180+
): Promise<{ proofRecord: ProofExchangeRecord; message: AgentMessage }>
177181

178-
abstract processProblemReport(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofRecord>
182+
abstract processProblemReport(messageContext: InboundMessageContext<AgentMessage>): Promise<ProofExchangeRecord>
179183

180-
public abstract shouldAutoRespondToProposal(agentContext: AgentContext, proofRecord: ProofRecord): Promise<boolean>
184+
public abstract shouldAutoRespondToProposal(
185+
agentContext: AgentContext,
186+
proofRecord: ProofExchangeRecord
187+
): Promise<boolean>
181188

182-
public abstract shouldAutoRespondToRequest(agentContext: AgentContext, proofRecord: ProofRecord): Promise<boolean>
189+
public abstract shouldAutoRespondToRequest(
190+
agentContext: AgentContext,
191+
proofRecord: ProofExchangeRecord
192+
): Promise<boolean>
183193

184194
public abstract shouldAutoRespondToPresentation(
185195
agentContext: AgentContext,
186-
proofRecord: ProofRecord
196+
proofRecord: ProofExchangeRecord
187197
): Promise<boolean>
188198

189199
public abstract registerHandlers(
@@ -204,7 +214,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
204214
public async saveOrUpdatePresentationMessage(
205215
agentContext: AgentContext,
206216
options: {
207-
proofRecord: ProofRecord
217+
proofRecord: ProofExchangeRecord
208218
message: AgentMessage
209219
role: DidCommMessageRole
210220
}
@@ -218,7 +228,7 @@ export abstract class ProofService<PFs extends ProofFormat[] = ProofFormat[]> {
218228

219229
public async delete(
220230
agentContext: AgentContext,
221-
proofRecord: ProofRecord,
231+
proofRecord: ProofExchangeRecord,
222232
options?: DeleteProofOptions
223233
): Promise<void> {
224234
await this.proofRepository.delete(agentContext, proofRecord)

0 commit comments

Comments
 (0)