Configuration Reference

Configuration objects for the HyperAuth SDK client and Vault worker.

ClientConfig

Passed to createClient(config) or HyperAuthClient.create(plugin, config). All fields are optional.

interface ClientConfig {
  wasmUrl?: string;
  wasmBytes?: Uint8Array;
  logger?: Pick<Console, 'log' | 'error' | 'warn' | 'info' | 'debug'>;
  debug?: boolean;
  autoLockTimeout?: number;
  contracts?: ContractsConfig;
}

Fields

Notes

• wasmUrl and wasmBytes are mutually exclusive. wasmBytes takes precedence in the bridge implementation if both are supplied.
• autoLockTimeout triggers HyperAuthClient.lock() after the inactivity period. If an onAutoLock callback has been registered via setAutoLockCallback(), it receives the encrypted database bytes from the lock result.
• createClient() uses wasmUrl and contracts to initialize the core worker bridge. HyperAuthClient.create() with a pre-constructed WasmPlugin does not use these fields.

ContractsConfig

Smart contract addresses for a specific EVM chain. Used by the enclave to construct and verify on-chain operations.

interface ContractsConfig {
  chainId: number;
  entryPoint: string;
  didRegistry: string;
  accountHelper: string;
  sessionSBT: string;
  hyperAuthFactory: string;
}

Fields

Default values (defaultContracts)

Exported as defaultContracts from @hyperauth/sdk. Matches the DEFAULT_CONTRACTS constant in the Vault worker.

WorkerConfig

Configuration passed to createCoreBridge(). Used internally by createClient().

interface WorkerConfig {
  wasmUrl: string;
  debug?: boolean;
  contracts?: ContractsConfig;
}

Fields

VaultStoreConfig

Configuration for VaultStore initialization. VaultStore manages the wa-sqlite persistence layer for fast page-reload restore.

interface VaultStoreConfig {
  dbName?: string;
}

Fields

VaultSnapshotConfig

Configuration for VaultSnapshot, which wraps vault bytes in DAG-CBOR and stores them in a Helia blockstore.

interface VaultSnapshotConfig {
  gatewayUrl?: string;
}

Fields

Vault Worker Environment (Env)

The Cloudflare Worker Env interface declares all bindings and secrets required by the Vault worker. These are not SDK configuration — they are Cloudflare Worker environment bindings configured in wrangler.toml and the Cloudflare dashboard.

Bindings

Environment Variables

Secrets

Vault Worker Constants

Constants defined in apps/vault/src/lib/types.ts. These values are fixed at deploy time and are not overridable via environment variables.

WebAuthn Defaults

Constants defined in sdk/client/src/constants.ts.