Feature/2243 trustchain retirement support

api-gateway/src/api/service/analytics.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, HttpCode, HttpException, HttpStatus, Post, Query } from '@nestjs/common';
+import { Body, Controller, Get, HttpCode, HttpException, HttpStatus, Post, Query } from '@nestjs/common';
 import { ApiInternalServerErrorResponse, ApiBody, ApiOkResponse, ApiOperation, ApiTags, ApiExtraModels, ApiQuery } from '@nestjs/swagger';
 import { EntityOwner, Permissions } from '@guardian/interfaces';
 import { FilterDocumentsDTO, FilterModulesDTO, FilterPoliciesDTO, FilterSchemasDTO, FilterSearchPoliciesDTO, InternalServerErrorDTO, CompareDocumentsDTO, CompareModulesDTO, ComparePoliciesDTO, CompareSchemasDTO, SearchPoliciesDTO, FilterToolsDTO, CompareToolsDTO, FilterSearchBlocksDTO, SearchBlocksDTO, Examples } from '#middlewares';
@@ -947,4 +947,35 @@ export class AnalyticsApi {
             await InternalException(error, this.logger);
         }
     }
+
+    /**
+     * Get Indexer availability
+     */
+    @Get('/checkIndexer')
+    @Auth(
+        Permissions.POLICIES_POLICY_EXECUTE,
+    )
+    @ApiOperation({
+        summary: 'Get Indexer Availability.',
+        description: 'Returns Indexer Availability (true/false).',
+    })
+    @ApiOkResponse({
+        description: 'Successful operation.',
+        type: Boolean,
+    })
+    @ApiInternalServerErrorResponse({
+        description: 'Internal server error.',
+        type: InternalServerErrorDTO
+    })
+    @HttpCode(HttpStatus.OK)
+    async checkIndexerAvailability(
+        @AuthUser() user: IAuthUser
+    ): Promise<boolean> {
+        const guardians = new Guardians();
+        try {
+            return await guardians.getIndexerAvailability();
+        } catch (error) {
+            await InternalException(error, this.logger);
+        }
+    }
 }

api-gateway/src/api/service/contract.ts

@@ -1719,5 +1719,57 @@ export class ContractsApi {
             await InternalException(error, this.logger);
         }
     }
+
+    /**
+     * Get a list of all retire vcs from Indexer
+     */
+    @Get('/retireIndexer')
+    @Auth(
+        Permissions.CONTRACTS_DOCUMENT_READ,
+        // UserRole.STANDARD_REGISTRY,
+        // UserRole.USER
+    )
+    @ApiOperation({
+        summary: 'Return a list of all retire vcs from Indexer.',
+        description: 'Returns all retire vcs from Indexer.',
+    })
+    @ApiQuery({
+        name: 'contractTopicId',
+        type: String,
+        description: 'The topic id of contract',
+        required: true,
+        example: '0.0.0000000',
+    })
+    @ApiOkResponse({
+        description: 'Successful operation.',
+        isArray: true,
+        headers: pageHeader,
+        schema: {
+            type: 'array',
+            items: {
+                type: 'object'
+            }
+        }
+    })
+    @ApiInternalServerErrorResponse({
+        description: 'Internal server error.',
+        type: InternalServerErrorDTO,
+    })
+    @ApiExtraModels(RetirePoolDTO, InternalServerErrorDTO)
+    @HttpCode(HttpStatus.OK)
+    async getRetireVCsFromIndexer(
+        @AuthUser() user: IAuthUser,
+        @Response() res: any,
+        @Query('contractTopicId') contractTopicId: string,
+    ): Promise<any[]> {
+        try {
+            const owner = new EntityOwner(user);
+            const guardians = new Guardians();
+            const [vcs, count] = await guardians.getRetireVCsFromIndexer(owner, contractTopicId);
+            return res.header('X-Total-Count', count).send(vcs);
+        } catch (error) {
+            await InternalException(error, this.logger);
+        }
+    }
     //#endregion
 }

api-gateway/src/helpers/guardians.ts

@@ -11,12 +11,14 @@ import {
     IContract,
     IDidObject,
     IOwner,
+    IRetirementMessage,
     IRetirePool,
     IRetireRequest,
     ISchema,
     IToken,
     ITokenInfo,
     IUser,
+    IVC,
     IVCDocument,
     IVPDocument,
     MessageAPI,
@@ -1846,6 +1848,22 @@ export class Guardians extends NatsService {
         });
     }
 
+    /**
+     * Get retire VCs from Indexer
+     * @param owner
+     * @param contractTopicId
+     * @returns Retire VCs from Indexer and count
+     */
+    public async getRetireVCsFromIndexer(
+        owner: IOwner,
+        contractTopicId: string
+    ): Promise<[IRetirementMessage[], number]> {
+        return await this.sendMessage(ContractAPI.GET_RETIRE_VCS_FROM_INDEXER, {
+            owner,
+            contractTopicId
+        });
+    }
+
     //#endregion
 
     /**
@@ -3197,4 +3215,12 @@ export class Guardians extends NatsService {
     public async previewSchemaRule(zip: any, owner: IOwner) {
         return await this.sendMessage(MessageAPI.PREVIEW_SCHEMA_RULE_FILE, { zip, owner });
     }
+
+
+    /**
+     * Get Indexer availability
+     */
+    public async getIndexerAvailability(): Promise<boolean> {
+        return await this.sendMessage(MessageAPI.GET_INDEXER_AVAILABILITY, {});
+    }
 }

common/src/database-modules/database-server.ts

@@ -2063,7 +2063,8 @@ export class DatabaseServer extends AbstractDatabaseServer {
             wasTransferNeeded: boolean,
             transferSerials: number[],
             transferAmount: number,
-            tokenIds: string[]
+            tokenIds: string[],
+            target: string
         ]
     > {
         const mintRequests = await this.getMintRequests({
@@ -2098,7 +2099,7 @@ export class DatabaseServer extends AbstractDatabaseServer {
         if (vpDocument.tokenId) {
             tokenIds.add(vpDocument.tokenId);
         }
-
+        const target = mintRequests?.[0]?.target;
         for (const mintRequest of mintRequests) {
             if (mintRequest.error) {
                 errors.push(mintRequest.error);
@@ -2170,6 +2171,7 @@ export class DatabaseServer extends AbstractDatabaseServer {
             transferSerials,
             transferAmount,
             [...tokenIds],
+            target,
         ];
     }
 

common/src/interfaces/database-server.ts

@@ -1408,7 +1408,8 @@ export abstract class AbstractDatabaseServer {
             wasTransferNeeded: boolean,
             transferSerials: number[],
             transferAmount: number,
-            tokenIds: string[]
+            tokenIds: string[],
+            target: string,
         ]
     >
 

frontend/src/app/modules/contract-engine/dialogs/user-retire-pools-dialog/user-retire-pools-dialog.component.ts

@@ -52,6 +52,7 @@ export class UserRetirePoolsDialogComponent implements OnInit {
 
     loadPools() {
         this.loading = true;
+
         this.contractService
             .getRetirePools({
                 pageIndex: this.pageIndex,

frontend/src/app/modules/policy-engine/policy-engine.module.ts

@@ -1,5 +1,5 @@
 import { NgModule } from '@angular/core';
-import { CommonModule } from '@angular/common';
+import { CommonModule, DatePipe } from '@angular/common';
 import { MaterialModule } from 'src/app/modules/common/material.module';
 import { FormsModule } from '@angular/forms';
 import { DragDropModule } from '@angular/cdk/drag-drop';
@@ -295,6 +295,7 @@ import { RequestDocumentBlockDialog } from './policy-viewer/blocks/request-docum
         WizardService,
         DialogService,
         PolicyProgressService,
+        DatePipe,
         {
             provide: CONFIGURATION_ERRORS,
             useValue: new Map()

frontend/src/app/modules/policy-engine/policy-viewer/blocks/messages-report-block/messages-report-block.component.html

@@ -184,6 +184,21 @@
                                         <div class="message-owner">{{message.__issuer}}</div>
                                     </div>
                                 </ng-container>
+
+                                <ng-container *ngIf="message.__ifRetireMessage">
+                                    <div class="message-header">
+                                        <mat-icon>receipt</mat-icon>
+                                        Retirement
+                                    </div>
+                                    <div class="message-data">
+                                        <div *ngIf="message.documents[0]?.credentialSubject[0]?.contractId" class="message-name">
+                                            Contract ID: <span>{{message.documents[0].credentialSubject[0].contractId}}</span>
+                                        </div>
+                                        <div *ngIf="message.documents[0]?.credentialSubject[0]?.user" class="message-name">
+                                            User ID: <span>{{message.documents[0].credentialSubject[0].user}}</span>
+                                        </div>
+                                    </div>
+                                </ng-container>
                             </div>
                         </div>
                     </div>
@@ -730,6 +745,75 @@
                             </div>
                         </div>
                     </ng-container>
+
+                    <ng-container *ngIf="selected.__ifRetireMessage">
+                        <div class="document-header">
+                            <mat-icon>receipt</mat-icon>
+                            Retirement message
+                        </div>
+
+                        <div class="field-delimiter" data-label="Document"></div>
+
+                        <div class="field" *ngIf="selected.documents">
+                            <div class="field-name">Document artifact:</div>
+                            <div class="field-value">
+                                <span class="field-link" (click)="onOpenDocument(selected)">Open document</span>
+                            </div>
+                        </div>
+
+                        <div class="field-delimiter" data-label="Retirement Information"></div>
+                        <div class="field">
+                            <div class="field-name">Contract ID:</div>
+                            <div class="field-value">{{selected.documents[0].credentialSubject[0].contractId}}</div>
+                        </div>
+                        <div class="field" *ngIf="selected.owner">
+                            <div class="field-name">User ID:</div>
+                            <div class="field-value">{{selected.documents[0].credentialSubject[0].user}}</div>
+                        </div>
+                        <div class="field" *ngIf="selected.consensusTimestamp">
+                            <div class="field-name">Transaction:</div>
+                            <div class="field-value">{{selected.consensusTimestamp}}</div>
+                        </div>
+                        <div *ngFor="let token of selected.documents[0].credentialSubject[0]?.tokens">
+                            <div class="field-delimiter"></div>
+                            <div class="field">
+                                <div class="field-name">Token ID:</div>
+                                <div class="field-value">{{token.tokenId}}</div>
+                            </div>
+                            <div class="field" *ngIf="token.serials && token.serials.length > 0">
+                                <div class="field-name">Instance ID:</div>
+                                <div class="field-value">{{token.serials.join(', ')}}</div>
+                            </div>
+                            <div class="field" *ngIf="!token.serials || token.serials.length <= 0">
+                                <div class="field-name">Amount:</div>
+                                <div class="field-value">{{token.count}}</div>
+                            </div>
+                        </div>
+
+                        <div class="field-delimiter" data-label="Hedera Information"></div>
+
+                        <div class="field">
+                            <div class="field-name">Topic ID:</div>
+                            <div class="field-value">
+                                <hedera-explorer type="topics"
+                                    [params]="selected.topicId">{{selected.topicId}}</hedera-explorer>
+                            </div>
+                        </div>
+                        <div class="field">
+                            <div class="field-name">Message ID:</div>
+                            <div class="field-value">
+                                <hedera-explorer type="topics" [params]="selected.topicId" subType="messages"
+                                    [subParams]="selected.sequenceNumber">{{selected.consensusTimestamp}}</hedera-explorer>
+                            </div>
+                        </div>
+                        <div class="field">
+                            <div class="field-name">Owner:</div>
+                            <div class="field-value">
+                                <hedera-explorer type="accounts"
+                                    [params]="selected.owner">{{selected.owner}}</hedera-explorer>
+                            </div>
+                        </div>
+                    </ng-container>
                 </div>
             </div>
         </div>