solvoid
v1.1.8
Published
SolVoid Privacy SDK - Zero-knowledge privacy for Solana
Maintainers
Readme
SolVoid TypeScript SDK: Institutional Privacy Integration
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.
🏛 Full Ecosystem Context
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:
🔗 github.com/brainless3178/SolVoid
🏛 Technical Architecture
SolVoid orchestrates a multi-layered privacy lifecycle (PLM) that decouples on-chain identities from their transaction history while maintaining full protocol verifiability.
Operational Data Flow
Note: The diagram above is provided as a static image so it renders consistently on npm and other markdown renderers that do not support Mermaid.
🚀 Key Ecosystem Infrastructure & Features
1. Advanced Zero-Knowledge Stack
- Groth16 Proving Pipeline: High-performance proving implementation on the BN254 curve.
- Poseidon-3 Hashing: Standardized sponge construction ensuring 100% hash parity across Circom (circuits), Rust (Anchor program), and TypeScript (SDK).
- 20-Level Merkle Tree: Optimized sparse tree supporting over 1.04M unique commitments per pool.
2. Specialized ZK Circuitry
withdraw.circom: Orchestrates nullifier verification, Merkle membership checks, and public signal binding.rescue.circom: A specialized emergency circuit for the Atomic Rescue Engine, enabling private migration of assets from compromised identities.
3. Privacy Ghost Score (Anonymity Auditing)
An integrated heuristic diagnostic engine that quantifies on-chain privacy risk (0-100).
- Leak Detection: Identifies identity linkage via common fee-funding sources, ATA creation history, and transaction-graph entropy.
- ZK-Verified Badges: Generate cryptographically verifiable reputation artifacts without revealing underlying data.
4. Shadow Relayer Network (Onion Routing)
A decentralized network for gasless, unlinkable withdrawals.
- RSA-OAEP Encryption: Protects withdrawal payloads using recursive encryption layers.
- Onion Routing: Decouples the destination address from the withdrawal request, preventing IP-based linkage or RPC-level tracking.
5. Atomic Rescue Engine (MEV Protection)
- Jito Integration: Leverages the Jito-Solana mev-bundle for sub-2s critical execution, protecting assets from front-running and sandwich attacks during emergency rotations.
📦 Installation
npm install solvoid🛠 SDK Integration Patterns
1. Client Initialization
import { SolVoidClient } from 'solvoid';
const config = {
rpcUrl: 'https://api.mainnet-beta.solana.com',
programId: 'Fg6PaFpoGXkYsidMpSsu3SWJYEHp7rQU9YSTFNDQ4F5i',
relayerUrl: 'https://relayer.solvoid.network'
};
const client = new SolVoidClient(config, walletAdapter);2. Executing a Private Deposit (Surgical Shielding)
const amountLamports = 1_000_000_000; // 1.0 SOL
const { commitmentData, status } = await client.shield(amountLamports);
console.log('Secret/Nullifier Primitives:', commitmentData.secret, commitmentData.nullifier);3. Executing an Unlinkable Withdrawal (ZK Proving)
const result = await client.prepareWithdrawal(
secret,
nullifier,
amountLamports,
recipientPubkey,
commitmentsBuffer, // Hex-encoded commitment set
wasmPath,
zkeyPath
);
// Submit via Shadow Relayer for gasless execution
const txid = await client.submitWithdrawal(result);4. Privacy Auditing (Ghost Score)
const passport = await client.getPassport(address);
console.log(`Current Ghost Score: ${passport.overallScore}/100`);
passport.recommendations.forEach(rec => console.log(`Audit Note: ${rec}`));🔒 Security & Performance
- Sub-second Latency: Optimized for Solana's 400ms block times.
- Browser-Side Proving: Execute Groth16 witness generation directly in the client environment via
snarkjs. - Data Integrity Enforcement (DIE): Zod-powered schema validation at every operational boundary (CLI, API, SDK).
🛠 Project Orchestration (CLI & Operations)
While this package focus on the SDK, the following tools are available in the main repository:
CLI Command Summary (solvoid)
solvoid shield <amount> # Surgical Shielding
solvoid withdraw <args> # Unlinkable Withdrawal
solvoid ghost <address> # Privacy Audit
solvoid rescue <wallet> # Atomic Remediation
solvoid admin pause/resume # Emergency Controls📄 Licensing
Distributed under the MIT License. SolVoid is an engineering-first initiative focused on digital sovereignty.
For the complete protocol documentation, circuits, and CLI, visit the Main Repository.
