Skip to main content

API overview

Human-oriented map of the public surface. Types ship in dist/index.d.ts.

KEM

ExportDescription
loadMlKem512()ML-KEM-512 loader
loadMlKem768()ML-KEM-768 loader
loadMlKem1024()ML-KEM-1024 loader

Each loader returns an object with keypair(), encrypt(), decrypt(), encryptMessage(), decryptMessage(), buffer_to_string().

Signatures (IFnDsa-style)

ExportAlgorithm
loadFnDsa512 / loadFnDsa1024FN-DSA (Falcon)
loadMlDsa3 / loadMlDsa5ML-DSA
loadSqisignLvl1 / Lvl3 / Lvl5SQIsign WASM
loadSlhDsa128 / 192 / 256SLH-DSA (JS)

Common methods: keypair(), sign(), verify(), buffer_to_string().

SQIsign-webGPU (browser)

ExportRole
loadSqisignLvl1WebGpu / Lvl3 / Lvl5Accelerated loaders
getSqisignWebGpuSupport()Feature detection
isSqisignWebGpuAvailable()Boolean helper
benchSqisignWebGpu(level)Built-in bench
setSqisignAccelWorkerUrl(url)Worker path override
SQISIGN_WEBGPU_VARIANT_LABELSDisplay labels

KAT hex exports

SQISIGN_LVL*_KAT0_*_HEX constants for known-answer checks (see package entry).

License

ISC