refactor(proofs)!: make nonce optional and add missing exports (openwallet-foundation#1073)

Signed-off-by: Ariel Gentile <[email protected]>

Author: genaris

Diff for: packages/core/src/modules/credentials/CredentialsApi.ts

@@ -3,21 +3,21 @@ import type { Query } from '../../storage/StorageService'
 import type { DeleteCredentialOptions } from './CredentialServiceOptions'
 import type {
   AcceptCredentialOptions,
-  AcceptOfferOptions,
-  AcceptProposalOptions,
-  AcceptRequestOptions,
+  AcceptCredentialOfferOptions,
+  AcceptCredentialProposalOptions,
+  AcceptCredentialRequestOptions,
   CreateOfferOptions,
   FindCredentialMessageReturn,
-  FindOfferMessageReturn,
-  FindProposalMessageReturn,
-  FindRequestMessageReturn,
+  FindCredentialOfferMessageReturn,
+  FindCredentialProposalMessageReturn,
+  FindCredentialRequestMessageReturn,
   GetFormatDataReturn,
-  NegotiateOfferOptions,
-  NegotiateProposalOptions,
+  NegotiateCredentialOfferOptions,
+  NegotiateCredentialProposalOptions,
   OfferCredentialOptions,
   ProposeCredentialOptions,
-  SendProblemReportOptions,
-  ServiceMap,
+  SendCredentialProblemReportOptions,
+  CredentialServiceMap,
 } from './CredentialsApiOptions'
 import type { CredentialFormat } from './formats'
 import type { IndyCredentialFormat } from './formats/indy/IndyCredentialFormat'
@@ -47,21 +47,21 @@ import { CredentialRepository } from './repository/CredentialRepository'
 export interface CredentialsApi<CFs extends CredentialFormat[], CSs extends CredentialService<CFs>[]> {
   // Propose Credential methods
   proposeCredential(options: ProposeCredentialOptions<CFs, CSs>): Promise<CredentialExchangeRecord>
-  acceptProposal(options: AcceptProposalOptions<CFs>): Promise<CredentialExchangeRecord>
-  negotiateProposal(options: NegotiateProposalOptions<CFs>): Promise<CredentialExchangeRecord>
+  acceptProposal(options: AcceptCredentialProposalOptions<CFs>): Promise<CredentialExchangeRecord>
+  negotiateProposal(options: NegotiateCredentialProposalOptions<CFs>): Promise<CredentialExchangeRecord>
 
   // Offer Credential Methods
   offerCredential(options: OfferCredentialOptions<CFs, CSs>): Promise<CredentialExchangeRecord>
-  acceptOffer(options: AcceptOfferOptions<CFs>): Promise<CredentialExchangeRecord>
+  acceptOffer(options: AcceptCredentialOfferOptions<CFs>): Promise<CredentialExchangeRecord>
   declineOffer(credentialRecordId: string): Promise<CredentialExchangeRecord>
-  negotiateOffer(options: NegotiateOfferOptions<CFs>): Promise<CredentialExchangeRecord>
+  negotiateOffer(options: NegotiateCredentialOfferOptions<CFs>): Promise<CredentialExchangeRecord>
 
   // Request Credential Methods
   // This is for beginning the exchange with a request (no proposal or offer). Only possible
   // (currently) with W3C. We will not implement this in phase I
 
   // when the issuer accepts the request he issues the credential to the holder
-  acceptRequest(options: AcceptRequestOptions<CFs>): Promise<CredentialExchangeRecord>
+  acceptRequest(options: AcceptCredentialRequestOptions<CFs>): Promise<CredentialExchangeRecord>
 
   // Issue Credential Methods
   acceptCredential(options: AcceptCredentialOptions): Promise<CredentialExchangeRecord>
@@ -72,7 +72,7 @@ export interface CredentialsApi<CFs extends CredentialFormat[], CSs extends Cred
     credentialRecord: CredentialExchangeRecord
   }>
 
-  sendProblemReport(options: SendProblemReportOptions): Promise<CredentialExchangeRecord>
+  sendProblemReport(options: SendCredentialProblemReportOptions): Promise<CredentialExchangeRecord>
 
   // Record Methods
   getAll(): Promise<CredentialExchangeRecord[]>
@@ -84,9 +84,9 @@ export interface CredentialsApi<CFs extends CredentialFormat[], CSs extends Cred
   getFormatData(credentialRecordId: string): Promise<GetFormatDataReturn<CFs>>
 
   // DidComm Message Records
-  findProposalMessage(credentialExchangeId: string): Promise<FindProposalMessageReturn<CSs>>
-  findOfferMessage(credentialExchangeId: string): Promise<FindOfferMessageReturn<CSs>>
-  findRequestMessage(credentialExchangeId: string): Promise<FindRequestMessageReturn<CSs>>
+  findProposalMessage(credentialExchangeId: string): Promise<FindCredentialProposalMessageReturn<CSs>>
+  findOfferMessage(credentialExchangeId: string): Promise<FindCredentialOfferMessageReturn<CSs>>
+  findRequestMessage(credentialExchangeId: string): Promise<FindCredentialRequestMessageReturn<CSs>>
   findCredentialMessage(credentialExchangeId: string): Promise<FindCredentialMessageReturn<CSs>>
 }
 
@@ -108,7 +108,7 @@ export class CredentialsApi<
   private didCommMessageRepository: DidCommMessageRepository
   private routingService: RoutingService
   private logger: Logger
-  private serviceMap: ServiceMap<CFs, CSs>
+  private serviceMap: CredentialServiceMap<CFs, CSs>
 
   public constructor(
     messageSender: MessageSender,
@@ -141,7 +141,7 @@ export class CredentialsApi<
         [service.version]: service,
       }),
       {}
-    ) as ServiceMap<CFs, CSs>
+    ) as CredentialServiceMap<CFs, CSs>
 
     this.logger.debug(`Initializing Credentials Module for agent ${this.agentContext.config.label}`)
   }
@@ -195,7 +195,7 @@ export class CredentialsApi<
    * @returns Credential exchange record associated with the credential offer
    *
    */
-  public async acceptProposal(options: AcceptProposalOptions<CFs>): Promise<CredentialExchangeRecord> {
+  public async acceptProposal(options: AcceptCredentialProposalOptions<CFs>): Promise<CredentialExchangeRecord> {
     const credentialRecord = await this.getById(options.credentialRecordId)
 
     if (!credentialRecord.connectionId) {
@@ -227,11 +227,11 @@ export class CredentialsApi<
    * Negotiate a credential proposal as issuer (by sending a credential offer message) to the connection
    * associated with the credential record.
    *
-   * @param options configuration for the offer see {@link NegotiateProposalOptions}
+   * @param options configuration for the offer see {@link NegotiateCredentialProposalOptions}
    * @returns Credential exchange record associated with the credential offer
    *
    */
-  public async negotiateProposal(options: NegotiateProposalOptions<CFs>): Promise<CredentialExchangeRecord> {
+  public async negotiateProposal(options: NegotiateCredentialProposalOptions<CFs>): Promise<CredentialExchangeRecord> {
     const credentialRecord = await this.getById(options.credentialRecordId)
 
     if (!credentialRecord.connectionId) {
@@ -291,7 +291,7 @@ export class CredentialsApi<
    * @param options The object containing config options of the offer to be accepted
    * @returns Object containing offer associated credential record
    */
-  public async acceptOffer(options: AcceptOfferOptions<CFs>): Promise<CredentialExchangeRecord> {
+  public async acceptOffer(options: AcceptCredentialOfferOptions<CFs>): Promise<CredentialExchangeRecord> {
     const credentialRecord = await this.getById(options.credentialRecordId)
 
     const service = this.getService(credentialRecord.protocolVersion)
@@ -369,7 +369,7 @@ export class CredentialsApi<
     return credentialRecord
   }
 
-  public async negotiateOffer(options: NegotiateOfferOptions<CFs>): Promise<CredentialExchangeRecord> {
+  public async negotiateOffer(options: NegotiateCredentialOfferOptions<CFs>): Promise<CredentialExchangeRecord> {
     const credentialRecord = await this.getById(options.credentialRecordId)
 
     const service = this.getService(credentialRecord.protocolVersion)
@@ -424,7 +424,7 @@ export class CredentialsApi<
    * @param options The object containing config options of the request
    * @returns CredentialExchangeRecord updated with information pertaining to this request
    */
-  public async acceptRequest(options: AcceptRequestOptions<CFs>): Promise<CredentialExchangeRecord> {
+  public async acceptRequest(options: AcceptCredentialRequestOptions<CFs>): Promise<CredentialExchangeRecord> {
     const credentialRecord = await this.getById(options.credentialRecordId)
 
     // with version we can get the Service
@@ -539,7 +539,7 @@ export class CredentialsApi<
    * @param message message to send
    * @returns credential record associated with the credential problem report message
    */
-  public async sendProblemReport(options: SendProblemReportOptions) {
+  public async sendProblemReport(options: SendCredentialProblemReportOptions) {
     const credentialRecord = await this.getById(options.credentialRecordId)
     if (!credentialRecord.connectionId) {
       throw new AriesFrameworkError(`No connectionId found for credential record '${credentialRecord.id}'.`)
@@ -625,19 +625,19 @@ export class CredentialsApi<
     await this.credentialRepository.update(this.agentContext, credentialRecord)
   }
 
-  public async findProposalMessage(credentialExchangeId: string): Promise<FindProposalMessageReturn<CSs>> {
+  public async findProposalMessage(credentialExchangeId: string): Promise<FindCredentialProposalMessageReturn<CSs>> {
     const service = await this.getServiceForCredentialExchangeId(credentialExchangeId)
 
     return service.findProposalMessage(this.agentContext, credentialExchangeId)
   }
 
-  public async findOfferMessage(credentialExchangeId: string): Promise<FindOfferMessageReturn<CSs>> {
+  public async findOfferMessage(credentialExchangeId: string): Promise<FindCredentialOfferMessageReturn<CSs>> {
     const service = await this.getServiceForCredentialExchangeId(credentialExchangeId)
 
     return service.findOfferMessage(this.agentContext, credentialExchangeId)
   }
 
-  public async findRequestMessage(credentialExchangeId: string): Promise<FindRequestMessageReturn<CSs>> {
+  public async findRequestMessage(credentialExchangeId: string): Promise<FindCredentialRequestMessageReturn<CSs>> {
     const service = await this.getServiceForCredentialExchangeId(credentialExchangeId)
 
     return service.findRequestMessage(this.agentContext, credentialExchangeId)

Diff for: packages/core/src/modules/credentials/CredentialsApiOptions.ts

@@ -6,32 +6,38 @@ import type { CredentialService } from './services'
 // re-export GetFormatDataReturn type from service, as it is also used in the module
 export type { GetFormatDataReturn }
 
-export type FindProposalMessageReturn<CSs extends CredentialService[]> = ReturnType<CSs[number]['findProposalMessage']>
-export type FindOfferMessageReturn<CSs extends CredentialService[]> = ReturnType<CSs[number]['findOfferMessage']>
-export type FindRequestMessageReturn<CSs extends CredentialService[]> = ReturnType<CSs[number]['findRequestMessage']>
+export type FindCredentialProposalMessageReturn<CSs extends CredentialService[]> = ReturnType<
+  CSs[number]['findProposalMessage']
+>
+export type FindCredentialOfferMessageReturn<CSs extends CredentialService[]> = ReturnType<
+  CSs[number]['findOfferMessage']
+>
+export type FindCredentialRequestMessageReturn<CSs extends CredentialService[]> = ReturnType<
+  CSs[number]['findRequestMessage']
+>
 export type FindCredentialMessageReturn<CSs extends CredentialService[]> = ReturnType<
   CSs[number]['findCredentialMessage']
 >
 
 /**
  * Get the supported protocol versions based on the provided credential services.
  */
-export type ProtocolVersionType<CSs extends CredentialService[]> = CSs[number]['version']
+export type CredentialProtocolVersionType<CSs extends CredentialService[]> = CSs[number]['version']
 
 /**
  * Get the service map for usage in the credentials module. Will return a type mapping of protocol version to service.
  *
  * @example
  * ```
- * type CredentialServiceMap = ServiceMap<[IndyCredentialFormat], [V1CredentialService]>
+ * type ServiceMap = CredentialServiceMap<[IndyCredentialFormat], [V1CredentialService]>
  *
  * // equal to
- * type CredentialServiceMap = {
+ * type ServiceMap = {
  *   v1: V1CredentialService
  * }
  * ```
  */
-export type ServiceMap<CFs extends CredentialFormat[], CSs extends CredentialService<CFs>[]> = {
+export type CredentialServiceMap<CFs extends CredentialFormat[], CSs extends CredentialService<CFs>[]> = {
   [CS in CSs[number] as CS['version']]: CredentialService<CFs>
 }
 
@@ -48,7 +54,7 @@ export interface ProposeCredentialOptions<
   CSs extends CredentialService[] = CredentialService[]
 > extends BaseOptions {
   connectionId: string
-  protocolVersion: ProtocolVersionType<CSs>
+  protocolVersion: CredentialProtocolVersionType<CSs>
   credentialFormats: CredentialFormatPayload<CFs, 'createProposal'>
 }
 
@@ -57,15 +63,17 @@ export interface ProposeCredentialOptions<
  *
  * credentialFormats is optional because this is an accept method
  */
-export interface AcceptProposalOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
+export interface AcceptCredentialProposalOptions<CFs extends CredentialFormat[] = CredentialFormat[]>
+  extends BaseOptions {
   credentialRecordId: string
   credentialFormats?: CredentialFormatPayload<CFs, 'acceptProposal'>
 }
 
 /**
  * Interface for CredentialsApi.negotiateProposal. Will send an offer
  */
-export interface NegotiateProposalOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
+export interface NegotiateCredentialProposalOptions<CFs extends CredentialFormat[] = CredentialFormat[]>
+  extends BaseOptions {
   credentialRecordId: string
   credentialFormats: CredentialFormatPayload<CFs, 'createOffer'>
 }
@@ -77,7 +85,7 @@ export interface CreateOfferOptions<
   CFs extends CredentialFormat[] = CredentialFormat[],
   CSs extends CredentialService[] = CredentialService[]
 > extends BaseOptions {
-  protocolVersion: ProtocolVersionType<CSs>
+  protocolVersion: CredentialProtocolVersionType<CSs>
   credentialFormats: CredentialFormatPayload<CFs, 'createOffer'>
 }
 
@@ -97,15 +105,16 @@ export interface OfferCredentialOptions<
  *
  * credentialFormats is optional because this is an accept method
  */
-export interface AcceptOfferOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
+export interface AcceptCredentialOfferOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
   credentialRecordId: string
   credentialFormats?: CredentialFormatPayload<CFs, 'acceptOffer'>
 }
 
 /**
  * Interface for CredentialsApi.negotiateOffer. Will send a proposal.
  */
-export interface NegotiateOfferOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
+export interface NegotiateCredentialOfferOptions<CFs extends CredentialFormat[] = CredentialFormat[]>
+  extends BaseOptions {
   credentialRecordId: string
   credentialFormats: CredentialFormatPayload<CFs, 'createProposal'>
 }
@@ -115,7 +124,8 @@ export interface NegotiateOfferOptions<CFs extends CredentialFormat[] = Credenti
  *
  * credentialFormats is optional because this is an accept method
  */
-export interface AcceptRequestOptions<CFs extends CredentialFormat[] = CredentialFormat[]> extends BaseOptions {
+export interface AcceptCredentialRequestOptions<CFs extends CredentialFormat[] = CredentialFormat[]>
+  extends BaseOptions {
   credentialRecordId: string
   credentialFormats?: CredentialFormatPayload<CFs, 'acceptRequest'>
   autoAcceptCredential?: AutoAcceptCredential
@@ -132,7 +142,7 @@ export interface AcceptCredentialOptions {
 /**
  * Interface for CredentialsApi.sendProblemReport. Will send a problem-report message
  */
-export interface SendProblemReportOptions {
+export interface SendCredentialProblemReportOptions {
   credentialRecordId: string
   message: string
 }

Diff for: packages/core/src/modules/credentials/formats/CredentialFormatService.ts

@@ -7,7 +7,7 @@ import type {
   FormatCreateOfferOptions,
   FormatCreateOfferReturn,
   FormatCreateRequestOptions,
-  FormatCreateReturn,
+  CredentialFormatCreateReturn,
   FormatAcceptRequestOptions,
   FormatAcceptOfferOptions,
   FormatAcceptProposalOptions,
@@ -41,18 +41,21 @@ export abstract class CredentialFormatService<CF extends CredentialFormat = Cred
     options: FormatCreateOfferOptions<CF>
   ): Promise<FormatCreateOfferReturn>
   abstract processOffer(agentContext: AgentContext, options: FormatProcessOptions): Promise<void>
-  abstract acceptOffer(agentContext: AgentContext, options: FormatAcceptOfferOptions<CF>): Promise<FormatCreateReturn>
+  abstract acceptOffer(
+    agentContext: AgentContext,
+    options: FormatAcceptOfferOptions<CF>
+  ): Promise<CredentialFormatCreateReturn>
 
   // request methods
   abstract createRequest(
     agentContext: AgentContext,
     options: FormatCreateRequestOptions<CF>
-  ): Promise<FormatCreateReturn>
+  ): Promise<CredentialFormatCreateReturn>
   abstract processRequest(agentContext: AgentContext, options: FormatProcessOptions): Promise<void>
   abstract acceptRequest(
     agentContext: AgentContext,
     options: FormatAcceptRequestOptions<CF>
-  ): Promise<FormatCreateReturn>
+  ): Promise<CredentialFormatCreateReturn>
 
   // credential methods
   abstract processCredential(agentContext: AgentContext, options: FormatProcessOptions): Promise<void>

Diff for: packages/core/src/modules/credentials/formats/CredentialFormatServiceOptions.ts

@@ -10,15 +10,15 @@ import type { CredentialFormatService } from './CredentialFormatService'
  *
  * @example
  * ```
- * type CredentialFormatServiceMap = FormatServiceMap<[IndyCredentialFormat]>
+ * type FormatServiceMap = CredentialFormatServiceMap<[IndyCredentialFormat]>
  *
  * // equal to
- * type CredentialFormatServiceMap = {
+ * type FormatServiceMap = {
  *   indy: CredentialFormatService<IndyCredentialFormat>
  * }
  * ```
  */
-export type FormatServiceMap<CFs extends CredentialFormat[]> = {
+export type CredentialFormatServiceMap<CFs extends CredentialFormat[]> = {
   [CF in CFs[number] as CF['formatKey']]: CredentialFormatService<CF>
 }
 
@@ -27,7 +27,7 @@ export type FormatServiceMap<CFs extends CredentialFormat[]> = {
  *
  * It requires an attachment and a format to be returned.
  */
-export interface FormatCreateReturn {
+export interface CredentialFormatCreateReturn {
   format: CredentialFormatSpec
   attachment: Attachment
 }
@@ -53,7 +53,7 @@ export interface FormatAcceptProposalOptions<CF extends CredentialFormat> {
   proposalAttachment: Attachment
 }
 
-export interface FormatCreateProposalReturn extends FormatCreateReturn {
+export interface FormatCreateProposalReturn extends CredentialFormatCreateReturn {
   previewAttributes?: CredentialPreviewAttribute[]
 }
 
@@ -71,7 +71,7 @@ export interface FormatAcceptOfferOptions<CF extends CredentialFormat> {
   offerAttachment: Attachment
 }
 
-export interface FormatCreateOfferReturn extends FormatCreateReturn {
+export interface FormatCreateOfferReturn extends CredentialFormatCreateReturn {
   previewAttributes?: CredentialPreviewAttribute[]
 }