Skip to content

Commit a8f43fe

Browse files
varsha766varsha766
authored
Merge pull request #168 from hypersign-protocol/implement/creditmodule
Implement/creditmodule
2 parents a04e28f + 0c03e1c commit a8f43fe

Some content is hidden

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

47 files changed

+2044
-15
lines changed

‎src/app.module.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Module } from '@nestjs/common';
1+
import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
22
import { ConfigModule } from '@nestjs/config';
33
import { EdvModule } from './edv/edv.module';
44
import { AllExceptionsFilter } from './utils/utils';
@@ -9,6 +9,10 @@ import { CredentialModule } from './credential/credential.module';
99
import { PresentationModule } from './presentation/presentation.module';
1010
import { TxSendModuleModule } from './tx-send-module/tx-send-module.module';
1111
import { StatusModule } from './status/status.module';
12+
import { CreditManagerModule } from './credit-manager/credit-manager.module';
13+
import { LogModule } from './log/log.module';
14+
import { AppLoggerMiddleware } from './utils/interceptor/http-interceptor';
15+
import { UsageModule } from './usage/usage.module';
1216
@Module({
1317
imports: [
1418
ConfigModule.forRoot({
@@ -22,6 +26,9 @@ import { StatusModule } from './status/status.module';
2226
PresentationModule,
2327
TxSendModuleModule,
2428
StatusModule,
29+
CreditManagerModule,
30+
LogModule,
31+
UsageModule,
2532
],
2633
controllers: [],
2734
providers: [{ provide: APP_FILTER, useClass: AllExceptionsFilter }],

‎src/credential/controllers/credential.controller.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ import { Credential } from '../schemas/credntial.schema';
4949
import { GetCredentialList } from '../dto/fetch-credential.dto';
5050
import { RegisterCredentialStatusDto } from '../dto/register-credential.dto';
5151
import { TxnHash } from 'src/did/dto/create-did.dto';
52+
import { ReduceCreditGuard } from 'src/credit-manager/gaurd/reduce-credit.gaurd';
5253
@ApiBearerAuth('Authorization')
53-
@UseGuards(AuthGuard('jwt'))
54+
@UseGuards(AuthGuard('jwt'), ReduceCreditGuard)
5455
@Controller('credential')
5556
@ApiTags('Credential')
5657
export class CredentialController {

‎src/credential/credential.module.ts

+6
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ import { StatusModule } from 'src/status/status.module';
2121
import { StatusService } from 'src/status/status.service';
2222
import { TxnStatusRepository } from 'src/status/repository/status.repository';
2323
import { statusProviders } from 'src/status/providers/registration-status.provider';
24+
import { CreditManagerModule } from 'src/credit-manager/credit-manager.module';
25+
import { AppLoggerMiddleware } from 'src/utils/interceptor/http-interceptor';
26+
import { LogModule } from 'src/log/log.module';
2427

2528
@Module({
2629
imports: [
@@ -29,6 +32,8 @@ import { statusProviders } from 'src/status/providers/registration-status.provid
2932
DidModule,
3033
TxSendModuleModule,
3134
StatusModule,
35+
CreditManagerModule,
36+
LogModule,
3237
],
3338
controllers: [CredentialController],
3439
providers: [
@@ -53,5 +58,6 @@ export class CredentialModule implements NestModule {
5358
{ path: 'credential/:credentialId', method: RequestMethod.GET },
5459
)
5560
.forRoutes(CredentialController);
61+
consumer.apply(AppLoggerMiddleware).forRoutes(CredentialController);
5662
}
5763
}

‎src/credit-manager/controllers/credit-manager.controller.spec.ts

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import { Test, TestingModule } from '@nestjs/testing';
2+
import { CreditManagerController } from './credit-manager.controller';
3+
import { CreditService } from '../services/credit-manager.service';
4+
5+
describe('CreditManagerController', () => {
6+
let controller: CreditManagerController;
7+
8+
beforeEach(async () => {
9+
const module: TestingModule = await Test.createTestingModule({
10+
controllers: [CreditManagerController],
11+
providers: [CreditService],
12+
}).compile();
13+
14+
controller = module.get<CreditManagerController>(CreditManagerController);
15+
});
16+
17+
it('should be defined', () => {
18+
expect(controller).toBeDefined();
19+
});
20+
});

‎src/credit-manager/controllers/credit-manager.controller.ts

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
import {
2+
Controller,
3+
Get,
4+
Post,
5+
Param,
6+
UseFilters,
7+
UseGuards,
8+
Logger,
9+
Req,
10+
Body,
11+
} from '@nestjs/common';
12+
import { CreditService } from '../services/credit-manager.service';
13+
// import { AllExceptionsFilter } from '../../../utility/exception.filter';
14+
import {
15+
ApiBadRequestResponse,
16+
ApiBearerAuth,
17+
ApiCreatedResponse,
18+
ApiNotFoundResponse,
19+
ApiOkResponse,
20+
ApiTags,
21+
ApiUnauthorizedResponse,
22+
} from '@nestjs/swagger';
23+
// import { CustomAuthGuard } from 'src/auth/auth.guard';
24+
// import { CreditAuthGuard } from 'src/auth/credit-token.guard';
25+
import {
26+
createCreditResponse,
27+
ActivateCredtiResponse,
28+
} from '../dto/create-credit-manager.dto';
29+
import { AllExceptionsFilter } from 'src/utils/utils';
30+
import {
31+
CreditError,
32+
CreditNotFoundError,
33+
CreditUnAuthorizeError,
34+
} from '../dto/error-credit.dto';
35+
import { AuthGuard } from '@nestjs/passport';
36+
import { CreditAuthGuard } from '../gaurd/credit-token.gaurd';
37+
38+
@UseFilters(AllExceptionsFilter)
39+
@ApiTags('Credit')
40+
@Controller('credit')
41+
export class CreditManagerController {
42+
constructor(private readonly creditManagerService: CreditService) {}
43+
@ApiBearerAuth('Authorization')
44+
@UseGuards(CreditAuthGuard)
45+
@ApiCreatedResponse({
46+
description: 'Credit detail is added successfully',
47+
type: createCreditResponse,
48+
})
49+
@ApiBadRequestResponse({
50+
description: 'Unable to add credit detail',
51+
type: CreditError,
52+
})
53+
@ApiNotFoundResponse({
54+
description: 'Missing',
55+
type: CreditNotFoundError,
56+
})
57+
@ApiUnauthorizedResponse({
58+
description: 'Authorization token is invalid or expired.',
59+
type: CreditUnAuthorizeError,
60+
})
61+
@Post()
62+
AddNewCreditDetail(@Req() req) {
63+
Logger.log(
64+
'AddNewCreditDetail() method to add credit detail',
65+
'CreditManagerController',
66+
);
67+
return this.creditManagerService.addCreditDetail(req.creditDetail);
68+
}
69+
@ApiBearerAuth('Authorization')
70+
@UseGuards(AuthGuard('jwt'))
71+
@ApiOkResponse({
72+
description: 'Credit is activated successfully',
73+
type: ActivateCredtiResponse,
74+
})
75+
@ApiBadRequestResponse({
76+
description: 'Unable to activate credit detail',
77+
type: CreditError,
78+
})
79+
@ApiNotFoundResponse({
80+
description: 'Authorization token is invalid or expired.',
81+
type: CreditNotFoundError,
82+
})
83+
@ApiUnauthorizedResponse({
84+
description: 'Authorization token is invalid or expired.',
85+
type: CreditUnAuthorizeError,
86+
})
87+
@Post(':creditId/activate')
88+
activateCredit(@Param('creditId') creditId: string) {
89+
Logger.log(
90+
'activateCredit() method to activate existing credit detail',
91+
'CreditManagerController',
92+
);
93+
return this.creditManagerService.activateCredit(creditId);
94+
}
95+
@ApiBearerAuth('Authorization')
96+
@UseGuards(AuthGuard('jwt'))
97+
@ApiOkResponse({
98+
description: 'Fetched all credit detail',
99+
type: createCreditResponse,
100+
})
101+
@ApiBadRequestResponse({
102+
description: 'Unable to fetch credit detail',
103+
type: CreditError,
104+
})
105+
@ApiUnauthorizedResponse({
106+
description: 'Authorization token is invalid or expired.',
107+
type: CreditUnAuthorizeError,
108+
})
109+
@Get()
110+
fetchCreditDetails() {
111+
Logger.log(
112+
'fetchCreditDetails() method to fetch all credit detail',
113+
'CreditManagerController',
114+
);
115+
return this.creditManagerService.fetchCreditDetails();
116+
}
117+
@ApiBearerAuth('Authorization')
118+
@UseGuards(AuthGuard('jwt'))
119+
@ApiOkResponse({
120+
description: 'The details of the credit have been successfully fetched.',
121+
type: ActivateCredtiResponse,
122+
})
123+
@ApiBadRequestResponse({
124+
description: 'Unable to fetch particular credit detail',
125+
type: CreditError,
126+
})
127+
@ApiUnauthorizedResponse({
128+
description: 'Authorization token is invalid or expired.',
129+
type: CreditUnAuthorizeError,
130+
})
131+
@Get(':creditId')
132+
fetchParticularCreditDetail(@Param('creditId') creditId: string, @Req() req) {
133+
Logger.log(
134+
'fetchParticularCreditDetail() method to fetch particular credit detail',
135+
'CreditManagerController',
136+
);
137+
const appId = req.user.appId;
138+
return this.creditManagerService.fetchParticularCreditDetail(
139+
creditId,
140+
appId,
141+
);
142+
}
143+
}

‎src/credit-manager/credit-manager.module.ts

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
2+
import { CreditManagerController } from './controllers/credit-manager.controller';
3+
import { creditSchemaProviders } from './schema/credit.provider';
4+
import { CreditService } from './services/credit-manager.service';
5+
import { CreditManagerRepository } from './repository/credit-manager.repository';
6+
import { JwtService } from '@nestjs/jwt';
7+
import { databaseProviders } from 'src/mongoose/tenant-mongoose-connections';
8+
import { CreditManagerService } from './managers/credit-manager.service';
9+
import { ApiCreditService } from './services/api-credit.service';
10+
import { StorageCreditService } from './services/storage-credit.service';
11+
import { AttestationCreditService } from './services/attestation-credit.service';
12+
import { WhitelistSSICorsMiddleware } from 'src/utils/middleware/cors.middleware';
13+
14+
@Module({
15+
imports: [],
16+
controllers: [CreditManagerController],
17+
providers: [
18+
CreditService,
19+
...databaseProviders,
20+
...creditSchemaProviders,
21+
CreditManagerRepository,
22+
JwtService,
23+
CreditManagerService,
24+
ApiCreditService,
25+
StorageCreditService,
26+
AttestationCreditService,
27+
],
28+
exports: [CreditService, CreditManagerRepository, CreditManagerService],
29+
})
30+
export class CreditManagerModule implements NestModule {
31+
configure(consumer: MiddlewareConsumer) {
32+
consumer
33+
.apply(WhitelistSSICorsMiddleware)
34+
.forRoutes(CreditManagerController);
35+
}
36+
}

‎src/credit-manager/dto/create-credit-manager.dto.ts

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
import { ApiProperty } from '@nestjs/swagger';
2+
import { IsNumber, IsString, Min } from 'class-validator';
3+
import { Status } from '../schema/credit-manager.schema';
4+
export enum ValidityPeriodUnit {
5+
DAYS = 'DAYS',
6+
WEEK = 'WEEK',
7+
MONTH = 'MONTH',
8+
YEAR = 'YEAR',
9+
}
10+
export class CreateCreditManagerDto {
11+
@ApiProperty({
12+
name: 'credit',
13+
description: 'Number of credits available',
14+
example: 1000,
15+
})
16+
@IsNumber()
17+
@Min(10)
18+
totalCredits: number;
19+
validityDuration: number;
20+
validityDurationUnit: ValidityPeriodUnit;
21+
serviceId: string;
22+
creditDenom: string;
23+
}
24+
25+
export class createCreditResponse {
26+
@ApiProperty({
27+
name: 'totalCredits',
28+
description: 'Total available credit',
29+
example: 1000,
30+
})
31+
@IsNumber()
32+
totalCredits: number;
33+
@ApiProperty({
34+
name: 'used',
35+
description: 'Total number of credit used till now',
36+
example: 0,
37+
})
38+
@IsNumber()
39+
used: number;
40+
@ApiProperty({
41+
name: 'validityDuration',
42+
description:
43+
'The number of days the credit is valid from the date of activation',
44+
example: 60,
45+
})
46+
@IsNumber()
47+
validityDuration: number;
48+
@ApiProperty({
49+
name: 'status',
50+
description:
51+
'The current status of the credit detail. Indicates whether the credit is active or inactive.',
52+
enum: Status,
53+
example: Status.INACTIVE,
54+
})
55+
@IsString()
56+
status: string;
57+
@ApiProperty({
58+
name: '_id',
59+
description: 'Unique identifier of credit detail',
60+
example: '66e0407bc7f8a92162d1e824',
61+
})
62+
@IsString()
63+
_id: string;
64+
@ApiProperty({
65+
name: 'createdAt',
66+
description: 'Time at which document is added',
67+
example: '2024-09-10T12:50:03.984Z',
68+
})
69+
@IsString()
70+
createdAt: string;
71+
@ApiProperty({
72+
name: 'updatedAt',
73+
description: 'Time at which document last updated',
74+
example: '2024-09-10T12:50:03.984Z',
75+
})
76+
@IsString()
77+
updatedAt: string;
78+
}
79+
80+
export class ActivateCredtiResponse extends createCreditResponse {
81+
@ApiProperty({
82+
name: 'status',
83+
description:
84+
'The current status of the credit detail. Indicates whether the credit is active or inactive.',
85+
enum: Status,
86+
example: Status.ACTIVE,
87+
})
88+
@IsString()
89+
status: string;
90+
@ApiProperty({
91+
name: 'expiresAt',
92+
description:
93+
'The date and time when the credit expires. After this timestamp, the credit is no longer valid.',
94+
example: '2024-11-10T12:50:03.984Z',
95+
})
96+
@IsString()
97+
expiresAt: string;
98+
}

0 commit comments

Comments
 (0)