@claviss/sdk 0.1.0

package/README.md

@@ -0,0 +1,33 @@
+# @claviss/sdk
+
+Privacy SDK for [Clavis](https://clavisrobinhood.com) — private payments on
+Robinhood Chain (EVM). In-browser ZK proving via snarkjs.
+
+- **Shielded payments** — hidden-amount join-split transfers (deposit,
+  private transfer, withdraw) against the `ShieldedPools` contract.
+- **Compliant privacy pool** — fixed-denomination deposits with
+  association-set withdrawals (`PrivacyPools`).
+- **Selective disclosure** — Semaphore-style group credentials
+  (`CredentialGroups`): prove membership without revealing identity.
+- **Stealth addresses** — one-time receiving addresses derived from a
+  spend/view keypair.
+
+```bash
+npm install @claviss/sdk
+```
+
+```ts
+import { chain, shielded, pool, stealth, zk } from "@claviss/sdk";
+
+// chains: chain.robinhoodTestnet (46630), chain.robinhoodMainnet (4663)
+```
+
+Proving artifacts (`*.wasm`, `*_final.zkey`) are not bundled — serve them from
+your app (see [clavis-app](https://github.com/romeoscript/clavis-app/tree/main/public))
+and pass their URLs to the provers.
+
+> **Status:** early beta. The zk circuits are unaudited and the current
+> trusted setup is a development ceremony — do not rely on this for
+> significant value yet.
+
+MIT — source: [github.com/romeoscript/clavis](https://github.com/romeoscript/clavis)