Notice: ZK Features Consolidated into @hazbase/zk

[YutaHoshino]

Notice: ZK Features Consolidated into @hazbase/zk

We’ve consolidated all Zero-Knowledge (ZK) functions previously shipped with @hazbase/auth into a dedicated package @hazbase/zk. Accordingly, the ZK APIs in @hazbase/auth are now deprecated.

Why the change?

• Clear separation of concerns: authentication vs. zero-knowledge proof tooling
• Independent release cadence for ZK components
• Better DX: single entry point for ZK with streamlined docs, types, and error semantics

Impact

• Affected: Projects importing ZK helpers from @hazbase/auth (e.g., generateProof, genValues, deriveIdNull)
• Unaffected: Projects using only authentication/session features from @hazbase/auth

Migration (minimal diff)

• Old: import from @hazbase/auth
• New: import from @hazbase/zk

// Before
import { generateProof, genValues, deriveIdNull } from "@hazbase/auth";

// After
import { generateProof, generateProofAllowlist /* <- NEW! */, genValues, deriveIdNull } from "@hazbase/zk";

Deprecation policy

• ZK functions remain available in @hazbase/auth for a transition period but are marked Deprecated and will not receive new features.
• Deprecated APIs are planned for removal in the next major release.

Status & Requests

• These are early 0.x releases; APIs may change. We recommend starting on testnets.
• Ongoing security reviews will continue. Please report vulnerabilities or suggestions via GitHub Issues/Discussions.
• Designed for general, non-securities use cases. Please review applicable laws and guidelines in your jurisdiction.

Your feedback will shape our roadmap. Kick the tires and let us know what you think!