solvoid 1.2.0 → 1.3.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 +116 -258
- package/SECURITY.md +27 -24
- package/dist/cli/commands/ghost.d.ts +3 -3
- package/dist/cli/commands/ghost.d.ts.map +1 -1
- package/dist/cli/commands/ghost.js +67 -91
- package/dist/cli/commands/ghost.js.map +1 -1
- package/dist/cli/commands/rescue.d.ts +4 -0
- package/dist/cli/commands/rescue.d.ts.map +1 -1
- package/dist/cli/commands/rescue.js +102 -199
- package/dist/cli/commands/rescue.js.map +1 -1
- package/dist/cli/demo-scan.js +48 -130
- package/dist/cli/demo-scan.js.map +1 -1
- package/dist/cli/solvoid-scan.d.ts +4 -3
- package/dist/cli/solvoid-scan.d.ts.map +1 -1
- package/dist/cli/solvoid-scan.js +55 -46
- package/dist/cli/solvoid-scan.js.map +1 -1
- package/dist/cli/utils/asset-scanner.d.ts.map +1 -1
- package/dist/cli/utils/asset-scanner.js +7 -5
- package/dist/cli/utils/asset-scanner.js.map +1 -1
- package/dist/cli/utils/badge-generator.d.ts.map +1 -1
- package/dist/cli/utils/badge-generator.js +11 -9
- package/dist/cli/utils/badge-generator.js.map +1 -1
- package/dist/cli/utils/enhanced-monitoring.d.ts +13 -0
- package/dist/cli/utils/enhanced-monitoring.d.ts.map +1 -0
- package/dist/cli/utils/enhanced-monitoring.js +46 -0
- package/dist/cli/utils/enhanced-monitoring.js.map +1 -0
- package/dist/cli/utils/enhanced-pyth-feed.d.ts +20 -0
- package/dist/cli/utils/enhanced-pyth-feed.d.ts.map +1 -0
- package/dist/cli/utils/enhanced-pyth-feed.js +64 -0
- package/dist/cli/utils/enhanced-pyth-feed.js.map +1 -0
- package/dist/cli/utils/enhanced-threat-intel.d.ts +20 -0
- package/dist/cli/utils/enhanced-threat-intel.d.ts.map +1 -0
- package/dist/cli/utils/enhanced-threat-intel.js +57 -0
- package/dist/cli/utils/enhanced-threat-intel.js.map +1 -0
- package/dist/cli/utils/env-validator.d.ts.map +1 -1
- package/dist/cli/utils/env-validator.js +6 -3
- package/dist/cli/utils/env-validator.js.map +1 -1
- package/dist/cli/utils/jito-mev-bundle.d.ts +9 -0
- package/dist/cli/utils/jito-mev-bundle.d.ts.map +1 -0
- package/dist/cli/utils/jito-mev-bundle.js +40 -0
- package/dist/cli/utils/jito-mev-bundle.js.map +1 -0
- package/dist/cli/utils/rescue-engine.d.ts +0 -4
- package/dist/cli/utils/rescue-engine.d.ts.map +1 -1
- package/dist/cli/utils/rescue-engine.js +28 -46
- package/dist/cli/utils/rescue-engine.js.map +1 -1
- package/dist/cli/utils/shadow-bridge.d.ts +20 -0
- package/dist/cli/utils/shadow-bridge.d.ts.map +1 -0
- package/dist/cli/utils/shadow-bridge.js +33 -0
- package/dist/cli/utils/shadow-bridge.js.map +1 -0
- package/dist/relayer/key-manager.d.ts +52 -0
- package/dist/relayer/key-manager.d.ts.map +1 -0
- package/dist/relayer/key-manager.js +356 -0
- package/dist/relayer/key-manager.js.map +1 -0
- package/dist/relayer/replay-protection.d.ts +94 -0
- package/dist/relayer/replay-protection.d.ts.map +1 -0
- package/dist/relayer/replay-protection.js +189 -0
- package/dist/relayer/replay-protection.js.map +1 -0
- package/dist/relayer/secure-service.d.ts +46 -0
- package/dist/relayer/secure-service.d.ts.map +1 -0
- package/dist/relayer/secure-service.js +538 -0
- package/dist/relayer/secure-service.js.map +1 -0
- package/dist/relayer/service.d.ts +25 -0
- package/dist/relayer/service.d.ts.map +1 -0
- package/dist/relayer/service.js +380 -0
- package/dist/relayer/service.js.map +1 -0
- package/dist/sdk/client.d.ts +42 -8
- package/dist/sdk/client.d.ts.map +1 -1
- package/dist/sdk/client.js +115 -242
- package/dist/sdk/client.js.map +1 -1
- package/dist/sdk/crypto/poseidon.d.ts +4 -4
- package/dist/sdk/crypto/poseidon.d.ts.map +1 -1
- package/dist/sdk/crypto/poseidon.js +34 -17
- package/dist/sdk/crypto/poseidon.js.map +1 -1
- package/dist/sdk/integrity.d.ts +3 -3
- package/dist/sdk/integrity.d.ts.map +1 -1
- package/dist/sdk/integrity.js +2 -2
- package/dist/sdk/integrity.js.map +1 -1
- package/dist/sdk/passport/manager.d.ts +15 -3
- package/dist/sdk/passport/manager.d.ts.map +1 -1
- package/dist/sdk/passport/manager.js +30 -17
- package/dist/sdk/passport/manager.js.map +1 -1
- package/dist/sdk/pipeline.d.ts.map +1 -1
- package/dist/sdk/pipeline.js +69 -12
- package/dist/sdk/pipeline.js.map +1 -1
- package/dist/sdk/polyfill.d.ts +8 -0
- package/dist/sdk/polyfill.d.ts.map +1 -0
- package/dist/sdk/polyfill.js +21 -0
- package/dist/sdk/polyfill.js.map +1 -0
- package/dist/sdk/privacy/shield.d.ts +46 -0
- package/dist/sdk/privacy/shield.d.ts.map +1 -1
- package/dist/sdk/privacy/shield.js +117 -35
- package/dist/sdk/privacy/shield.js.map +1 -1
- package/dist/sdk/privacy-engine.d.ts +17 -3
- package/dist/sdk/privacy-engine.d.ts.map +1 -1
- package/dist/sdk/privacy-engine.js +46 -20
- package/dist/sdk/privacy-engine.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,312 +1,170 @@
|
|
|
1
|
+
# SolVoid: Institutional-Grade Privacy Infrastructure for Solana
|
|
2
|
+
|
|
1
3
|
<div align="center">
|
|
2
|
-
<
|
|
3
|
-
<pre>
|
|
4
|
-
███████╗ ██████╗ ██╗ ██╗ ██╗ ██████╗ ██╗██████╗
|
|
5
|
-
██╔════╝██╔═══██╗██║ ██║ ██║██╔═══██╗██║██╔══██╗
|
|
6
|
-
███████╗██║ ██║██║ ██║ ██║██║ ██║██║██║ ██║
|
|
7
|
-
╚════██║██║ ██║██║ ╚██╗ ██╔╝██║ ██║██║██║ ██║
|
|
8
|
-
███████║╚██████╔╝███████╗ ╚████╔╝ ╚██████╔╝██║██████╔╝
|
|
9
|
-
╚══════╝ ╚═════╝ ╚══════╝ ╚═══╝ ╚═════╝ ╚═╝╚═════╝
|
|
10
|
-
</pre>
|
|
11
|
-
|
|
12
|
-
<h3><b>SolVoid Protocol: The Enterprise Sovereign Privacy Layer</b></h3>
|
|
13
|
-
<p><i>Next-Generation Zero-Knowledge Privacy Lifecycle Management (PLM) for the Solana Ecosystem</i></p>
|
|
14
|
-
|
|
15
|
-
<p>
|
|
16
|
-
<a href="https://github.com/brainless3178/SolVoid/actions"><img src="https://img.shields.io/github/actions/workflow/status/brainless3178/SolVoid/privacy.yml?branch=main&style=for-the-badge&logo=github&label=CI/CD%20Pipeline" alt="Build Status"></a>
|
|
17
|
-
<a href="https://codecov.io/gh/brainless3178/SolVoid"><img src="https://img.shields.io/badge/ZK%20Circuit%20Coverage-98%25-brightgreen?style=for-the-badge&logo=codecov&label=ZK%20Circuit%20Coverage" alt="Code Coverage"></a>
|
|
18
|
-
<a href="https://github.com/brainless3178/SolVoid/releases"><img src="https://img.shields.io/badge/Production-v1.2.0-blue?style=for-the-badge&logo=github" alt="Version"></a>
|
|
19
|
-
<a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge&logo=github" alt="License"></a>
|
|
20
|
-
</p>
|
|
21
|
-
<p>
|
|
22
|
-
<a href="https://solana.com"><img src="https://img.shields.io/badge/Solana-Mainnet--Beta%20Ready-black?style=for-the-badge&logo=solana" alt="Solana Compatibility"></a>
|
|
23
|
-
<a href="./docs"><img src="https://img.shields.io/badge/Documentation-Stripe--Grade-green?style=for-the-badge&logo=gitbook" alt="Docs Status"></a>
|
|
24
|
-
<a href="https://github.com/brainless3178/SolVoid/security/advisories"><img src="https://img.shields.io/badge/Security-Cryptographic%20Verified-brightgreen?style=for-the-badge&logo=dependabot" alt="Security Status"></a>
|
|
25
|
-
<a href="https://discord.gg/solvoid"><img src="https://img.shields.io/badge/Discord-Audit%20Live-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"></a>
|
|
26
|
-
</p>
|
|
27
|
-
|
|
28
|
-
<p align="center">
|
|
29
|
-
<strong>SolVoid</strong> is a high-performance, non-custodial privacy protocol that provides a decentralized identity-abstraction layer on the Solana blockchain.
|
|
30
|
-
<br />
|
|
31
|
-
It utilizes <b>Groth16 Zero-Knowledge SNARKs</b> and <b>Poseidon-3 Hashing</b> to deliver institutional-grade anonymity at sub-second speeds.
|
|
32
|
-
</p>
|
|
4
|
+
<img src="./solvoid_assets.png" alt="SolVoid Architecture Infographic" width="800">
|
|
33
5
|
</div>
|
|
34
6
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
In the landscape of hyper-transparent blockchain architectures, **SolVoid** represents the critical transition from "Public-by-Default" to "Private-by-Choice." The protocol is engineered to neutralize the risks of on-chain telemetry, MEV-sandwich attacks, and transaction graph heuristics. By decoupling asset ownership from transaction history, SolVoid empowers individuals and institutions to execute sensitive financial maneuvers with the speed of Solana and the secrecy of Zero-Knowledge.
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## 🧭 Master Table of Contents
|
|
44
|
-
|
|
45
|
-
1. [Core Value Propositions](#-core-value-propositions)
|
|
46
|
-
2. [Exhaustive Feature Matrix](#-exhaustive-feature-matrix)
|
|
47
|
-
3. [Deep-Dive Architecture](#-deep-dive-architecture)
|
|
48
|
-
- [ZK-SNARK Circuit Topology](#zk-snark-circuit-topology)
|
|
49
|
-
- [The Poseidon-3 Hash Standard](#the-poseidon-3-hash-standard)
|
|
50
|
-
- [On-Chain State Management](#on-chain-state-management)
|
|
51
|
-
4. [Privacy Ghost Score Diagnostics](#-privacy-ghost-score-diagnostics)
|
|
52
|
-
5. [Command-Line Interface (CLI) Master Reference](#-command-line-interface-cli-master-reference)
|
|
53
|
-
6. [Shadow Relayer Infrastructure](#-shadow-relayer-infrastructure)
|
|
54
|
-
7. [Operational Setup & Lifecycle](#-operational-setup--lifecycle)
|
|
55
|
-
8. [Security, Validation & Testing](#-security-validation--testing)
|
|
56
|
-
- [The Shell Script Index](#the-shell-script-index)
|
|
57
|
-
9. [Master Strategic Roadmap](#-master-strategic-roadmap)
|
|
58
|
-
10. [Repository Directory Blueprint](#-repository-directory-blueprint)
|
|
59
|
-
11. [Governance & Strategic Contributions](#-governance--strategic-contributions)
|
|
60
|
-
12. [Glossary of Cryptographic Terms](#-glossary-of-cryptographic-terms)
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
## 💎 Core Value Propositions
|
|
65
|
-
|
|
66
|
-
- **Unlinkable Anonymity**: Complete decoupling of funding sources from destination wallets via Merkle-tree based shielding.
|
|
67
|
-
- **Hardware-Accelerated Privacy**: Optimized for Solana’s runtime, achieving verification costs below 200,000 Compute Units.
|
|
68
|
-
- **Zero-Knowledge Integrity**: Pure cryptographic proof of ownership without revealing the source deposit (Secret/Nullifier).
|
|
69
|
-
- **Anti-Heuristic Engine**: Native defense against transaction timing and volume analysis via the Ghost Scoring diagnostics.
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
## ✨ Exhaustive Feature Matrix
|
|
7
|
+
[](https://solvoid.io)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
[](./ZK_REFERENCE.md)
|
|
74
10
|
|
|
75
|
-
|
|
76
|
-
| :--- | :--- | :--- | :---: |
|
|
77
|
-
| **Shielding** | **ZK-Commitment Pool** | Fixed-depth (20) Merkle Tree supporting 1M+ deposits. | ✅ |
|
|
78
|
-
| **Withdrawal** | **Groth16 Verification** | Sub-600ms proof generation on-device via WASM/SDK. | ✅ |
|
|
79
|
-
| **Diagnostics** | **Privacy Ghost Score** | 4-pillar metadata audit (Linkage, Temporal, Volume, Entropy). | ✅ |
|
|
80
|
-
| **Infrastructure**| **Shadow Relayer 2.0** | Gasless & IP-anonymous transaction broadcasting. | ✅ |
|
|
81
|
-
| **Emergency** | **Atomic Rescue** | <2s scripted migration for compromised private keys. | ✅ |
|
|
82
|
-
| **Identity** | **ZK-Signed Badges** | Portable personal privacy credentials without revealing the URI. | ✅ |
|
|
83
|
-
| **Scanners** | **Ultimate Privacy Scan** | Resilience suite using 40+ RPCs with IP-rotation. | ✅ |
|
|
11
|
+
SolVoid is a high-performance, non-custodial privacy protocol designed for the Solana ecosystem. By leveraging **Groth16 Zero-Knowledge Proofs** and circuit-optimized **Poseidon-3 hashing**, SolVoid enables cryptographically unlinkable asset transfers and identity obfuscation with sub-second latency.
|
|
84
12
|
|
|
85
13
|
---
|
|
86
14
|
|
|
87
|
-
##
|
|
15
|
+
## 🏛 Technical Architecture
|
|
88
16
|
|
|
89
|
-
SolVoid
|
|
17
|
+
SolVoid orchestrates a multi-layered privacy lifecycle (PLM) that decouples on-chain identities from their transaction history while maintaining full protocol verifiability.
|
|
90
18
|
|
|
19
|
+
### Operational Data Flow
|
|
91
20
|
```mermaid
|
|
92
21
|
graph TD
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
D -->|Anonymous Broadcast| E[Shadow Relayer Node]
|
|
101
|
-
E -->|Transaction Forwarding| F[Solana Mainnet]
|
|
102
|
-
end
|
|
103
|
-
|
|
104
|
-
subgraph "Solana Smart Contract (Anchor)"
|
|
105
|
-
F --> G[Merkle Tree State]
|
|
106
|
-
G -->|Root Validation| H[Verifier Module]
|
|
107
|
-
H -->|Nullifier Check| I[Fund Release]
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
I -->|Private Funds| J[New Stealth Address]
|
|
22
|
+
A[Identity Layer] -->|Shielding Transaction| B(ZK-Prover Engine)
|
|
23
|
+
B -->|Groth16 Witness| C{SolVoid Vault}
|
|
24
|
+
C -->|Commitment Stored| D[Merkle Tree State]
|
|
25
|
+
E[Anonymity Recovery] -->|Withdrawal Request| F(Shadow Relayer)
|
|
26
|
+
F -->|Onion Routing| G(On-chain Verifier)
|
|
27
|
+
G -->|Proof Validated| H[Fresh Destination Address]
|
|
28
|
+
D -.->|Membership Proof| G
|
|
111
29
|
```
|
|
112
30
|
|
|
113
|
-
### ZK-SNARK Circuit Topology
|
|
114
|
-
Our circuits are written in **Circom 2.1**, employing a Groth16 proving scheme on the **BN254** elliptic curve. This ensures maximum compatibility with Solana's forthcoming ZK precompiles while maintaining current operational efficiency through our custom Rust verifier.
|
|
115
|
-
|
|
116
|
-
### The Poseidon-3 Hash Standard
|
|
117
|
-
We use **Poseidon-3**, a Sponge-construction hash function optimized specifically for R1CS (Rank-1 Constraint Systems).
|
|
118
|
-
- **Efficiency**: Reduces constraints from ~20,000 (Keccak) to **~210** per field element.
|
|
119
|
-
- **Security**: Provides 128-bit security against all known algebraic attacks.
|
|
120
|
-
|
|
121
|
-
### On-Chain State Management
|
|
122
|
-
The SolVoid program manages a sliding window of **100 Merkle Roots**. This allows users to generate proofs against slightly older state, mitigating the risk of "Root Drift" where a proof becomes invalid because someone else deposited simultaneously.
|
|
123
|
-
|
|
124
31
|
---
|
|
125
32
|
|
|
126
|
-
##
|
|
127
|
-
|
|
128
|
-
The **Ghost Score** is the heartbeat of the SolVoid ecosystem. It provides an objective numerical rank (0-100) of your wallet's anonymity.
|
|
33
|
+
## � Project Lifecycle & Orchestration
|
|
129
34
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
- **Volume Profiling**: Flagging of round-number deposits (e.g., exactly 10.0 SOL) which are easier to track.
|
|
35
|
+
### 1. Environment & Deployment Hub
|
|
36
|
+
The foundation for building, testing, and deploying the SolVoid protocol.
|
|
133
37
|
|
|
134
38
|
```bash
|
|
135
|
-
#
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
## 🔧 Command-Line Interface (CLI) Master Reference
|
|
142
|
-
|
|
143
|
-
The `solvoid-scan` CLI is a production-grade binary for privacy management.
|
|
144
|
-
|
|
145
|
-
#### Core Operational Commands
|
|
146
|
-
- `solvoid-scan shield <amount>`: The primary ingress. Converts native SOL to a ZK-Commitment.
|
|
147
|
-
- `solvoid-scan withdraw <secret> <nullifier> <recipient> <amount>`: The primary egress. Reclaims funds anonymously.
|
|
148
|
-
- `solvoid-scan ghost <address>`: Generates the Ghost Score report and visual terminal art.
|
|
149
|
-
- `solvoid-scan protect <address>`: Active monitoring mode for identifying real-time privacy leaks.
|
|
150
|
-
- `solvoid-scan rescue <wallet>`: Atomic "nuke" option for high-speed mitigation of key leaks.
|
|
151
|
-
|
|
152
|
-
#### Protocol Administration
|
|
153
|
-
- `solvoid-scan admin trigger-emergency <mult> <reason>`: Globally scale protocol fees (1x-10x).
|
|
154
|
-
- `solvoid-scan admin disable-emergency`: Restore baseline fee economics.
|
|
155
|
-
- `solvoid-scan admin pause`: Trigger Circuit Breaker to halt all withdrawals.
|
|
156
|
-
- `solvoid-scan admin resume`: Lift Circuit Breaker and resume protocol operations.
|
|
157
|
-
|
|
158
|
-
#### Global Flags & Automation
|
|
159
|
-
| Flag | Description | Default |
|
|
160
|
-
| :--- | :--- | :--- |
|
|
161
|
-
| `--rpc <URL>` | Override standard Solana RPC endpoints. | Mainnet-Beta |
|
|
162
|
-
| `--program <ID>` | Override the default SolVoid Program ID. | `Fg6Pa...` |
|
|
163
|
-
| `--relayer <URL>` | Target a specific Shadow Relayer instance. | `http://localhost:3000` |
|
|
164
|
-
| `--dry-run` | Perform an atomic simulation without spending gas. | `false` |
|
|
165
|
-
| `--json` | Output all results in raw JSON format for CI/CD. | `false` |
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## 🛰 Shadow Relayer Infrastructure
|
|
170
|
-
|
|
171
|
-
The **Shadow Relayer** is a critical component for achieving network-level anonymity.
|
|
172
|
-
|
|
173
|
-
> **TIP**
|
|
174
|
-
> Use the Relayer to avoid "Gas Linkage." If you fund your new recipient wallet with gas from an exchange, you have nullified your privacy. The Relayer solves this by paying the gas for you and deducting a small bounty from the withdrawal.
|
|
39
|
+
# Repository Initialization
|
|
40
|
+
git clone https://github.com/brainless3178/SolVoid.git
|
|
41
|
+
cd SolVoid
|
|
42
|
+
npm install
|
|
175
43
|
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
-
|
|
179
|
-
- `POST /relay`: The primary submission point for ZK-signed transactions.
|
|
180
|
-
- `POST /encrypt-route`: Prepares multi-hop onion-routed payloads.
|
|
44
|
+
# ZK Cryptographic Pipeline
|
|
45
|
+
# Compiles circuits and generates proving/verification keys
|
|
46
|
+
./scripts/build-zk.sh
|
|
181
47
|
|
|
182
|
-
|
|
48
|
+
# On-Chain Program Lifecycle (Anchor)
|
|
49
|
+
anchor build
|
|
50
|
+
anchor deploy --provider.cluster devnet
|
|
183
51
|
|
|
184
|
-
|
|
52
|
+
# Quality Assurance Suite
|
|
53
|
+
npm test # Execute full test matrix
|
|
54
|
+
npm run lint # Static code analysis
|
|
55
|
+
npm run dashboard:dev # Launch local UI environment
|
|
56
|
+
```
|
|
185
57
|
|
|
186
|
-
###
|
|
187
|
-
|
|
188
|
-
- **Rust/Cargo**: 1.75.0+
|
|
189
|
-
- **Solana CLI**: Latest Stable
|
|
190
|
-
- **Hardware**: AVX2 support (optional, for faster local proving)
|
|
58
|
+
### 2. CLI Command Specification (`solvoid`)
|
|
59
|
+
The primary interface for protocol interaction, auditing, and emergency response.
|
|
191
60
|
|
|
192
|
-
|
|
61
|
+
#### **Surgical Shielding (Deposit)**
|
|
193
62
|
```bash
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
# Install Critical Dependencies
|
|
199
|
-
npm install && npm run build
|
|
63
|
+
solvoid shield <amount>
|
|
64
|
+
```
|
|
65
|
+
* **Args**: `<amount>` (SOL to shield)
|
|
66
|
+
* **Protocol Action**: Generates `Secret` and `Nullifier` keys and commits hashed state to the Merkle tree.
|
|
200
67
|
|
|
201
|
-
|
|
202
|
-
|
|
68
|
+
#### **Unlinkable Withdrawal**
|
|
69
|
+
```bash
|
|
70
|
+
solvoid withdraw <secret> <nullifier> <recipient> <amount> [options]
|
|
203
71
|
```
|
|
72
|
+
| Option | Description | Default |
|
|
73
|
+
|:---|:---|:---|
|
|
74
|
+
| `--relayer <url>`| Target Shadow Relayer endpoint | `.env` default |
|
|
75
|
+
| `--rpc <url>` | Override default Solana RPC | `.env` default |
|
|
204
76
|
|
|
205
|
-
|
|
206
|
-
For highly secure local environments, run a personal MPC ceremony:
|
|
77
|
+
#### **Privacy Ghost Score (Audit)**
|
|
207
78
|
```bash
|
|
208
|
-
|
|
79
|
+
solvoid ghost <address> [options]
|
|
209
80
|
```
|
|
81
|
+
| Option | Description |
|
|
82
|
+
|:---|:---|
|
|
83
|
+
| `--badge` | Generate a ZK-verified Privacy Badge artifact |
|
|
84
|
+
| `--share` | Generate social metadata for X/Discord platforms |
|
|
85
|
+
| `--verify <p>` | Cryptographically validate an external privacy proof |
|
|
86
|
+
| `--json` | Return raw audit data for programmatic ingestion |
|
|
87
|
+
|
|
88
|
+
#### **Atomic Rescue (MEV Protection)**
|
|
89
|
+
```bash
|
|
90
|
+
solvoid rescue <wallet> [options]
|
|
91
|
+
```
|
|
92
|
+
| Option | Description |
|
|
93
|
+
|:---|:---|
|
|
94
|
+
| `--to <addr>` | Specified recovery destination address |
|
|
95
|
+
| `--auto-generate`| Initialize a fresh, secure remediation wallet |
|
|
96
|
+
| `--jito-bundle` | Utilize Jito-Solana MEV bundles for atomic execution |
|
|
97
|
+
| `--emergency` | Priority fee escalation for sub-2s critical rotation |
|
|
98
|
+
| `--dry-run` | Simulate orchestration without network broadcast |
|
|
99
|
+
| `--monitor` | Activate real-time post-remediation threat alerts |
|
|
100
|
+
|
|
101
|
+
#### **Protocol Administration (Emergency Controls)**
|
|
102
|
+
```bash
|
|
103
|
+
solvoid admin <command> [args]
|
|
104
|
+
```
|
|
105
|
+
| Command | Action |
|
|
106
|
+
|:---|:---|
|
|
107
|
+
| `pause` | Trigger the ZK Circuit Breaker to suspend withdrawals |
|
|
108
|
+
| `resume` | Reset breaker and resume protocol operations |
|
|
109
|
+
| `trigger-emergency` | Escalates protocol-wide fee multipliers (x1-x10) |
|
|
110
|
+
| `disable-emergency` | Resets protocol fees to baseline state |
|
|
210
111
|
|
|
211
112
|
---
|
|
212
113
|
|
|
213
|
-
|
|
114
|
+
### 3. SDK Integration Patterns
|
|
115
|
+
A professional integration layer for third-party dApps and services.
|
|
214
116
|
|
|
215
|
-
|
|
117
|
+
```typescript
|
|
118
|
+
import { SolVoidClient } from 'solvoid';
|
|
216
119
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
| :--- | :--- |
|
|
220
|
-
| `./scripts/run-security-tests.sh` | **The Master Suite**: Runs every validation mentioned below. |
|
|
221
|
-
| `./scripts/verify-hash-consistency.sh` | Confirms Poseidon-3 parity across Rust, TS, and Circom logic. |
|
|
222
|
-
| `./scripts/vault-balance-protection.sh` | Simulates "phantom withdrawal" attacks to verify vault safety. |
|
|
223
|
-
| `./scripts/nullifier-validation-test.sh` | Verifies the impossibility of double-spending. |
|
|
224
|
-
| `./scripts/test-emergency-procedures.sh` | Stress-tests the speed and effectiveness of the Atomic Rescue. |
|
|
225
|
-
| `./scripts/arithmetic-safety-test.sh` | Probes for overflows and field-element collisions. |
|
|
226
|
-
| `./scripts/rust-dependency-audit.sh` | Performs a deep audit of the cargo dependency tree for CVEs. |
|
|
120
|
+
// 1. Client Orchestration
|
|
121
|
+
const client = new SolVoidClient(config, wallet);
|
|
227
122
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
# Run unit tests for SDK and CLI
|
|
231
|
-
npm run test:unit
|
|
123
|
+
// 2. Surgical Shielding
|
|
124
|
+
const { commitmentData } = await client.shield(1.5 * LAMPORTS_PER_SOL);
|
|
232
125
|
|
|
233
|
-
|
|
234
|
-
|
|
126
|
+
// 3. Privacy Auditing
|
|
127
|
+
const passport = await client.getPassport(address);
|
|
128
|
+
console.log(`Ghost Score: ${passport.overallScore}/100`);
|
|
235
129
|
|
|
236
|
-
|
|
237
|
-
|
|
130
|
+
// 4. Low-level Proof Generation
|
|
131
|
+
const proof = await client.prepareWithdrawal(secret, nullifier, ...);
|
|
238
132
|
```
|
|
239
133
|
|
|
240
134
|
---
|
|
241
135
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
### Phase 1: Foundation (Current Status: ✅ COMPLETED)
|
|
245
|
-
- [x] Merkle Tree Core Logic (Depth 20)
|
|
246
|
-
- [x] Poseidon-3 Sponge Construction Hashing
|
|
247
|
-
- [x] Groth16 Proving Engine (Browser & Node)
|
|
248
|
-
- [x] Multi-platform SDK for dApp developers
|
|
249
|
-
|
|
250
|
-
### Phase 2: Visibility (Current Status: ✅ COMPLETED)
|
|
251
|
-
- [x] Privacy Ghost Scoring Diagnostics
|
|
252
|
-
- [x] Shadow Relayer Alpha Deployment
|
|
253
|
-
- [x] CLI Automation Tools & Binary Releases
|
|
254
|
-
- [x] ZK-Signed Privacy Badges
|
|
136
|
+
### 4. Shadow Relayer API Specification
|
|
137
|
+
Technical endpoints for the decentralized relay network.
|
|
255
138
|
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
139
|
+
| Endpoint | Method | Functional Requirement |
|
|
140
|
+
|:---|:---|:---|
|
|
141
|
+
| `/status` | `GET` | Health monitoring & protocol metrics |
|
|
142
|
+
| `/commitments` | `GET` | Multi-hop Merkle state synchronization |
|
|
143
|
+
| `/relay` | `POST` | `transaction` (base64) & `hops` (onion routing depth 1-5) |
|
|
261
144
|
|
|
262
145
|
---
|
|
263
146
|
|
|
264
|
-
##
|
|
265
|
-
|
|
266
|
-
```text
|
|
267
|
-
.
|
|
268
|
-
├── programs/ # Anchor-based Solana Smart Contracts (Rust)
|
|
269
|
-
├── circuits/ # Circom 2.1 source files & ZK Proving keys
|
|
270
|
-
├── sdk/ # TypeScript SDK for frontend & backend integration
|
|
271
|
-
├── cli/ # Source code for the solvoid-scan binary
|
|
272
|
-
├── relayer/ # Shadow Relayer Node source (Node.js/Express)
|
|
273
|
-
├── dashboard/ # Next.js 15 Web interface
|
|
274
|
-
├── scripts/ # Over 30+ production shell scripts for DevOps/Security
|
|
275
|
-
├── bin/ # Compiled CLI executables
|
|
276
|
-
└── docs/ # Technical Specifications & Manuals
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
---
|
|
147
|
+
## � Key Ecosystem Infrastructure
|
|
280
148
|
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
2. **Review** our [Contributing Guidelines][contributing].
|
|
287
|
-
3. **Submit** an issue using the provided templates.
|
|
288
|
-
4. **Open** a Pull Request against the `develop` branch.
|
|
149
|
+
* **Groth16 ZK-SNARKs**: High-performance proving implementation on the **BN254 curve**.
|
|
150
|
+
* **Poseidon-3 Hashing**: Standardized sponge construction for 100% parity across Rust, TS, and Circom.
|
|
151
|
+
* **Jito-MEV Integration**: Advanced front-running protection for critical asset rotations.
|
|
152
|
+
* **Data Integrity Enforcement (DIE)**: Zod-powered schema validation at every operational boundary.
|
|
153
|
+
* **Global Dashboard**: Institutional Next.js interface providing real-time technical telemetry.
|
|
289
154
|
|
|
290
155
|
---
|
|
291
156
|
|
|
292
|
-
##
|
|
157
|
+
## 📖 Project Documentation
|
|
293
158
|
|
|
294
|
-
-
|
|
295
|
-
-
|
|
296
|
-
-
|
|
297
|
-
- **Commitment**: The hash of (Secret + Nullifier + Amount), stored on-chain.
|
|
298
|
-
- **Circuit**: A specialized piece of logic that defines what the ZK proof proves.
|
|
159
|
+
- **Core:** [DOCS.md](DOCS.md) | [ZK_REFERENCE.md](ZK_REFERENCE.md) | [GHOST_REFERENCE.md](GHOST_REFERENCE.md)
|
|
160
|
+
- **Integration:** [SDK_REFERENCE.md](SDK_REFERENCE.md) | [CLI_REFERENCE.md](CLI_REFERENCE.md) | [API_REFERENCE.md](API_REFERENCE.md)
|
|
161
|
+
- **Ops:** [CICD_REFERENCE.md](CICD_REFERENCE.md) | [SYSTEM_STATUS.md](SYSTEM_STATUS.md) | [DEPLOYMENT.md](DEPLOYMENT.md)
|
|
299
162
|
|
|
300
163
|
---
|
|
301
164
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
</p>
|
|
306
|
-
|
|
307
|
-
<div align="center">
|
|
308
|
-
<a href="#-solvoid-protocol-the-enterprise-sovereign-privacy-layer"><b>↑ BACK TO TOP ↑</b></a>
|
|
309
|
-
</div>
|
|
165
|
+
## 🔒 Security Compliance
|
|
166
|
+
- **Status:** Experimental Beta
|
|
167
|
+
- **Policy:** Refer to [SECURITY.md](SECURITY.md) for disclosure protocols.
|
|
310
168
|
|
|
311
|
-
|
|
312
|
-
|
|
169
|
+
---
|
|
170
|
+
*Engineering-First. Privacy-Preserving. Solana-Native.*
|
package/SECURITY.md
CHANGED
|
@@ -1,39 +1,42 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Security Standards: Protocol Integrity & Disclosure
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Vulnerability Disclosure Policy
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The SolVoid project recognizes that protocol security is an ongoing engineering process. In the event of vulnerability identification, we prioritize responsible, coordinated disclosure to ensure the continuous protection of the collective anonymity set.
|
|
6
6
|
|
|
7
|
-
### Reporting
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
10
|
-
- **
|
|
7
|
+
### Reporting Methodology
|
|
8
|
+
- **Communication Channel:** [security@solvoid.io] (Contact registry placeholder).
|
|
9
|
+
- **Cryptographic Protection:** Encrypt all sensitive disclosures using the project's PGP identifier (Link placeholder).
|
|
10
|
+
- **Response Protocol:** The engineering team will acknowledge reports within 48 hours and establish a remediation timeline. We request that reporters maintain confidentiality until a verified patch has been deployed across the network.
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
-
##
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
14
|
+
## Technical Security Best Practices
|
|
15
|
+
|
|
16
|
+
1. **Primitive Sequestration:** The secret and nullifier keys constitute the sole access vectors for shielded liquidity. Execution of the protocol implies user responsibility for the secure, off-chain storage of these cryptographical primitives.
|
|
17
|
+
2. **Identity Decoupling:** To maintain maximum anonymity, withdrawal destination addresses should have zero historical on-chain linkage to the depositor's primary identity.
|
|
18
|
+
3. **Environment Verification:** Verify the integrity of the local build or ensure the use of the canonical `solvoid.io` interface to mitigate man-in-the-middle or phishing attacks.
|
|
19
|
+
4. **Gas Funding Risks:** When not utilizing the Shadow Relayer network, funding a fresh destination wallet with SOL gas may introduce timing-based or graph-based linkage vulnerabilities.
|
|
19
20
|
|
|
20
21
|
---
|
|
21
22
|
|
|
22
|
-
##
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
## Critical Security Considerations & Risk Factors
|
|
24
|
+
|
|
25
|
+
1. **Audit Status:** The current protocol implementation has **not** undergone a third-party security audit. Usage is restricted to experimental or testing environments.
|
|
26
|
+
2. **Proving Ceremony Requirements:** Proving keys currently in use are intended for development cycles. A production-grade Multi-Party Computation (MPC) ceremony is mandatory before Mainnet architectural finalization.
|
|
27
|
+
3. **Circuit Constraints:** Circom circuit constraints are undergoing continuous peer review and refinement to ensure comprehensive boundary coverage.
|
|
28
|
+
4. **Relayer Trust Model:** Relayer entities are restricted by ZK-bindings from asset theft, but retain the capacity for IP logging or localized Denial of Service (DoS).
|
|
27
29
|
|
|
28
30
|
---
|
|
29
31
|
|
|
30
|
-
##
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
| 0.
|
|
32
|
+
## Version Support Matrix
|
|
33
|
+
|
|
34
|
+
| Specification | Support Status | Maintenance Type |
|
|
35
|
+
|---------------|----------------|------------------|
|
|
36
|
+
| 0.2.x | Active | Feature/Security |
|
|
37
|
+
| 0.1.x | Deprecated | Critical Fixes |
|
|
35
38
|
|
|
36
39
|
---
|
|
37
40
|
|
|
38
|
-
##
|
|
39
|
-
We
|
|
41
|
+
## Bug Bounty Initiative
|
|
42
|
+
We operate a "Coordinated Vulnerability Research" program. Reports of critical vulnerabilities that adhere to disclosure requirements are prioritized for retroactive rewards as the protocol ecosystem matures.
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { Command } from 'commander';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Registry for the Privacy Ghost Score command suite.
|
|
4
|
+
* Provides visual privacy metrics and ZK-verified reputation artifacts.
|
|
5
5
|
*/
|
|
6
6
|
export declare function registerGhostCommand(program: Command): void;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Provides technical documentation for the ghost command module.
|
|
9
9
|
*/
|
|
10
10
|
export declare function getGhostCommandHelp(): string;
|
|
11
11
|
//# sourceMappingURL=ghost.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ghost.d.ts","sourceRoot":"","sources":["../../../cli/commands/ghost.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ghost.d.ts","sourceRoot":"","sources":["../../../cli/commands/ghost.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAQpC;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,QAsEpD;AAoED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CA2B5C"}
|