Error Handling Guide - ZKScore Documentation

Overview

Proper error handling is critical for building robust applications with ZKScore. This guide covers common errors, handling strategies, and recovery patterns.

Common Errors

API Errors

try {
  const score = await zkScore.getScore(identity);
} catch (error) {
  if (error.code === 'IDENTITY_NOT_FOUND') {
    console.error('Identity does not exist');
  } else if (error.code === 'RATE_LIMIT_EXCEEDED') {
    console.error('Rate limit exceeded, please retry later');
  } else if (error.code === 'INVALID_API_KEY') {
    console.error('Invalid API key');
  } else {
    console.error('Unexpected error:', error.message);
  }
}

Error Types

Code	Description	Action
`IDENTITY_NOT_FOUND`	Identity doesn’t exist	Check ZKS ID
`RATE_LIMIT_EXCEEDED`	Too many requests	Implement backoff
`INVALID_API_KEY`	API key invalid	Check credentials
`NETWORK_ERROR`	Network failure	Retry request

Best Practices

Specific Handling: Handle each error type specifically
User Feedback: Provide clear error messages
Retry Logic: Implement exponential backoff
Logging: Log errors for monitoring
Graceful Degradation: Continue with limited functionality