tinyzkp

TypeScript client for the TinyZKP proving API — generate and verify ZK-STARK proofs.

Install

npm install tinyzkp

Quick Start

ESM (recommended):

import { TinyZKP } from "tinyzkp";

const client = new TinyZKP("https://api.tinyzkp.com", { apiKey: "tzk_..." });

// Prove a secret is in range [0, 100] — without revealing it
const jobId = await client.proveTemplate("range_proof", {
  min: 0, max: 100, witness_steps: [42, 44],
});

// Wait for the proof (polls automatically, typically 1-5 seconds)
const proof = await client.waitForProof(jobId);

// Verify it (always free)
const result = await client.verify(proof);
console.log(result.ok); // true — verified without learning the secret

CommonJS (works since v0.1.1):

const { TinyZKP } = require("tinyzkp");
const client = new TinyZKP("https://api.tinyzkp.com", { apiKey: "tzk_..." });

HcClient is the original name; TinyZKP is exported as an alias and is preferred in new code.

What are witness_steps?

The witness_steps encode your secret value as internal computation steps. They are never revealed to the verifier — only the proof (which vouches for them) is shared.

API

• new TinyZKP(baseUrl, options?) — create a client (alias for HcClient)
• proveTemplate(templateId, params, options?) — submit a proof via template (recommended)
• prove(request) — submit via raw program
• proveStatus(jobId) — check job status
• waitForProof(jobId, options?) — poll until proof is ready
• verify(proof, allowLegacyV2?) — verify a proof (always free)
• templates() / template(id) — list templates / get one template's full schema
• healthz() — check server health

ProofBytes is exported as a runtime class (new ProofBytes(version, bytes)) with a .toJSON() helper. Object literals matching { version, bytes } are still accepted everywhere a ProofBytes is expected.

Templates

Six built-in templates — no cryptography knowledge needed:

| Template | Proves | Example | |----------|--------|---------| | range_proof | A secret is in [min, max] | Age verification, credit scores | | hash_preimage | You know a secret matching a hash | Password proofs | | computation_attestation | f(secret) = public output | ML inference proofs | | accumulator_step | Additive chain is correct | Balance updates | | policy_compliance | Actions within a limit | Budget enforcement | | data_integrity | Data sums to checksum | Audit trails |

Uses the Fetch API (Node 18+, Bun, Deno, browsers). Ships both ESM (dist/esm/) and CJS (dist/cjs/) builds since v0.1.1.