Skip to main content

Early Withdrawal Test Suite

Overview​

The early withdrawal test suite (early-withdrawal.spec.ts) validates the KagePool system's early withdrawal functionality, ensuring proper handling of premature stake withdrawals, penalty calculations, and fund distribution.

Withdrawal Flow​

Test Categories​

Withdrawal Mechanisms​

Withdrawal Test Cases

Basic Withdrawal​

  • Description: Tests standard early withdrawal process
  • Key Assertions:
    • Request validation
    • Penalty calculation
    • Fund transfer
    • State updates

Emergency Withdrawal​

  • Description: Tests emergency early withdrawal scenarios
  • Key Assertions:
    • Emergency triggers
    • Penalty adjustments
    • Fund protection
    • State preservation

Penalty Calculations​

Penalty Test Cases

Fee Structure​

  • Description: Tests penalty fee calculations
  • Key Assertions:
    • Time-based scaling
    • Amount validation
    • Fee distribution
    • Rounding handling

Edge Cases​

  • Description: Tests boundary conditions
  • Key Assertions:
    • Minimum penalties
    • Maximum penalties
    • Zero amounts
    • Overflow protection

Implementation Details​

Test Configuration​

interface WithdrawalConfig {
  minLockTime: number;
  maxPenalty: number;
  penaltyScaling: number;
  emergencyRate: number;
}

const WITHDRAWAL_CONFIG: WithdrawalConfig = {
  minLockTime: 604800, // 1 week
  maxPenalty: 50, // 50%
  penaltyScaling: 5, // 5% per week
  emergencyRate: 25, // 25% flat rate
};

Test Scenarios​

Withdrawal Operations​

Operation Test Cases

Standard Withdrawal​

describe("Standard Withdrawal", () => {
  it("should process early withdrawals with penalties", async () => {
    // Test implementation
  });

  it("should enforce minimum lock time", async () => {
    // Test implementation
  });
});

Emergency Withdrawal​

describe("Emergency Withdrawal", () => {
  it("should handle emergency withdrawals", async () => {
    // Test implementation
  });

  it("should apply emergency rates", async () => {
    // Test implementation
  });
});

Security Considerations​

Critical Checks​

  • Time validation
  • Amount verification
  • Penalty accuracy
  • State consistency

Safety Measures​

  • Rate limits
  • Amount caps
  • Time locks
  • State validation

Test Coverage​

  • ✅ Request Processing
  • ✅ Penalty Calculation
  • ✅ Fund Transfer
  • ✅ State Updates
  • ✅ Event Emission

Performance Analysis​

Withdrawal Metrics​

  • Request processing time
  • Penalty calculation
  • Transfer execution
  • State updates

System Impact​

  • Gas costs
  • Memory usage
  • Storage updates
  • Network load

Implementation Notes​

Key Functions​

// Withdrawal requests
function requestEarlyWithdrawal(uint256 poolId, uint256 amount) external;

// Penalty calculations
function calculatePenalty(uint256 amount, uint256 timeRemaining)
  internal
  pure
  returns (uint256);

// Safety checks
function validateWithdrawal(uint256 poolId, uint256 amount)
  internal
  view
  returns (bool);

Test Utilities​

  • Time manipulation
  • Amount calculation
  • State verification
  • Event validation

Monitoring and Verification​

Withdrawal Events​

event EarlyWithdrawalRequested(
    uint256 indexed poolId,
    address indexed user,
    uint256 amount,
    uint256 penalty
);

event PenaltyCollected(
    uint256 indexed poolId,
    uint256 amount,
    uint256 timestamp
);

event WithdrawalProcessed(
    uint256 indexed poolId,
    address indexed user,
    uint256 amount,
    uint256 received
);

State Verification​

  • Pool balances
  • User positions
  • Penalty accumulation
  • Time tracking

Error Handling​

Withdrawal Errors​

error InsufficientLockTime(uint256 current, uint256 required);
error ExcessiveWithdrawalAmount(uint256 requested, uint256 available);
error InvalidPenaltyCalculation(uint256 amount, uint256 penalty);
error WithdrawalNotAllowed(string reason);

Recovery Procedures​

  • Request validation
  • Amount verification
  • Penalty adjustment
  • State recovery

Withdrawal Patterns​

Request Flow​

Penalty Flow​

  1. Time verification
  2. Amount validation
  3. Penalty calculation
  4. Fee collection
  5. Fund transfer
  6. State update