@clearproof/content 0.5.0 → 0.6.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.
|
@@ -56,6 +56,17 @@ Some acceptance properties live outside the circuit. The authorization service c
|
|
|
56
56
|
|
|
57
57
|
`ComplianceProof(20, 10)` in `compliance.circom` publishes 16 values, including `is_compliant`, a tier-derived `sar_review_flag`, the amount tier, the jurisdiction and the tier thresholds. It remains a demo and parity path with its own verifier, SDK function and tests. Legacy proofs are never current pilot authorization.
|
|
58
58
|
|
|
59
|
+
## Source package
|
|
60
|
+
|
|
61
|
+
`@clearproof/circuits` publishes these sources for inspection and compilation, with no compiled artifacts or keys (from 0.6.0; 0.3.0 and earlier were an outdated legacy-only package with development artifacts). Install it with `circomlib` and compile with `-l node_modules`:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npm install @clearproof/circuits circomlib
|
|
65
|
+
circom node_modules/@clearproof/circuits/circuits/pilot_compliance.circom -l node_modules --r1cs --wasm
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
`circuits/MANIFEST.json` in the package lists the SHA-256 of each repository file and each packaged file; the only change is that `circomlib` includes are rewritten to `circomlib/...`. `circomlib` is licensed GPL-3.0 and is a peer dependency, not bundled.
|
|
69
|
+
|
|
59
70
|
## Building development artifacts
|
|
60
71
|
|
|
61
72
|
```bash
|
|
@@ -11,17 +11,17 @@ This is a development setup guide, checked September 25, 2026. Use synthetic dat
|
|
|
11
11
|
|
|
12
12
|
## Public package access
|
|
13
13
|
|
|
14
|
-
The [main source repository](https://github.com/repfigit/clearproof) is public.
|
|
14
|
+
The [main source repository](https://github.com/repfigit/clearproof) is public. npm packages are at version 0.6.0:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npm install @clearproof/proof@0.
|
|
17
|
+
npm install @clearproof/proof@0.6.0
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
Proof generation requires compatible circuit WASM and proving-key files. Verification requires the matching verification key. Inspect package contents before relying on exported artifact paths; installing the SDK alone does not create a complete proving environment.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
0.6.0 includes the pilot and the current `pilot-transfer-v3` profile. `@clearproof/circuits` publishes the circuit sources only, with no compiled artifacts or keys.
|
|
23
23
|
|
|
24
|
-
The
|
|
24
|
+
The CLI installs from npm with `npm install -g @clearproof/cli` (verified September 26, 2026). The source setup below builds the same workspaces and adds the Python API, circuits and pilot acceptance tooling.
|
|
25
25
|
|
|
26
26
|
## Source setup for the unreleased pilot
|
|
27
27
|
|
package/content/topics/sdk.md
CHANGED
|
@@ -7,15 +7,15 @@ cli-topic: sdk
|
|
|
7
7
|
|
|
8
8
|
# TypeScript SDK
|
|
9
9
|
|
|
10
|
-
`@clearproof/proof` provides proof generation, cryptographic verification and counterparty discovery. Published version: **0.
|
|
10
|
+
`@clearproof/proof` provides proof generation, cryptographic verification and counterparty discovery. Published version: **0.6.0**, checked September 26, 2026. It includes the pilot functions and the legacy 16-signal functions described below. Confirm the installed version before using its types.
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
npm install @clearproof/proof@0.
|
|
15
|
+
npm install @clearproof/proof@0.6.0
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
## Legacy proof API
|
|
18
|
+
## Legacy proof API
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
21
|
import { generateProof, verifyProof, type ComplianceInput } from '@clearproof/proof';
|
|
@@ -32,7 +32,7 @@ The caller supplies compatible artifacts. The SDK maps camelCase fields to Circo
|
|
|
32
32
|
|
|
33
33
|
`verified.valid` describes cryptographic verification. `isCompliant` and `sarReviewFlag` interpret circuit outputs; they do not establish full registry acceptance, current policy authorization or legal compliance. Additional trust, freshness, revocation, domain and replay checks remain necessary.
|
|
34
34
|
|
|
35
|
-
## Pilot functions
|
|
35
|
+
## Pilot functions
|
|
36
36
|
|
|
37
37
|
| Function | Purpose |
|
|
38
38
|
| --- | --- |
|
|
@@ -28,6 +28,6 @@ Use synthetic records and testnet funds. Check approved issuer/root/artifact pro
|
|
|
28
28
|
|
|
29
29
|
## Vulnerability reporting
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
[Report privately through GitHub](https://github.com/repfigit/clearproof/security/advisories/new) (preferred) or email **security@clearproof.dev**. Share reproduction steps and impact privately; do not post sensitive exploit details or personal information in a public issue. See [report an issue](/docs/report-issues). This documentation does not promise a response-time SLA.
|
|
32
32
|
|
|
33
33
|
No active paid bug-bounty program is announced here. See [project status](/docs/status) for the implementation and assurance work that remains.
|