changes based on pr feedback (openwallet-foundation#189)

* remove indy from proof module, abstract nonce
* add role names to module methods
* rename build to get for schema, cred def
* use records instead of maps

Signed-off-by: Timo Glastra <[email protected]>

Author: TimoGlastra

src/lib/__tests__/proofs.test.ts

@@ -193,23 +193,19 @@ describe('Present Proof', () => {
   test('Faber starts with proof requests to Alice', async () => {
     logger.log('Faber sends presentation request to Alice');
 
-    const attributes = new Map();
-    attributes.set(
-      'name',
-      new ProofAttributeInfo({
+    const attributes = {
+      name: new ProofAttributeInfo({
         name: 'name',
         restrictions: [
           new AttributeFilter({
             credentialDefinitionId: credDefId,
           }),
         ],
-      })
-    );
+      }),
+    };
 
-    const predicates = new Map();
-    predicates.set(
-      'age',
-      new ProofPredicateInfo({
+    const predicates = {
+      age: new ProofPredicateInfo({
         name: 'age',
         predicateType: PredicateType.GreaterThanOrEqualTo,
         predicateValue: 50,
@@ -218,8 +214,8 @@ describe('Present Proof', () => {
             credentialDefinitionId: credDefId,
           }),
         ],
-      })
-    );
+      }),
+    };
 
     let faberProofRecord = await faberAgent.proof.requestProof(faberConnection.id, {
       name: 'test-proof-request',

src/lib/agent/Agent.ts

@@ -202,7 +202,7 @@ export class Agent {
       this.messageSender
     );
 
-    this.proof = new ProofsModule(this.proofService, this.connectionService, this.messageSender, this.indy);
+    this.proof = new ProofsModule(this.proofService, this.connectionService, this.messageSender);
 
     this.routing = new RoutingModule(
       this.agentConfig,
@@ -216,11 +216,6 @@ export class Agent {
     this.basicMessages = new BasicMessagesModule(this.basicMessageService, this.messageSender);
     this.ledger = new LedgerModule(this.wallet, this.ledgerService);
 
-    this.credentials = new CredentialsModule(
-      this.connectionService,
-      this.credentialService,
-      this.ledgerService,
-      this.messageSender
-    );
+    this.credentials = new CredentialsModule(this.connectionService, this.credentialService, this.messageSender);
   }
 }

src/lib/modules/ConnectionsModule.ts

@@ -58,7 +58,7 @@ export class ConnectionsModule {
   }
 
   /**
-   * Receive connection invitation and create connection. If auto accepting is enabled
+   * Receive connection invitation as invitee and create connection. If auto accepting is enabled
    * via either the config passed in the function or the global agent config, a connection
    * request message will be send.
    *
@@ -88,7 +88,7 @@ export class ConnectionsModule {
   }
 
   /**
-   * Receive connection invitation encoded as url and create connection. If auto accepting is enabled
+   * Receive connection invitation as invitee encoded as url and create connection. If auto accepting is enabled
    * via either the config passed in the function or the global agent config, a connection
    * request message will be send.
    *
@@ -108,7 +108,7 @@ export class ConnectionsModule {
   }
 
   /**
-   * Accept a connection invitation (by sending a connection request message) for the connection with the specified connection id.
+   * Accept a connection invitation as invitee (by sending a connection request message) for the connection with the specified connection id.
    * This is not needed when auto accepting of connections is enabled.
    *
    * @param connectionId the id of the connection for which to accept the invitation
@@ -130,7 +130,7 @@ export class ConnectionsModule {
   }
 
   /**
-   * Accept a connection request (by sending a connection response message) for the connection with the specified connection id.
+   * Accept a connection request as inviter (by sending a connection response message) for the connection with the specified connection id.
    * This is not needed when auto accepting of connection is enabled.
    *
    * @param connectionId the id of the connection for which to accept the request
@@ -146,7 +146,7 @@ export class ConnectionsModule {
   }
 
   /**
-   * Accept a connection response (by sending a trust ping message) for the connection with the specified connection id.
+   * Accept a connection response as invitee (by sending a trust ping message) for the connection with the specified connection id.
    * This is not needed when auto accepting of connection is enabled.
    *
    * @param connectionId the id of the connection for which to accept the response

src/lib/modules/CredentialsModule.ts

@@ -2,7 +2,6 @@ import { CredentialRecord } from '../storage/CredentialRecord';
 import { createOutboundMessage } from '../protocols/helpers';
 import { MessageSender } from '../agent/MessageSender';
 import { ConnectionService } from '../protocols/connections/ConnectionService';
-import { LedgerService } from '../agent/LedgerService';
 import { EventEmitter } from 'events';
 import {
   ProposeCredentialMessage,
@@ -16,18 +15,15 @@ import { JsonTransformer } from '../utils/JsonTransformer';
 export class CredentialsModule {
   private connectionService: ConnectionService;
   private credentialService: CredentialService;
-  private ledgerService: LedgerService;
   private messageSender: MessageSender;
 
   public constructor(
     connectionService: ConnectionService,
     credentialService: CredentialService,
-    ledgerService: LedgerService,
     messageSender: MessageSender
   ) {
     this.connectionService = connectionService;
     this.credentialService = credentialService;
-    this.ledgerService = ledgerService;
     this.messageSender = messageSender;
   }
 
@@ -42,7 +38,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Initiate a new credential exchange by sending a credential proposal message
+   * Initiate a new credential exchange as holder by sending a credential proposal message
    * to the connection with the specified connection id.
    *
    * @param connectionId The connection to send the credential proposal to
@@ -61,7 +57,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Accept a credential proposal (by sending a credential offer message) to the connection
+   * Accept a credential proposal as issuer (by sending a credential offer message) to the connection
    * associated with the credential record.
    *
    * @param credentialRecordId The id of the credential record for which to accept the proposal
@@ -111,7 +107,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Initiate a new credential exchange by sending a credential offer message
+   * Initiate a new credential exchange as issuer by sending a credential offer message
    * to the connection with the specified connection id.
    *
    * @param connectionId The connection to send the credential offer to
@@ -133,7 +129,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Accept a credential offer (by sending a credential request message) to the connection
+   * Accept a credential offer as holder (by sending a credential request message) to the connection
    * associated with the credential record.
    *
    * @param credentialRecordId The id of the credential record for which to accept the offer
@@ -154,7 +150,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Accept a credential request (by sending a credential message) to the connection
+   * Accept a credential request as issuer (by sending a credential message) to the connection
    * associated with the credential record.
    *
    * @param credentialRecordId The id of the credential record for which to accept the request
@@ -174,7 +170,7 @@ export class CredentialsModule {
   }
 
   /**
-   * Accept a credential (by sending a credential acknowledgement message) to the connection
+   * Accept a credential as holder (by sending a credential acknowledgement message) to the connection
    * associated with the credential record.
    *
    * @param credentialRecordId The id of the credential record for which to accept the credential

src/lib/modules/ProofsModule.ts

@@ -1,4 +1,3 @@
-import type Indy from 'indy-sdk';
 import { createOutboundMessage } from '../protocols/helpers';
 import { MessageSender } from '../agent/MessageSender';
 import { ProofService } from '../protocols/present-proof/ProofService';
@@ -13,18 +12,11 @@ export class ProofsModule {
   private proofService: ProofService;
   private connectionService: ConnectionService;
   private messageSender: MessageSender;
-  private indy: typeof Indy;
 
-  public constructor(
-    proofService: ProofService,
-    connectionService: ConnectionService,
-    messageSender: MessageSender,
-    indy: typeof Indy
-  ) {
+  public constructor(proofService: ProofService, connectionService: ConnectionService, messageSender: MessageSender) {
     this.proofService = proofService;
     this.connectionService = connectionService;
     this.messageSender = messageSender;
-    this.indy = indy;
   }
 
   /**
@@ -38,7 +30,7 @@ export class ProofsModule {
   }
 
   /**
-   * Initiate a new presentation exchange by sending a presentation proposal message
+   * Initiate a new presentation exchange as prover by sending a presentation proposal message
    * to the connection with the specified connection id.
    *
    * @param connectionId The connection to send the proof proposal to
@@ -65,7 +57,7 @@ export class ProofsModule {
   }
 
   /**
-   * Accept a presentation proposal (by sending a presentation request message) to the connection
+   * Accept a presentation proposal as verifier (by sending a presentation request message) to the connection
    * associated with the proof record.
    *
    * @param proofRecordId The id of the proof record for which to accept the proposal
@@ -112,7 +104,7 @@ export class ProofsModule {
   }
 
   /**
-   * Initiate a new presentation exchange by sending a presentation request message
+   * Initiate a new presentation exchange as verifier by sending a presentation request message
    * to the connection with the specified connection id
    *
    * @param connectionId The connection to send the proof request to
@@ -130,10 +122,12 @@ export class ProofsModule {
   ): Promise<ProofRecord> {
     const connection = await this.connectionService.getById(connectionId);
 
+    const nonce = proofRequestOptions.nonce ?? (await this.proofService.generateProofRequestNonce());
+
     const proofRequest = new ProofRequest({
       name: proofRequestOptions.name ?? 'proof-request',
       version: proofRequestOptions.name ?? '1.0',
-      nonce: proofRequestOptions.nonce ?? (await this.indy.generateNonce()),
+      nonce,
       requestedAttributes: proofRequestOptions.requestedAttributes,
       requestedPredicates: proofRequestOptions.requestedPredicates,
     });
@@ -147,7 +141,7 @@ export class ProofsModule {
   }
 
   /**
-   * Accept a presentation request (by sending a presentation message) to the connection
+   * Accept a presentation request as prover (by sending a presentation message) to the connection
    * associated with the proof record.
    *
    * @param proofRecordId The id of the proof record for which to accept the request
@@ -175,7 +169,7 @@ export class ProofsModule {
   }
 
   /**
-   * Accept a presentation (by sending a presentation acknowledgement message) to the connection
+   * Accept a presentation as prover (by sending a presentation acknowledgement message) to the connection
    * associated with the proof record.
    *
    * @param proofRecordId The id of the proof record for which to accept the presentation
@@ -193,6 +187,18 @@ export class ProofsModule {
     return proofRecord;
   }
 
+  /**
+   * Create a RequestedCredentials 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.
+   *
+   * Use the return value of this method as input to {@link ProofService.createPresentation} to automatically
+   * accept a received presentation request.
+   *
+   * @param proofRequest The proof request to build the requested credentials object from
+   * @param presentationProposal Optional presentation proposal to improve credential selection algorithm
+   * @returns Requested credentials object for use in proof creation
+   */
   public async getRequestedCredentialsForProofRequest(
     proofRequest: ProofRequest,
     presentationProposal: PresentationPreview

src/lib/protocols/issue-credential/__tests__/StubWallet.ts

@@ -156,4 +156,8 @@ export class StubWallet implements Wallet {
   public signRequest(myDid: string, request: LedgerRequest): Promise<LedgerRequest> {
     throw new Error('Method not implemented.');
   }
+
+  public async generateNonce(): Promise<string> {
+    throw new Error('Method not implemented');
+  }
 }

src/lib/protocols/issue-credential/models/CredentialInfo.ts

@@ -24,7 +24,7 @@ export class CredentialInfo {
 
   @Expose({ name: 'attrs' })
   @IsString({ each: true })
-  public attributes!: Map<string, string>;
+  public attributes!: Record<string, string>;
 
   @Expose({ name: 'schema_id' })
   @IsString()