Skip to content

PR_TEMPLATE.md

Latest commit

 

History

History
63 lines (44 loc) · 2.3 KB

PR_TEMPLATE.md

File metadata and controls

63 lines (44 loc) · 2.3 KB

Pull Request: Vesting Cliffs on Top-Ups - Issue #19

🎯 Summary

Implements vesting "cliffs" on top-ups functionality, allowing new cliff periods to be defined specifically for tokens added to existing vaults.

📋 Changes Made

Database Models

  • ✅ Vault Model (backend/src/models/vault.js) - Main vault storage
  • ✅ SubSchedule Model (backend/src/models/subSchedule.js) - Multiple vesting schedules per vault
  • ✅ Migration (backend/migrations/001_create_vaults_and_sub_schedules.sql) - Complete schema

Services

  • ✅ VestingService (backend/src/services/vestingService.js) - Core business logic
  • ✅ AdminService Updates - Integration with new vesting functionality
  • ✅ IndexingService Updates - Blockchain event processing

API Endpoints

  • ✅ POST /api/vault/top-up - Top-up with cliff configuration
  • ✅ GET /api/vault/:vaultAddress/details - Vault details with sub-schedules
  • ✅ GET /api/vault/:vaultAddress/releasable - Calculate releasable amounts
  • ✅ POST /api/vault/release - Release tokens respecting cliffs
  • ✅ POST /api/indexing/top-up - Process blockchain top-up events
  • ✅ POST /api/indexing/release - Process blockchain release events

Testing

  • ✅ Comprehensive Test Suite (backend/test/vesting-topup.test.js) - Full coverage

🔧 Key Features

  1. Independent Cliffs: Each top-up can have its own cliff period
  2. Multiple Sub-Schedules: Support for unlimited vesting schedules per vault
  3. Pro-rata Releases: Tokens distributed proportionally across sub-schedules
  4. Audit Trail: Complete logging for compliance
  5. Blockchain Integration: Full event processing support

📊 Acceptance Criteria

  • ✅ SubSchedule List: Implemented within Vault system
  • ✅ Complex Logic: Successfully handles multiple vesting schedules with independent cliffs
  • ✅ Stretch Goal: Delivered as robust, production-ready feature

🧪 Testing

# Run the test suite
npm test backend/test/vesting-topup.test.js

# Start the application
npm start

📚 Documentation

See VESTING_CLIFFS_IMPLEMENTATION.md for detailed documentation and usage examples.

🔗 Related Issue

Closes #19: [Feature] Vesting "Cliffs" on Top-Ups

Ready for Review 🚀