Merge pull request #118 from OsejiFabian/feature/implement-four-issues

feat: Implement four issues - leaderboard, token verification, networ…

Author: AlAfiz

README.md

@@ -90,3 +90,67 @@ curl http://localhost:3000/api/v1/stats/tvl?format=short
   "lastUpdated": "2026-03-19T00:00:00Z"
 }
 ```
+
+### Analytics Endpoints
+
+#### `GET /api/v1/analytics/leaderboard`
+
+Get the top traders leaderboard sorted by 7-day trading volume.
+
+**Response Format:**
+```json
+[
+  {
+    "rank": 1,
+    "walletAddress": "0x742d...8b4c",
+    "volumeUSD": 850000
+  },
+  {
+    "rank": 2,
+    "walletAddress": "0x8f3a...2d1e",
+    "volumeUSD": 720000
+  }
+]
+```
+
+### Token Verification
+
+#### `GET /api/v1/tokens/verify/:address`
+
+Check if a Stellar contract address is officially verified and safe to trade.
+
+**Response Format:**
+```json
+{
+  "isVerified": true,
+  "riskLevel": "LOW"
+}
+```
+
+**Parameters:**
+- `address` (path): Stellar contract address to verify
+
+### Network Fees
+
+#### `GET /api/v1/network/fees`
+
+Get current Stellar network fee estimates.
+
+**Response Format:**
+```json
+{
+  "success": true,
+  "data": {
+    "baseFee": 100,
+    "priorityFee": 500,
+    "estimatedTotal": 600
+  },
+  "timestamp": "2024-01-15T10:30:00.000Z"
+}
+```
+
+**Note:** This endpoint includes a 30-second cache header for performance optimization.
+
+### Background Jobs
+
+The API includes a background indexer job that runs every 5 minutes to sync blockchain data. This is automatically initialized when the server starts and logs "Syncing Blockchain Data..." during each run.

package.json

@@ -46,6 +46,7 @@
     "express-rate-limit": "^8.3.1",
     "ioredis": "^5.10.1",
     "jsonwebtoken": "^9.0.3",
+    "node-cron": "^3.0.3",
     "pg": "^8.11.0",
     "prisma": "^5.19.1",
     "rate-limit-redis": "^4.3.1",
@@ -60,6 +61,7 @@
     "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
     "@types/node": "^25.2.3",
+    "@types/node-cron": "^3.0.11",
     "@types/pdf-parse": "^1.1.5",
     "jest": "^30.2.0",
     "ts-jest": "^29.4.6",

src/analytics/analytics.controller.ts

@@ -1,6 +1,6 @@
 import { Controller, Get, HttpStatus, Query } from '@nestjs/common';
 import { ApiOperation, ApiResponse, ApiTags, ApiQuery } from '@nestjs/swagger';
-import { AnalyticsService, VolumeData, ImpermanentLossData } from './analytics.service';
+import { AnalyticsService, VolumeData, ImpermanentLossData, LeaderboardEntry } from './analytics.service';
 
 @ApiTags('Analytics')
 @Controller('api/v1/analytics')
@@ -77,4 +77,25 @@ export class AnalyticsController {
       timestamp: new Date().toISOString(),
     };
   }
+
+  @Get('leaderboard')
+  @ApiOperation({ summary: 'Get top volume traders leaderboard' })
+  @ApiResponse({
+    status: 200,
+    description: 'Successfully retrieved leaderboard data',
+    schema: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          rank: { type: 'number', example: 1 },
+          walletAddress: { type: 'string', example: '0x742d...8b4c' },
+          volumeUSD: { type: 'number', example: 850000 },
+        },
+      },
+    },
+  })
+  getLeaderboard(): LeaderboardEntry[] {
+    return this.analyticsService.generateLeaderboard();
+  }
 }

src/analytics/analytics.service.ts

@@ -11,6 +11,12 @@ export interface ImpermanentLossData {
   impermanentLossPercentage: number;
 }
 
+export interface LeaderboardEntry {
+  walletAddress: string;
+  volumeUSD: number;
+  rank: number;
+}
+
 @Injectable()
 export class AnalyticsService {
   generateMockVolumeData(): VolumeData[] {
@@ -56,4 +62,31 @@ export class AnalyticsService {
       impermanentLossPercentage,
     };
   }
+
+  generateLeaderboard(): LeaderboardEntry[] {
+    // Generate dummy wallet addresses (truncated for privacy)
+    const dummyWallets = [
+      '0x742d...8b4c',
+      '0x8f3a...2d1e',
+      '0x1a9c...5f7b',
+      '0x6e2d...9a3c',
+      '0x4b8f...1e2d',
+      '0x9c3a...7f5b',
+      '0x2d8f...4c1e',
+      '0x5a7b...9d2f',
+      '0x8e1c...3a6b',
+      '0x3f9d...2e8c'
+    ];
+
+    // Generate realistic trading volumes (sorted in descending order)
+    const baseVolumes = [850000, 720000, 650000, 580000, 490000, 420000, 380000, 310000, 270000, 220000];
+    
+    const leaderboard: LeaderboardEntry[] = dummyWallets.map((wallet, index) => ({
+      walletAddress,
+      volumeUSD: baseVolumes[index] + Math.round(Math.random() * 50000 - 25000),
+      rank: index + 1
+    }));
+
+    return leaderboard;
+  }
 }

src/jobs/indexer.ts

@@ -0,0 +1,27 @@
+import * as cron from 'node-cron';
+
+export class IndexerJob {
+  constructor() {
+    this.initializeJobs();
+  }
+
+  private initializeJobs() {
+    // Schedule a job to run every 5 minutes
+    cron.schedule('*/5 * * * *', () => {
+      console.log('Syncing Blockchain Data...');
+      this.syncBlockchainData();
+    });
+
+    console.log('Background indexer jobs initialized');
+  }
+
+  private syncBlockchainData() {
+    // Simulate blockchain data syncing
+    console.log(`[${new Date().toISOString()}] Starting blockchain data sync...`);
+    
+    // Simulate some work
+    setTimeout(() => {
+      console.log(`[${new Date().toISOString()}] Blockchain data sync completed`);
+    }, 2000);
+  }
+}

src/main.ts

@@ -76,6 +76,9 @@ async function bootstrap() {
 
   await app.listen(3000);
   console.log('Application is running on: http://localhost:3000');
+  
+  // Initialize background jobs
+  new IndexerJob();
 }
 
 bootstrap();

src/network/network.controller.ts

@@ -0,0 +1,49 @@
+import { Controller, Get, Res, HttpStatus } from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { Response } from 'express';
+
+@ApiTags('Network')
+@Controller('api/v1/network')
+export class NetworkController {
+  @Get('fees')
+  @ApiOperation({ summary: 'Get estimated network gas fees', description: 'Get current Stellar network fee estimates in stroops' })
+  @ApiResponse({
+    status: 200,
+    description: 'Successfully retrieved network fee estimates',
+    schema: {
+      type: 'object',
+      properties: {
+        success: { type: 'boolean', example: true },
+        data: {
+          type: 'object',
+          properties: {
+            baseFee: { type: 'number', example: 100 },
+            priorityFee: { type: 'number', example: 500 },
+            estimatedTotal: { type: 'number', example: 600 }
+          }
+        },
+        timestamp: { type: 'string', example: '2024-01-15T10:30:00.000Z' }
+      }
+    }
+  })
+  getNetworkFees(@Res() res: Response) {
+    // Generate realistic mock Stellar network fees
+    const fees = {
+      baseFee: 100, // Base fee in stroops (0.00001 XLM)
+      priorityFee: Math.floor(Math.random() * 1000) + 200, // Priority fee between 200-1200 stroops
+      estimatedTotal: 0 // Will be calculated
+    };
+    
+    fees.estimatedTotal = fees.baseFee + fees.priorityFee;
+
+    const response = {
+      success: true,
+      data: fees,
+      timestamp: new Date().toISOString()
+    };
+
+    // Set cache header for 30 seconds
+    res.set('Cache-Control', 'public, max-age=30');
+    res.status(HttpStatus.OK).json(response);
+  }
+}

src/network/network.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { NetworkController } from './network.controller';
+
+@Module({
+  controllers: [NetworkController],
+})
+export class NetworkModule {}

src/tokens/tokens.controller.ts

@@ -3,12 +3,20 @@ import { ApiTags, ApiOperation, ApiResponse, ApiQuery } from '@nestjs/swagger';
 import { Response } from 'express';
 
 @ApiTags('Tokens')
-@Controller('tokens')
+@Controller('api/v1/tokens')
 export class TokensController {
   private cachedTokens: string[] | null = null;
   private cacheTimestamp: number = 0;
   private readonly CACHE_DURATION_MS = 5 * 60 * 1000; // 5 minutes
 
+  // Hardcoded verified Stellar contract addresses
+  private readonly verifiedAddresses = [
+    'GBBDN5LQJ3FOJJNGZAKDRJMBJN5P6LIXZ6NFUGZU6J3E3MNJNGHG35TV',
+    'GDTNJZK5MHCJKGV6O7G7LXKXVYJU2R2H5N5JQ6LQ5J3E3MNJNGHG35TV',
+    'GD5DJQD6K3XV5FJ2RQ7J7LXKXVYJU2R2H5N5JQ6LQ5J3E3MNJNGHG35TV',
+    'GA6HCMBLTZS5VYYBCATRBRZB5J2J2F2ZQ5JQ6LQ5J3E3MNJNGHG35TV'
+  ];
+  
   @Get()
   @ApiOperation({ summary: 'Search for tokens by symbol', description: 'Search for tokens using a symbol query parameter' })
   @ApiQuery({ name: 'search', required: false, description: 'Token symbol to search for' })
@@ -80,4 +88,27 @@ export class TokensController {
       timestamp: new Date().toISOString()
     };
   }
+
+  @Get('verify/:address')
+  @ApiOperation({ summary: 'Verify if a token contract address is whitelisted', description: 'Check if a Stellar contract address is officially verified and safe to trade' })
+  @ApiResponse({ 
+    status: 200, 
+    description: 'Token verification result',
+    schema: {
+      type: 'object',
+      properties: {
+        isVerified: { type: 'boolean', example: true },
+        riskLevel: { type: 'string', example: 'LOW' }
+      }
+    }
+  })
+  verifyToken(@Param('address') address: string) {
+    const isVerified = this.verifiedAddresses.includes(address);
+    const riskLevel = isVerified ? 'LOW' : 'HIGH';
+    
+    return {
+      isVerified,
+      riskLevel
+    };
+  }
 }