[MEX-748] Implement Claim Rewards notifications in xPortal

.env.example

@@ -46,6 +46,7 @@ ENABLE_CACHE_WARMER=true
 ENABLE_EVENTS_NOTIFIER=false
 ENABLE_TRACER=false
 ENABLE_COMPLEXITY=true
+ENABLE_PUSH_NOTIFICATIONS=true
 
 #Log filename to use for file logging. Optional
 LOG_FILE=
@@ -74,3 +75,10 @@ OPEN_EXCHANGE_RATES_URL=https://openexchangerates.org/api
 # AWS Timestream
 AWS_TIMESTREAM_READ=false
 AWS_TIMESTREAM_WRITE=false
+
+# Notification Service Configuration
+PUSH_NOTIFICATIONS_API_URL=
+PUSH_NOTIFICATIONS_API_KEY=
+PUSH_NOTIFICATIONS_BATCH_SIZE=100
+PUSH_NOTIFICATIONS_MAX_RETRIES=3
+PUSH_NOTIFICATIONS_CHAIN_ID=508  # 508 for devnet

src/helpers/api.config.service.ts

@@ -196,6 +196,50 @@ export class ApiConfigService {
         return mongoDBPassword;
     }
 
+    getNotificationsApiUrl(): string {
+        const apiUrl = this.configService.get<string>('PUSH_NOTIFICATIONS_API_URL');
+        if (!apiUrl) {
+            throw new Error('No push notifications API url present');
+        }
+        return apiUrl;
+    }
+
+    getNotificationsApiKey(): string {
+        const apiKey = this.configService.get<string>('PUSH_NOTIFICATIONS_API_KEY');
+        if (!apiKey) {
+            throw new Error('No push notifications API key present');
+        }
+        return apiKey;
+    }
+
+    getNotificationsBatchSize(): number {
+        const batchSize = this.configService.get<number>(
+            'PUSH_NOTIFICATIONS_BATCH_SIZE',
+        );
+        if (!batchSize) {
+            throw new Error('No push notifications batch size present');
+        }
+        return batchSize;
+    }
+
+    getNotificationsMaxRetries(): number {
+        const maxRetries = this.configService.get<number>(
+            'PUSH_NOTIFICATIONS_MAX_RETRIES',
+        );
+        if (!maxRetries) {
+            throw new Error('No push notifications max retries present');
+        }
+        return maxRetries;
+    }
+
+    getChainId(): number {
+        const chainId = this.configService.get<number>('PUSH_NOTIFICATIONS_CHAIN_ID');
+        if (!chainId) {
+            throw new Error('No push notifications chainId present');
+        }
+        return chainId;
+    }
+
     getJwtSecret(): string {
         const secret = this.configService.get<string>('JWT_SECRET');
         if (!secret) {
@@ -352,4 +396,14 @@ export class ApiConfigService {
     getRateLimiterSecret(): string | undefined {
         return this.configService.get<string>('RATE_LIMITER_SECRET');
     }
+
+    isNotificationsModuleActive(): boolean {
+        const notificationsModuleActive = this.configService.get<string>(
+            'ENABLE_PUSH_NOTIFICATIONS',
+        );
+        if (!notificationsModuleActive) {
+            return false;
+        }
+        return notificationsModuleActive === 'true';
+    }
 }

src/main.ts

@@ -13,6 +13,7 @@ import cookieParser from 'cookie-parser';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { LoggerService } from '@nestjs/common';
 import { NestExpressApplication } from '@nestjs/platform-express';
+import { PushNotificationsModule } from './modules/push-notifications/push.notifications.module';
 
 async function bootstrap() {
     BigNumber.config({ EXPONENTIAL_AT: [-30, 30] });
@@ -90,5 +91,10 @@ async function bootstrap() {
         await rabbitMqService.getFilterAddresses();
         await eventsNotifierApp.listen(5673, '0.0.0.0');
     }
+
+    if (apiConfigService.isNotificationsModuleActive()) {
+        const pushNotificationsApp = await NestFactory.create(PushNotificationsModule);
+        await pushNotificationsApp.listen(5674, '0.0.0.0');
+    }
 }
 bootstrap();

src/modules/push-notifications/models/push.notifications.model.ts

@@ -0,0 +1,47 @@
+export interface EnergyDetailsType {
+    lastUpdateEpoch: number;
+    amount: string;
+    totalLockedTokens: string;
+}
+
+export interface AccountType {
+    address: string;
+    nonce: number;
+    balance: string;
+    balanceNum: number;
+    totalBalanceWithStake: string;
+    totalBalanceWithStakeNum: number;
+    timestamp: number;
+    shardID: number;
+    totalStake: string;
+    energy: string;
+    energyNum: number;
+    energyDetails: EnergyDetailsType;
+    totalUnDelegate: string;
+}
+
+export interface ContractKeysRaw {
+    data: {
+        blockInfo: {
+            hash: string;
+            nonce: number;
+            rootHash: string;
+        };
+        pairs: Record<string, string>;
+    };
+    code: string;
+}
+
+export interface UserEnergyAddress {
+    address: string;
+    notificationSent: boolean;
+}
+
+export interface NotificationPayload {
+    addresses: string[];
+    chainId: number;
+    title: string;
+    body: string;
+    route: string;
+    iconUrl: string;
+} 

src/modules/push-notifications/push.notifications.module.ts

@@ -0,0 +1,31 @@
+import { Module } from '@nestjs/common';
+import { ScheduleModule } from '@nestjs/schedule';
+import { PushNotificationsService } from './push.notifications.service';
+import { PushNotificationsSetterService } from './services/push.notifications.setter.service';
+import { CommonAppModule } from '../../common.app.module';
+import { MXCommunicationModule } from '../../services/multiversx-communication/mx.communication.module';
+import { ElasticSearchModule } from '../../services/elastic-search/elastic.search.module';
+import { ContextModule } from '../../services/context/context.module';
+import { CacheModule } from '../../services/caching/cache.module';
+import { EnergyModule } from '../energy/energy.module';
+
+@Module({
+    imports: [
+        CommonAppModule,
+        ScheduleModule.forRoot(),
+        MXCommunicationModule,
+        ElasticSearchModule,
+        ContextModule,
+        CacheModule,
+        EnergyModule,
+    ],
+    providers: [
+        PushNotificationsService,
+        PushNotificationsSetterService,
+    ],
+    exports: [
+        PushNotificationsService,
+        PushNotificationsSetterService,
+    ],
+})
+export class PushNotificationsModule {}