API Reference

import {
  serializeMessage,       // DeroAuthMessage → human-readable string
  parseMessage,           // String → DeroAuthMessage
  validateMessage,        // Check domain, nonce, expiry
  generateNonce,          // Crypto-random nonce string
 
  // Constants
  PROTOCOL_VERSION,       // "1"
 
  // Types
  type DeroAuthMessage,
  type DeroAuthConfig,
  type DeroAuthSession,
  type DeroAuthError,
  type DeroChainId,       // "dero-mainnet" | "dero-testnet"
  type AuthStatus,        // "idle" | "connecting" | "awaiting-signature" | "verifying" | "authenticated" | "error"
  type WalletStatus,      // "disconnected" | "connecting" | "connected" | "error"
} from "dero-auth";

import {
  // Signature verification
  verifySignature,        // Verify PEM signature → { address, message }
  verifyParsedSignature,  // Verify already-parsed signature
 
  // PEM format
  parsePEM,               // Parse DERO PEM format → DeroSignature
  encodePEM,              // DeroSignature → PEM string
 
  // Address encoding
  decodeAddress,          // DERO Bech32 address → DeroAddress
  encodeAddress,          // G1 public key → DERO address string
  isValidAddress,         // Validate DERO address format
 
  // Hashing
  reducedHash,            // Keccak-256 reduced mod curve order
 
  // BN256 curve operations
  decompressG1,           // 33 bytes → G1 curve point
  compressG1,             // G1 curve point → 33 bytes
  g1FromAffine,           // (x, y) → G1 point
  g1Multiply,             // Scalar multiplication
  g1Add,                  // Point addition
  g1Negate,               // Point negation
 
  // Bech32
  bech32Decode,           // Bech32 string → { hrp, data }
  bech32Encode,           // (hrp, data) → Bech32 string
  convertBits,            // Bit-width conversion for Bech32
 
  // Constants
  G1_BASE,                // Standard BN256 generator
  DERO_G,                 // DERO's custom generator point
  G1_ZERO,                // Identity point
  FIELD_MODULUS,
  GROUP_ORDER,
 
  // Types
  type G1Point,
  type DeroSignature,
  type DeroAddress,
} from "dero-auth/crypto";

import {
  // Challenge server
  createChallengeServer,  // Create challenge server with nonce management
 
  // Verification
  verifyAuth,             // Full verification pipeline
 
  // Sessions
  createSessionManager,   // JWT session manager (create + verify)
 
  // Nonce stores
  createInMemoryNonceStore,             // In-memory store (dev)
  createRedisNonceStore,                // Redis store (custom executor)
  createRedisNonceStoreFromNodeRedis,   // Redis store (node-redis client)
  createRedisNonceStoreFromIORedis,     // Redis store (ioredis client)
 
  // Types
  type NonceStore,
  type NonceRecord,
  type ChallengeServerConfig,
  type CreateChallengeOptions,
  type ChallengeResult,
  type VerifyOptions,
  type VerifyResult,
  type SessionConfig,
  type DeroJWTPayload,
  type InMemoryNonceStoreOptions,
  type RedisNonceStoreOptions,
  type RedisCommandExecutor,
  type NodeRedisLike,
  type IORedisLike,
} from "dero-auth/server";

import {
  XSWDClient,           // Low-level XSWD WebSocket client (class)
  createAuthClient,     // High-level auth flow client
  generateAppId,        // Generate unique app identifier
 
  type XSWDAppData,
  type XSWDEvents,
  type SignInOptions,
} from "dero-auth/client";

import {
  DeroAuthProvider,        // Context provider
  SignInWithDero,          // Drop-in sign-in button
  useDeroAuth,            // Standalone auth hook (no provider needed)
  useDeroAuthContext,     // Context-dependent auth hook
 
  type DeroAuthProviderProps,
  type DeroAuthContextValue,
  type SignInWithDeroProps,
  type UseDeroAuthOptions,
  type UseDeroAuthReturn,
} from "dero-auth/react";

import {
  createAuthHandlers,          // API route handlers factory
  createDeroAuthMiddleware,    // Auth middleware for route protection
  getAuthAddress,              // Extract DERO address from request headers
 
  type AuthHandlersConfig,
  type DeroMiddlewareConfig,
} from "dero-auth/next";

const {
  challengeHandler,   // POST handler for /auth/challenge
  verifyHandler,      // POST handler for /auth/verify
  challengeServer,    // The underlying challenge server instance
  sessionManager,     // The underlying session manager instance
} = createAuthHandlers(config);

type AuthHandlersConfig = {
  domain: string;              // Your domain (e.g., "myapp.com")
  uri: string;                 // Your full URI (e.g., "https://myapp.com")
  jwtSecret: string;           // Secret for JWT signing (min 32 bytes)
  statement?: string;          // Optional message shown to user
  expirationTime?: number;     // Challenge expiry in seconds (default: 300)
  nonceStore?: NonceStore;     // Custom nonce store (default: in-memory)
};

type DeroMiddlewareConfig = {
  jwtSecret: string;           // Must match the handlers secret
  protectedPaths: string[];    // Paths to protect
  loginPath: string;           // Where to redirect unauthenticated users
};