Skip to content

Latest commit

 

History

History
 
 

README.md

📚 API Documentation

Complete API reference for jobjab-fhevm-sdk.

FHEVM Version: v0.9 compatible
SDK Version: jobjab-fhevm-sdk@0.1.2+


⚠️ V0.9 Important Notes

This SDK is designed for FHEVM v0.9 specification:

  • Decryption: Uses relayer/gateway flow (no FHE.requestDecryption)
  • EIP-712: Simplified structure (no contractsChainId)
  • Types: Focus on ebool, euint*, eaddress (v0.9 spec)
  • ⚠️ Legacy: ebytes* types deprecated in v0.7+

🎯 Core API

Client

Types

Functions

⚛️ React API

Hooks

Components

🔧 Utilities

Contract Helpers

  • isCiphertextHandle() - Validate handle
  • isValidContractAddress() - Validate address
  • findEncryptedInputs() - Parse ABI
  • buildContractParams() - Build params

Performance

  • MemoryCache - Caching with TTL
  • cached() - Function memoization
  • BatchQueue - Auto-batching

Errors

  • isFhevmError() - Type guard
  • formatErrorMessage() - Format error
  • Error Codes - All codes

📖 See Also