solvoid 1.1.4 β†’ 1.1.7

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +9 -3
  2. package/README.md +79 -27
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -2,11 +2,17 @@
2
2
 
3
3
  All notable changes to the SolVoid SDK will be documented in this file.
4
4
 
5
- ## [1.1.4] - 2026-01-31
5
+ ## [1.1.7] - 2026-01-31
6
6
 
7
7
  ### Synchronized
8
- - **Circuit-to-SDK Parity**: Finalized the synchronization of G1/G2 point verification signatures across the ZK proving pipeline.
9
- - **Professionalized Documentation**: Completed the transition to institutional-grade technical communication across all READMEs and internal comments.
8
+ - **Visual Parity**: Updated NPM documentation with high-fidelity architecture diagrams (raw URLs) and Mermaid data-flow schemas.
9
+ - **Enhanced Specs**: Synchronized all technical ecosystem features (Jito-MEV, circuitry, and admin controls) for institutional-grade presentation.
10
+
11
+ ## [1.1.6] - 2026-01-31
12
+
13
+ ## [1.1.5] - 2026-01-31
14
+
15
+ ## [1.1.4] - 2026-01-31
10
16
 
11
17
  ## [1.1.3] - 2026-01-31
12
18
 
package/README.md CHANGED
@@ -1,20 +1,66 @@
1
1
  # SolVoid TypeScript SDK: Institutional Privacy Integration
2
2
 
3
- The official integration layer for the SolVoid Privacy Protocol. This SDK provides a comprehensive software interface for decentralized applications requiring Zero-Knowledge (ZK) transaction anonymity and privacy auditing on Solana.
3
+ The official integration layer for the **SolVoid Privacy Protocol**. This SDK provides a comprehensive software interface for decentralized applications requiring Zero-Knowledge (ZK) transaction anonymity, identity obfuscation, and privacy auditing on Solana.
4
+
5
+ <div align="center">
6
+ <img src="https://github.com/brainless3178/SolVoid/raw/main/solvoid_assets.png" alt="SolVoid Architecture Infographic" width="800">
7
+ </div>
4
8
 
5
9
  [![NPM Version](https://img.shields.io/npm/v/solvoid.svg)](https://www.npmjs.com/package/solvoid)
6
- [![Documentation: SDK](https://img.shields.io/badge/Docs-SDK%20Reference-blue.svg)](../SDK_REFERENCE.md)
10
+ [![Protocol Status](https://img.shields.io/badge/Protocol-Beta-cyan.svg)](https://github.com/brainless3178/SolVoid)
11
+ [![License: MIT](https://img.shields.io/badge/License-MIT-gray.svg)](https://opensource.org/licenses/MIT)
7
12
 
8
13
  ---
9
14
 
10
- ## πŸ›  Architectural Features
15
+ ## πŸ› Full Ecosystem Context
16
+
17
+ While this package provides the SDK, SolVoid is a multi-layered privacy infrastructure. To access the full ecosystemβ€”including the **ZK circuits**, **Shadow Relayer**, **Atomic Rescue CLI**, and **Web Dashboard**β€”refer to the primary repository:
18
+
19
+ πŸ”— **[github.com/brainless3178/SolVoid](https://github.com/brainless3178/SolVoid)**
20
+
21
+ ---
22
+
23
+ ## πŸ› Technical Architecture
24
+
25
+ SolVoid orchestrates a multi-layered privacy lifecycle (PLM) that decouples on-chain identities from their transaction history while maintaining full protocol verifiability.
26
+
27
+ ### Operational Data Flow
28
+ ```mermaid
29
+ graph TD
30
+ A[Identity Layer] -->|Shielding Transaction| B(ZK-Prover Engine)
31
+ B -->|Groth16 Witness| C{SolVoid Vault}
32
+ C -->|Commitment Stored| D[Merkle Tree State]
33
+ E[Anonymity Recovery] -->|Withdrawal Request| F(Shadow Relayer)
34
+ F -->|Onion Routing| G(On-chain Verifier)
35
+ G -->|Proof Validated| H[Fresh Destination Address]
36
+ D -.->|Membership Proof| G
37
+ ```
38
+
39
+ ---
40
+
41
+ ## πŸš€ Key Ecosystem Infrastructure & Features
42
+
43
+ ### 1. Advanced Zero-Knowledge Stack
44
+ - **Groth16 Proving Pipeline**: High-performance proving implementation on the **BN254 curve**.
45
+ - **Poseidon-3 Hashing**: Standardized sponge construction ensuring 100% hash parity across **Circom (circuits)**, **Rust (Anchor program)**, and **TypeScript (SDK)**.
46
+ - **20-Level Merkle Tree**: Optimized sparse tree supporting over 1.04M unique commitments per pool.
11
47
 
12
- The SDK implements a highly-secure boundary between untrusted user inputs and protocol-critical ZK operations.
48
+ ### 2. Specialized ZK Circuitry
49
+ - **`withdraw.circom`**: Orchestrates nullifier verification, Merkle membership checks, and public signal binding.
50
+ - **`rescue.circom`**: A specialized emergency circuit for the Atomic Rescue Engine, enabling private migration of assets from compromised identities.
13
51
 
14
- - **Proof Orchestration:** Native integration with `snarkjs` for browser-compatible Groth16 witness generation.
15
- - **Sparse Merkle Tree Pathing:** Efficient client-side calculation of Merkle witnesses for 20-level trees.
16
- - **Onion Decryption Engine:** Handles multi-hop route construction and RSA-OAEP encryption for Shadow Relayer interactions.
17
- - **Data Integrity Layer:** Zod-based schema enforcement at every operational boundary (CLI, API, and Persistence).
52
+ ### 3. Privacy Ghost Score (Anonymity Auditing)
53
+ An integrated heuristic diagnostic engine that quantifies on-chain privacy risk (0-100).
54
+ - **Leak Detection**: Identifies identity linkage via common fee-funding sources, ATA creation history, and transaction-graph entropy.
55
+ - **ZK-Verified Badges**: Generate cryptographically verifiable reputation artifacts without revealing underlying data.
56
+
57
+ ### 4. Shadow Relayer Network (Onion Routing)
58
+ A decentralized network for gasless, unlinkable withdrawals.
59
+ - **RSA-OAEP Encryption**: Protects withdrawal payloads using recursive encryption layers.
60
+ - **Onion Routing**: Decouples the destination address from the withdrawal request, preventing IP-based linkage or RPC-level tracking.
61
+
62
+ ### 5. Atomic Rescue Engine (MEV Protection)
63
+ - **Jito Integration**: Leverages the **Jito-Solana mev-bundle** for sub-2s critical execution, protecting assets from front-running and sandwich attacks during emergency rotations.
18
64
 
19
65
  ---
20
66
 
@@ -26,15 +72,14 @@ npm install solvoid
26
72
 
27
73
  ---
28
74
 
29
- ## πŸš€ Integration Patterns
75
+ ## πŸ›  SDK Integration Patterns
30
76
 
31
77
  ### 1. Client Initialization
32
78
  ```typescript
33
79
  import { SolVoidClient } from 'solvoid';
34
- import { Connection } from '@solana/web3.js';
35
80
 
36
81
  const config = {
37
- rpcUrl: process.env.SOLANA_RPC_URL,
82
+ rpcUrl: 'https://api.mainnet-beta.solana.com',
38
83
  programId: 'Fg6PaFpoGXkYsidMpSsu3SWJYEHp7rQU9YSTFNDQ4F5i',
39
84
  relayerUrl: 'https://relayer.solvoid.network'
40
85
  };
@@ -47,12 +92,10 @@ const client = new SolVoidClient(config, walletAdapter);
47
92
  const amountLamports = 1_000_000_000; // 1.0 SOL
48
93
  const { commitmentData, status } = await client.shield(amountLamports);
49
94
 
50
- /** Persist primitives for subsequent unshielding. */
51
- console.log('Commitment Hash:', commitmentData.commitmentHex);
52
95
  console.log('Secret/Nullifier Primitives:', commitmentData.secret, commitmentData.nullifier);
53
96
  ```
54
97
 
55
- ### 3. Executing an Unlinkable Withdrawal
98
+ ### 3. Executing an Unlinkable Withdrawal (ZK Proving)
56
99
  ```typescript
57
100
  const result = await client.prepareWithdrawal(
58
101
  secret,
@@ -68,31 +111,40 @@ const result = await client.prepareWithdrawal(
68
111
  const txid = await client.submitWithdrawal(result);
69
112
  ```
70
113
 
71
- ---
72
-
73
- ## 🧬 Diagnostic Capability: Ghost Score
74
-
75
- The SDK provides internal access to the SolVoid Privacy Engine for real-time anonymity auditing.
76
-
114
+ ### 4. Privacy Auditing (Ghost Score)
77
115
  ```typescript
78
- const address = '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM';
79
116
  const passport = await client.getPassport(address);
80
-
81
117
  console.log(`Current Ghost Score: ${passport.overallScore}/100`);
82
118
  passport.recommendations.forEach(rec => console.log(`Audit Note: ${rec}`));
83
119
  ```
84
120
 
85
121
  ---
86
122
 
87
- ## πŸ”’ Integrity Standard
123
+ ## πŸ”’ Security & Performance
124
+ - **Sub-second Latency**: Optimized for Solana's 400ms block times.
125
+ - **Browser-Side Proving**: Execute Groth16 witness generation directly in the client environment via `snarkjs`.
126
+ - **Data Integrity Enforcement (DIE)**: Zod-powered schema validation at every operational boundary (CLI, API, SDK).
88
127
 
89
- The SolVoid SDK enforces **Strict Contextual Validation**. Every public key, transaction primitive, and API payload is validated against protocol-standard schemas before processing, mitigating common injection and state-corruption attack vectors.
128
+ ---
129
+
130
+ ## πŸ›  Project Orchestration (CLI & Operations)
131
+
132
+ While this package focus on the SDK, the following tools are available in the main repository:
133
+
134
+ ### CLI Command Summary (`solvoid`)
135
+ ```bash
136
+ solvoid shield <amount> # Surgical Shielding
137
+ solvoid withdraw <args> # Unlinkable Withdrawal
138
+ solvoid ghost <address> # Privacy Audit
139
+ solvoid rescue <wallet> # Atomic Remediation
140
+ solvoid admin pause/resume # Emergency Controls
141
+ ```
90
142
 
91
143
  ---
92
144
 
93
- ## πŸ“„ Licensing & Governance
145
+ ## πŸ“„ Licensing
94
146
 
95
- Distributed under the MIT License. SolVoid is a community-driven initiative focused on the advancement of digital sovereignty.
147
+ Distributed under the MIT License. SolVoid is an engineering-first initiative focused on digital sovereignty.
96
148
 
97
149
  ---
98
- *Questions? Refer to the [Technical Reference Documentation](../SDK_REFERENCE.md).*
150
+ *For the complete protocol documentation, circuits, and CLI, visit the [Main Repository](https://github.com/brainless3178/SolVoid).*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "solvoid",
3
- "version": "1.1.4",
3
+ "version": "1.1.7",
4
4
  "description": "SolVoid Privacy SDK - Zero-knowledge privacy for Solana",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",