fixed credential status

Author: Vishwas1

src/credential/credential.module.ts

@@ -17,17 +17,30 @@ import { TrimMiddleware } from 'src/utils/middleware/trim.middleware';
 import { credentialProviders } from './providers/credential.provider';
 import { databaseProviders } from '../mongoose/tenant-mongoose-connections';
 import { TxSendModuleModule } from 'src/tx-send-module/tx-send-module.module';
+import { StatusModule } from 'src/status/status.module';
+import { StatusService } from 'src/status/status.service';
+import { TxnStatusRepository } from 'src/status/repository/status.repository';
+import { statusProviders } from 'src/status/providers/registration-status.provider';
 
 @Module({
-  imports: [EdvModule, HidWalletModule, DidModule, TxSendModuleModule],
+  imports: [
+    EdvModule,
+    HidWalletModule,
+    DidModule,
+    TxSendModuleModule,
+    StatusModule,
+  ],
   controllers: [CredentialController],
   providers: [
     CredentialService,
     CredentialSSIService,
     HidWalletService,
+    StatusService,
     CredentialRepository,
+    TxnStatusRepository,
     ...databaseProviders,
     ...credentialProviders,
+    ...statusProviders,
   ],
 })
 export class CredentialModule implements NestModule {

src/credential/dto/create-credential.dto.ts

@@ -10,6 +10,7 @@ import {
   ValidateIf,
   ArrayNotEmpty,
   IsEnum,
+  IsObject,
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { ValidateVerificationMethodId } from 'src/utils/customDecorator/vmId.decorator';
@@ -18,6 +19,56 @@ import { IsSchemaId } from 'src/utils/customDecorator/schemaId.deceorator';
 import { IsVcId } from 'src/utils/customDecorator/vc.decorator';
 import { subjectDID } from 'src/utils/customDecorator/SubjectDid.decorator';
 
+export class ResolveCredentialMetadata {
+  @ApiProperty({
+    name: 'credentialId',
+    description: 'credentialId of credential',
+    example: 'vc:hid:testnet:z6MkqexphEhpi9jKZi8XLYiwCEsSWMdUt6YzjCfqdxKecJXM',
+  })
+  @IsString()
+  credentialId: string;
+
+  @ApiProperty({
+    name: 'type',
+    description: 'schema type of credential',
+    example: '{ schemaId, schemaType }',
+  })
+  @IsObject()
+  @IsOptional()
+  type?: object;
+
+  @ApiProperty({
+    name: 'issuerDid',
+    description: 'issuerDid  of credential',
+    example: 'did:hid:testnet:asdasd',
+  })
+  @IsString()
+  issuerDid: string;
+
+  @ApiProperty({
+    name: 'persist',
+    description:
+      'return credentialDocument if persist is set to true at the time of issuing credential',
+    example: true,
+  })
+  persist: boolean;
+
+  @ApiProperty({
+    name: 'registerCredentialStatus',
+    description: 'if crendetialstatus was sent to blockchain',
+    example: true,
+  })
+  registerCredentialStatus: boolean;
+
+  @ApiProperty({
+    name: 'transactionStatus',
+    description: 'transactionStatus of credential',
+    required: false,
+  })
+  @IsOptional()
+  @IsObject()
+  transactionStatus: object;
+}
 export enum Namespace {
   testnet = 'testnet',
   // mainnet = '',
@@ -399,12 +450,13 @@ export class CreateCredentialResponse {
     type: CredStatus,
   })
   credentialStatus: CredStatus;
+
   @ApiProperty({
-    name: 'persist',
-    description: 'Define whether to store cred or ust store its meta',
-    example: true,
+    name: 'metadata',
+    description: 'metadata for this credential',
   })
-  persist: boolean;
+  @IsOptional()
+  metadata?: ResolveCredentialMetadata;
 }
 
 export class ResolvedCredentialStatus extends CredStatus {
@@ -448,16 +500,9 @@ export class ResolveCredential {
   @ValidateNested({ each: true })
   credentialStatus: ResolvedCredentialStatus;
   @ApiProperty({
-    name: 'persist',
-    description:
-      'return credentialDocument if persist is set to true at the time of issuing credential',
-    example: true,
+    name: 'metadata',
+    description: 'metadata for this credential',
   })
-  persist: boolean;
-  @ApiProperty({
-    description: 'If set true then return credential Document also',
-    name: 'retrieveCredential',
-    example: true,
-  })
-  retrieveCredential: boolean;
+  @IsOptional()
+  metadata?: ResolveCredentialMetadata;
 }

src/credential/schemas/credntial.schema.ts

@@ -1,5 +1,5 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
-import { IsBoolean, IsOptional, IsString } from 'class-validator';
+import { IsBoolean, IsObject, IsOptional, IsString } from 'class-validator';
 import { IsDid } from 'src/utils/customDecorator/did.decorator';
 import { IsVcId } from 'src/utils/customDecorator/vc.decorator';
 
@@ -30,13 +30,17 @@ export class Credential {
   @Prop({ required: true })
   persist: boolean;
 
+  @IsBoolean()
+  @Prop({ required: true })
+  registerCredentialStatus: boolean;
+
   @IsString()
   @Prop()
   transactionHash: string;
 
-  @IsString()
-  @Prop()
-  type: string;
+  @IsObject()
+  @Prop({ type: 'object' })
+  type: object;
 }
 
 const CredentialSchema = SchemaFactory.createForClass(Credential);

src/credential/services/credential.service.ts

@@ -4,7 +4,10 @@ import {
   Logger,
   NotFoundException,
 } from '@nestjs/common';
-import { CreateCredentialDto } from '../dto/create-credential.dto';
+import {
+  CreateCredentialDto,
+  ResolveCredentialMetadata,
+} from '../dto/create-credential.dto';
 import { UpdateCredentialDto } from '../dto/update-credential.dto';
 import { ConfigService } from '@nestjs/config';
 import { CredentialSSIService } from './credential.ssi.service';
@@ -24,6 +27,7 @@ import {
 import { getAppVault, getAppMenemonic } from '../../utils/app-vault-service';
 import { TxSendModuleService } from 'src/tx-send-module/tx-send-module.service';
 import * as NodeCache from 'node-cache';
+import { StatusService } from 'src/status/status.service';
 const myCache = new NodeCache();
 @Injectable()
 export class CredentialService {
@@ -34,6 +38,7 @@ export class CredentialService {
     private credentialRepository: CredentialRepository,
     private readonly didRepositiory: DidRepository,
     private readonly txnService: TxSendModuleService,
+    private readonly statusService: StatusService,
   ) {}
 
   async checkAllowence(address) {
@@ -244,7 +249,7 @@ export class CredentialService {
         'create() method: before creating credential doc in db',
         'CredentialService',
       );
-      await this.credentialRepository.create({
+      const credentialDetail = await this.credentialRepository.create({
         appId: appDetail.appId,
         credentialId: signedCredential.id,
         issuerDid,
@@ -253,14 +258,25 @@ export class CredentialService {
         transactionHash: credentialStatusRegistrationResult
           ? credentialStatusRegistrationResult.transactionHash
           : '',
-        type: signedCredential.type[1], // TODO : MAYBE REMOVE HARDCODING MAYBE NOT
+        type: { schemaType: signedCredential.type[1], schemaId }, // TODO : MAYBE REMOVE HARDCODING MAYBE NOT
+        registerCredentialStatus: registerCredentialStatus
+          ? registerCredentialStatus
+          : false,
       });
       Logger.log('create() method: ends....', 'CredentialService');
 
+      const metadata = {
+        credentialId: credentialDetail.credentialId,
+        persist: credentialDetail.persist,
+        type: credentialDetail.type,
+        issuerDid: credentialDetail.issuerDid,
+        registerCredentialStatus: credentialDetail.registerCredentialStatus,
+      } as ResolveCredentialMetadata;
+
       return {
         credentialDocument: signedCredential,
         credentialStatus: credStatusTemp,
-        persist,
+        metadata,
       };
     } catch (e) {
       throw new BadRequestException([e.message]);
@@ -316,22 +332,56 @@ export class CredentialService {
       'resolveCredential() method: before initialising HypersignVerifiableCredential',
       'CredentialService',
     );
-    const hypersignCredential = new HypersignVerifiableCredential();
-    let credentialStatus;
-    try {
-      credentialStatus = await hypersignCredential.resolveCredentialStatus({
-        credentialId,
-      });
-    } catch (e) {
-      credentialStatus = undefined;
+
+    const metadata = {
+      credentialId: credentialDetail.credentialId,
+      persist: credentialDetail.persist,
+      type: credentialDetail.type,
+      issuerDid: credentialDetail.issuerDid,
+      registerCredentialStatus: credentialDetail.registerCredentialStatus,
+    } as ResolveCredentialMetadata;
+    let credentialStatus = undefined;
+    // If user had registered the credential on the blockchain
+    // Only then we will go ahead with credential status retrival
+    const shouldRetriveCredential = credentialDetail.registerCredentialStatus
+      ? credentialDetail.registerCredentialStatus
+      : true; // making default true for backwards compatibility
+    if (shouldRetriveCredential) {
+      /// First check this transaction was successful in lcoal db or there was some error
+      const statusResponse = await this.statusService.findBySsiId(credentialId);
+      let wasTransactionSuccess = false;
+      if (statusResponse) {
+        const firstResponse = statusResponse[0];
+        if (
+          firstResponse &&
+          firstResponse.data &&
+          firstResponse.totalCount > 0
+        ) {
+          metadata['transactionStatus'] = firstResponse.data;
+          if (firstResponse.data.findIndex((x) => x['status'] == 0) >= 0) {
+            wasTransactionSuccess = true;
+          }
+        }
+      }
+
+      /// Retrive status from the blockchain only when status = 0, otherwise skip
+      if (wasTransactionSuccess) {
+        try {
+          const hypersignCredential = new HypersignVerifiableCredential();
+          credentialStatus = await hypersignCredential.resolveCredentialStatus({
+            credentialId,
+          });
+        } catch (e) {
+          credentialStatus = undefined;
+        }
+        Logger.log('resolveCredential() method: ends....', 'CredentialService');
+      }
     }
-    Logger.log('resolveCredential() method: ends....', 'CredentialService');
 
     return {
       credentialDocument: credential ? credential : undefined,
       credentialStatus,
-      persist: credentialDetail.persist,
-      retrieveCredential,
+      metadata,
     };
   }
 

src/schema/services/schema.service.ts

@@ -205,7 +205,6 @@ export class SchemaService {
     );
 
     const statusResponse = await this.statusService.findBySsiId(schemaId);
-    Logger.log(statusResponse);
     if (statusResponse) {
       const firstResponse = statusResponse[0];
       if (firstResponse && firstResponse.data) {