Merge pull request #105 from bandanadivya/feature/portfolio-export

Feature/portfolio export

Author: ritik4ever

backend/package-lock.json

@@ -0,0 +1,53 @@
+{
+  "name": "stellar-portfolio-backend",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "tsx watch src/index.ts",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "db:migrate": "tsx src/db/migrate.ts",
+    "db:migrate:dry-run": "tsx src/db/migrate.ts -- --dry-run",
+    "db:migrate:rollback": "tsx src/db/migrate.ts -- --rollback",
+    "db:migrate:status": "tsx src/db/migrate.ts -- --status",
+    "db:setup": "tsx src/db/migrate.ts",
+    "db:seed:e2e": "tsx src/db/seed.e2e.ts",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@stellar/stellar-sdk": "^12.0.1",
+    "better-sqlite3": "^12.6.2",
+    "bullmq": "^5.69.3",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "express-rate-limit": "^7.4.1",
+    "ioredis": "^5.9.3",
+    "jsonwebtoken": "^9.0.3",
+    "node-cron": "^3.0.3",
+    "nodemailer": "^8.0.1",
+    "pdfkit": "^0.17.2",
+    "pg": "^8.11.3",
+    "pino": "^9.6.0",
+    "ws": "^8.14.2",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^4.17.23",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^20.19.13",
+    "@types/node-cron": "^3.0.11",
+    "@types/nodemailer": "^7.0.10",
+    "@types/pdfkit": "^0.17.5",
+    "@types/pg": "^8.10.9",
+    "@types/supertest": "^2.0.12",
+    "@types/ws": "^8.18.1",
+    "supertest": "^6.3.3",
+    "tsx": "^4.1.4",
+    "typescript": "^5.2.2",
+    "vitest": "^4.0.18"
+  }
+}

backend/package.json

@@ -19,8 +19,10 @@ import { getQueueMetrics } from '../queue/queueMetrics.js'
 import { getErrorMessage, getErrorObject, parseOptionalBoolean } from '../utils/helpers.js'
 import { createPortfolioSchema } from './validation.js'
 import { rebalanceLockService } from '../services/rebalanceLock.js'
+import { REBALANCE_STRATEGIES } from '../services/rebalancingStrategyService.js'
 import type { Portfolio } from '../types/index.js'
 import { ok, fail } from '../utils/apiResponse.js'
+import { getPortfolioExport } from '../services/portfolioExportService.js'
 
 const router = Router()
 const stellarService = new StellarService()
@@ -47,6 +49,10 @@ const parseHistorySource = (value: unknown): 'offchain' | 'simulated' | 'onchain
 }
 
 
+router.get('/strategies', (_req: Request, res: Response) => {
+    return ok(res, { strategies: REBALANCE_STRATEGIES })
+})
+
 router.get('/rebalance/history', async (req: Request, res: Response) => {
     try {
         const portfolioId = req.query.portfolioId as string
@@ -122,6 +128,7 @@ router.post('/rebalance/history/sync-onchain', requireAdmin, async (req: Request
     }
 })
 
+router.post('/portfolio', writeRateLimiter, idempotencyMiddleware, async (req: Request, res: Response) => {
 
     try {
         const parsed = createPortfolioSchema.safeParse(req.body)
@@ -139,9 +146,17 @@ router.post('/rebalance/history/sync-onchain', requireAdmin, async (req: Request
                             : message
             return fail(res, 400, 'VALIDATION_ERROR', fullMessage)
         }
+        const { userAddress, allocations, threshold, slippageTolerance, strategy, strategyConfig } = parsed.data
 
         const slippageTolerancePercent = slippageTolerance ?? 1
-        const portfolioId = await stellarService.createPortfolio(userAddress, allocations, threshold, slippageTolerancePercent)
+        const portfolioId = await stellarService.createPortfolio(
+            userAddress,
+            allocations,
+            threshold,
+            slippageTolerancePercent,
+            strategy ?? 'threshold',
+            strategyConfig ?? {}
+        )
         const mode = featureFlags.demoMode ? 'demo' : 'onchain'
         return ok(res, {
             portfolioId,
@@ -154,21 +169,50 @@ router.post('/rebalance/history/sync-onchain', requireAdmin, async (req: Request
     }
 })
 
+router.get('/portfolio/:id', async (req: Request, res: Response) => {
 
     try {
         const portfolioId = req.params.id
         if (!portfolioId) return fail(res, 400, 'VALIDATION_ERROR', 'Portfolio ID required')
         const portfolio = await stellarService.getPortfolio(portfolioId)
         if (!portfolio) return fail(res, 404, 'NOT_FOUND', 'Portfolio not found')
- main
+
         return ok(res, { portfolio })
     } catch (error) {
         logger.error('[ERROR] Get portfolio failed', { error: getErrorObject(error) })
         return fail(res, 500, 'INTERNAL_ERROR', getErrorMessage(error))
     }
 })
 
- main
+// Portfolio export (JSON, CSV, PDF) — GDPR data portability
+router.get('/portfolio/:id/export', requireJwtWhenEnabled, async (req: Request, res: Response) => {
+    try {
+        const portfolioId = req.params.id
+        const format = (req.query.format as string)?.toLowerCase()
+        if (!portfolioId) return fail(res, 400, 'VALIDATION_ERROR', 'Portfolio ID required')
+        if (!['json', 'csv', 'pdf'].includes(format)) {
+            return fail(res, 400, 'VALIDATION_ERROR', 'Query parameter format must be one of: json, csv, pdf')
+        }
+        const result = await getPortfolioExport(portfolioId, format as 'json' | 'csv' | 'pdf')
+        if (!result) return fail(res, 404, 'NOT_FOUND', 'Portfolio not found')
+        res.setHeader('Content-Type', result.contentType)
+        res.setHeader('Content-Disposition', `attachment; filename="${result.filename}"`)
+        if (Buffer.isBuffer(result.body)) {
+            return res.send(result.body)
+        }
+        return res.send(result.body)
+    } catch (error) {
+        logger.error('[ERROR] Portfolio export failed', { error: getErrorObject(error) })
+        return fail(res, 500, 'INTERNAL_ERROR', getErrorMessage(error))
+    }
+})
+
+router.get('/user/:address/portfolios', async (req: Request, res: Response) => {
+    try {
+        const address = req.params.address
+        if (!address) return fail(res, 400, 'VALIDATION_ERROR', 'User address required')
+        const list = portfolioStorage.getUserPortfolios(address)
+
         return ok(res, { portfolios: list })
     } catch (error) {
         logger.error('[ERROR] Get user portfolios failed', { error: getErrorObject(error) })
@@ -200,6 +244,7 @@ router.get('/portfolio/:id/rebalance-plan', async (req: Request, res: Response)
 })
 
 // Manual portfolio rebalance
+router.post('/portfolio/:id/rebalance', writeRateLimiter, idempotencyMiddleware, async (req: Request, res: Response) => {
 
     try {
         const portfolioId = req.params.id;
@@ -692,6 +737,7 @@ router.get('/portfolio/:id/performance-summary', async (req: Request, res: Respo
 router.post('/notifications/subscribe', requireJwtWhenEnabled, writeRateLimiter, idempotencyMiddleware, async (req: Request, res: Response) => {
     try {
         const userId = req.user?.address ?? req.body?.userId
+        const { emailEnabled, webhookEnabled, webhookUrl, events, emailAddress } = req.body ?? {}
 
         // Validation
         if (!userId) {

backend/src/api/routes.ts

@@ -23,6 +23,12 @@ export const createPortfolioSchema = z.object({
     ),
     threshold: z.number().min(1, "Threshold must be between 1% and 50%").max(50, "Threshold must be between 1% and 50%"),
     slippageTolerance: z.number().min(0.1, "Slippage tolerance must be between 0.1% and 5%").max(5, "Slippage tolerance must be between 0.1% and 5%").optional(),
+    strategy: z.enum(['threshold', 'periodic', 'volatility', 'custom']).optional(),
+    strategyConfig: z.object({
+        intervalDays: z.number().min(1).max(365).optional(),
+        volatilityThresholdPct: z.number().min(1).max(100).optional(),
+        minDaysBetweenRebalance: z.number().min(0).max(365).optional(),
+    }).optional(),
 }).strict();
 
 // Schema for POST /portfolio/:id/rebalance

backend/src/api/validation.ts

@@ -0,0 +1,3 @@
+ALTER TABLE portfolios
+DROP COLUMN IF EXISTS strategy_config,
+DROP COLUMN IF EXISTS strategy;

backend/src/db/migrations/006_rebalancing_strategy.down.sql

@@ -0,0 +1,6 @@
+ALTER TABLE portfolios
+ADD COLUMN IF NOT EXISTS strategy VARCHAR(32) NOT NULL DEFAULT 'threshold',
+ADD COLUMN IF NOT EXISTS strategy_config JSONB DEFAULT '{}';
+
+COMMENT ON COLUMN portfolios.strategy IS 'Rebalancing strategy: threshold, periodic, volatility, custom';
+COMMENT ON COLUMN portfolios.strategy_config IS 'Strategy-specific options (intervalDays, volatilityThresholdPct, etc.)';

backend/src/db/migrations/006_rebalancing_strategy.up.sql

@@ -12,6 +12,8 @@ export interface PortfolioRow {
     created_at: Date
     last_rebalance: Date
     version: number
+    strategy?: string
+    strategy_config?: Record<string, unknown>
 }
 
 function rowToPortfolio(r: PortfolioRow) {
@@ -25,7 +27,9 @@ function rowToPortfolio(r: PortfolioRow) {
         totalValue: Number(r.total_value),
         createdAt: r.created_at.toISOString(),
         lastRebalance: r.last_rebalance.toISOString(),
-        version: r.version ?? 1
+        version: r.version ?? 1,
+        strategy: (r.strategy as import('../types/index.js').RebalanceStrategyType) || 'threshold',
+        strategyConfig: r.strategy_config || undefined
     }
 }
 
@@ -36,12 +40,14 @@ export async function dbCreatePortfolio(
     threshold: number,
     balances: Record<string, number>,
     totalValue: number,
-    slippageTolerance: number = 1
+    slippageTolerance: number = 1,
+    strategy: string = 'threshold',
+    strategyConfig: Record<string, unknown> = {}
 ) {
     await query(
-        `INSERT INTO portfolios (id, user_address, allocations, threshold, slippage_tolerance, balances, total_value, created_at, last_rebalance, version)
-         VALUES ($1, $2, $3, $4, $5, $6, $7, NOW(), NOW(), 1)`,
-        [id, userAddress, JSON.stringify(allocations), threshold, slippageTolerance, JSON.stringify(balances), totalValue]
+        `INSERT INTO portfolios (id, user_address, allocations, threshold, slippage_tolerance, balances, total_value, created_at, last_rebalance, version, strategy, strategy_config)
+         VALUES ($1, $2, $3, $4, $5, $6, $7, NOW(), NOW(), 1, $8, $9)`,
+        [id, userAddress, JSON.stringify(allocations), threshold, slippageTolerance, JSON.stringify(balances), totalValue, strategy, JSON.stringify(strategyConfig)]
     )
 }
 

backend/src/db/portfolioDb.ts

@@ -1,11 +1,10 @@
 import 'dotenv/config'
 import express from 'express'
 import cors from 'cors'
-import swaggerUi from 'swagger-ui-express'
 import { createServer } from 'node:http'
 import { WebSocketServer } from 'ws'
 import { portfolioRouter } from './api/routes.js'
-n
+import { authRouter } from './api/authRoutes.js'
 import { errorHandler, notFound } from './middleware/errorHandler.js'
 import { globalRateLimiter } from './middleware/rateLimit.js'
 import { RebalancingService } from './monitoring/rebalancer.js'
@@ -150,18 +149,6 @@ app.get('/test/coingecko', async (req, res) => {
         })
     }
 })
-// OpenAPI spec as JSON (for Postman: Import → Link → http://localhost:3000/api-docs/openapi.json)
-app.get('/api-docs/openapi.json', (req, res) => {
-    res.setHeader('Content-Type', 'application/json')
-    res.json(openApiSpec)
-})
-
-// Swagger UI
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(openApiSpec, {
-    customCss: '.swagger-ui .topbar { display: none }',
-    customSiteTitle: 'Stellar Portfolio Rebalancer API',
-}))
-
 // Root route
 app.get('/', (req, res) => {
     res.json({
@@ -190,6 +177,7 @@ app.get('/', (req, res) => {
 // Mount API routes
 app.use('/api/auth', authRouter)
 app.use('/api', portfolioRouter)
+app.use('/api/v1', portfolioRouter)
 app.use('/api', apiErrorHandler)
 
 // Legacy non-/api compatibility (redirect only)

backend/src/index.ts

@@ -30,6 +30,7 @@
     "/api/rebalance/history/sync-onchain": { "post": { "tags": ["Rebalance history"], "summary": "Sync on-chain history (admin)", "responses": { "200": { "description": "OK" } } } },
     "/api/portfolio": { "post": { "tags": ["Portfolio"], "summary": "Create portfolio", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userAddress": { "type": "string" }, "allocations": { "type": "object" }, "threshold": { "type": "number" }, "slippageTolerance": { "type": "number" } } } } }, "responses": { "201": { "description": "Created" } } } },
     "/api/portfolio/{id}": { "get": { "tags": ["Portfolio"], "summary": "Get portfolio", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "OK" }, "404": { "description": "Not found" } } } },
+    "/api/portfolio/{id}/export": { "get": { "tags": ["Portfolio"], "summary": "Export portfolio data (GDPR)", "description": "Download portfolio and rebalance history as JSON, CSV, or PDF. Includes timestamp and portfolio ID.", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string", "enum": ["json", "csv", "pdf"] } }], "responses": { "200": { "description": "File attachment (application/json, text/csv, or application/pdf)" }, "400": { "description": "Invalid format" }, "404": { "description": "Portfolio not found" } } } },
     "/api/user/{address}/portfolios": { "get": { "tags": ["Portfolio"], "summary": "List user portfolios", "parameters": [{ "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "OK" } } } },
     "/api/portfolio/{id}/rebalance-plan": { "get": { "tags": ["Portfolio"], "summary": "Get rebalance plan", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "OK" } } } },
     "/api/portfolio/{id}/rebalance": { "post": { "tags": ["Portfolio"], "summary": "Execute rebalance", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "409": { "description": "Conflict" } } } },