Integration & Configuration
Every parameter below is a real configuration variable in the ZPK™ engine. The protocol has no fixed opinions about storage, chain, auth, or security tier. You bring the infrastructure. ZPK™ brings the protocol.
import { ZPKClient } from '@zpk/sdk'; // Initialize once at app startup const zpk = new ZPKClient({ apiKey: 'zpk_live_your_key_here', chain: 'xahau', // xahau | xrpl | both | custom storage: 'arweave', // arweave | ipfs | s3 | private particles: 4096, // 256 - 4096 tier: 'hipaa' // baseline | hipaa | iso20022 | military }); // Shatter, anchor, and disperse in one call const { anchor, proof, arweaveTx } = await zpk.shatter(file, { authHash: sha256(userWalletAddress), webhook: 'https://your-app.com/zpk/events' }); // anchor.id → 32-byte Merkle root posted to ledger // proof → Schnorr NIZK stored to Arweave // arweaveTx → permanent proof retrieval ID // Reconstruct (requires live ledger authorization) const { file: recovered } = await zpk.materialize(anchor.id, { authHash: sha256(userWalletAddress) }); // recovered is the original file, in memory only, never written to disk
Particle Count
Number of entropic fragments the document is dispersed into. Higher values increase operational security at the cost of reconstruction latency.
Security Tier
Baseline is suitable for general use. HIPAA and ISO 20022 enforce compliance-specific memo formats. Military enables recursive shattering.
Anchor Chain
The ledger that receives the 32-byte Merkle root. Select both for dual-anchor redundancy. Custom accepts any EVM or UTXO chain with memo support.
Storage Backend
Where entropic particles are distributed after dispersal. Enterprise deployments typically use private clusters or sovereign infrastructure.
Auth Factor Type
The identity input hashed for reconstruction authorization. All factor types produce identical 64-hex auth hashes. The type is never stored or disclosed.
Reconstruction Threshold
k-of-n erasure coding. Default (n, n) requires all particles. Lowering k improves liveness at the cost of a non-zero information leakage bound.
Hook Enforcement
Deploys a Xahau Hook that rejects any payment not carrying a valid DNA Anchor™ memo. Enforcement operates at ledger level, not application level.
RAM Lock
Calls mlock() to prevent the OS from swapping document pages to disk during the shatter operation. Required for a guaranteed RAM-only security proof.
Offline Mode
Batches shatter operations locally and syncs anchors when connectivity is restored. Suitable for air-gapped or intermittently-connected deployments.
Proof Storage
Where the Schnorr NIZK proof is persisted after generation. Arweave provides public verifiability. Private keeps the proof within enterprise infrastructure.
Reconstruction Webhook
Your endpoint receives a POST when a reconstruction event is authorized. Payload includes the anchor ID, auth hash (not the auth value), and timestamp.
Rate Limit
Maximum API requests per minute per key. Enterprise keys are uncapped on private deployments. Free tier is limited to 60 rpm.