Implementation Proposal for Issues #316, #317, #318, #319

[CillaSam]

Overview

This PR presents a detailed implementation proposal for four new features before actual implementation begins.

Issues Addressed

• Closes . Add POST /api/v1/quizzes/generate-batch endpoint #316: Add batch quiz generation endpoint
• Closes . Add course progress sync with on-chain state #317: Add course progress sync with on-chain state
• Closes . Add GET /api/v1/users/:id/public-profile endpoint #318: Add public user profile endpoint
• Closes . Add course completion certificate generation #319: Add course completion certificate generation

What's in this PR

�� Implementation Proposal Document that outlines:

• Detailed implementation plan for each feature
• Technical architecture and design decisions
• API specifications and data structures
• Security considerations
• Performance optimization strategies
• Testing approach
• Rollout plan and timeline estimates

Purpose

This proposal PR allows for:

1. Review and feedback on the implementation approach before writing code
2. Validation of technical decisions and architecture
3. Discussion of open questions and edge cases
4. Alignment on scope and acceptance criteria

Next Steps

Once this proposal is reviewed and approved, I will:

1. Create a new branch for implementation
2. Implement all four features following the approved plan
3. Submit a final PR with complete implementation, tests, and documentation

Key Highlights

#316: Batch Quiz Generation

• Sequential processing to prevent AI overload
• Graceful handling of partial failures
• Strict rate limiting for abuse prevention

#317: Progress Sync Job

• 15-minute sync interval with on-chain state
• Prometheus metrics for monitoring
• Graceful error handling

#318: Public Profile Endpoint

• Privacy-first (opt-in via displayName)
• 5-minute Redis caching
• Excludes all sensitive fields

#319: PDF Certificate

• On-demand generation with caching
• QR code for verification
• Uses pdfkit library

Open Questions for Review

1. Should batch quiz generation have a maximum module limit (e.g., 10)?
2. Should progress sync favor on-chain or local state when conflicts occur?
3. Should public profile include course names or just IDs?
4. Should certificates use a single template or be customizable per course?

Looking forward to your feedback!