@claviss/sdk 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -21
- package/package.json +11 -10
package/README.md
CHANGED
|
@@ -1,33 +1,45 @@
|
|
|
1
1
|
# @claviss/sdk
|
|
2
2
|
|
|
3
|
-
Privacy
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
- **Shielded payments** — hidden-amount join-split transfers (deposit,
|
|
7
|
-
private transfer, withdraw) against the `ShieldedPools` contract.
|
|
8
|
-
- **Compliant privacy pool** — fixed-denomination deposits with
|
|
9
|
-
association-set withdrawals (`PrivacyPools`).
|
|
10
|
-
- **Selective disclosure** — Semaphore-style group credentials
|
|
11
|
-
(`CredentialGroups`): prove membership without revealing identity.
|
|
12
|
-
- **Stealth addresses** — one-time receiving addresses derived from a
|
|
13
|
-
spend/view keypair.
|
|
3
|
+
Privacy primitives for Robinhood Chain (EVM): hidden-amount shielded payments,
|
|
4
|
+
ZK selective disclosure, stealth addresses, and a compliant privacy pool.
|
|
14
5
|
|
|
15
6
|
```bash
|
|
16
7
|
npm install @claviss/sdk
|
|
17
8
|
```
|
|
18
9
|
|
|
19
|
-
|
|
20
|
-
import { chain, shielded, pool, stealth, zk } from "@claviss/sdk";
|
|
10
|
+
## Modules
|
|
21
11
|
|
|
22
|
-
|
|
12
|
+
```ts
|
|
13
|
+
import { zk, stealth, pool, shielded, chain } from "@claviss/sdk";
|
|
23
14
|
```
|
|
24
15
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
16
|
+
| Module | What it does |
|
|
17
|
+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| `zk` | Selective disclosure — prove membership or eligibility without revealing which identity (`CredentialGroups`). |
|
|
19
|
+
| `stealth` | One-time receive addresses (secp256k1, ERC-5564 style) so a main wallet isn't exposed. |
|
|
20
|
+
| `pool` | Compliant fixed-denomination privacy pool: ZK deposit/withdraw that severs the on-chain link, gated by an association set. |
|
|
21
|
+
| `shielded` | Hidden-amount UTXO pool: arbitrary amounts, partial spends, change, and multi-recipient transfers, with values kept encrypted. |
|
|
22
|
+
| `chain` | Robinhood Chain definitions for [viem](https://viem.sh) plus the contract ABIs. |
|
|
23
|
+
|
|
24
|
+
Every privacy feature keeps a disclosure and audit path — the pool is gated by an
|
|
25
|
+
association set rather than acting as an unconditional tumbler.
|
|
26
|
+
|
|
27
|
+
## Proving artifacts
|
|
28
|
+
|
|
29
|
+
The ZK modules need circuit artifacts (`*.wasm` and `*_final.zkey`) served
|
|
30
|
+
alongside your app. The reference frontend serves them from `public/`; point the
|
|
31
|
+
provers at wherever you host them.
|
|
32
|
+
|
|
33
|
+
## Source
|
|
34
|
+
|
|
35
|
+
This directory is a vendored snapshot of `packages/sdk` from the
|
|
36
|
+
[clavis monorepo](https://github.com/rempprandy-afk/clavis). Change it there, then
|
|
37
|
+
re-copy `src/` and rebuild with `npm run build:sdk`.
|
|
38
|
+
|
|
39
|
+
## Requirements
|
|
40
|
+
|
|
41
|
+
ESM-only, Node 18+ or a modern browser. `viem` is the only chain dependency.
|
|
28
42
|
|
|
29
|
-
|
|
30
|
-
> trusted setup is a development ceremony — do not rely on this for
|
|
31
|
-
> significant value yet.
|
|
43
|
+
## License
|
|
32
44
|
|
|
33
|
-
MIT —
|
|
45
|
+
MIT — see [LICENSE](../LICENSE).
|
package/package.json
CHANGED
|
@@ -1,23 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@claviss/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Clavis privacy SDK for Robinhood Chain (EVM): hidden-amount shielded payments, ZK selective disclosure, stealth addresses, compliant privacy pool.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "git+https://github.com/
|
|
9
|
-
"directory": "
|
|
8
|
+
"url": "git+https://github.com/rempprandy-afk/clavis.git",
|
|
9
|
+
"directory": "sdk"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/rempprandy-afk/clavis/tree/main/sdk#readme",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/rempprandy-afk/clavis/issues"
|
|
10
14
|
},
|
|
11
|
-
"homepage": "https://clavisrobinhood.com",
|
|
12
15
|
"keywords": [
|
|
13
16
|
"privacy",
|
|
14
|
-
"zero-knowledge",
|
|
15
17
|
"zk",
|
|
16
|
-
"
|
|
17
|
-
"
|
|
18
|
-
"robinhood-chain",
|
|
18
|
+
"zero-knowledge",
|
|
19
|
+
"stealth-addresses",
|
|
19
20
|
"evm",
|
|
20
|
-
"
|
|
21
|
+
"robinhood-chain"
|
|
21
22
|
],
|
|
22
23
|
"type": "module",
|
|
23
24
|
"main": "dist/index.js",
|
|
@@ -46,4 +47,4 @@
|
|
|
46
47
|
"devDependencies": {
|
|
47
48
|
"typescript": "^5.6.3"
|
|
48
49
|
}
|
|
49
|
-
}
|
|
50
|
+
}
|