zkenclave-sdk 0.1.0 → 0.1.5

package/README.md

@@ -0,0 +1,91 @@
+# zkenclave-sdk
+
+Privacy-preserving vault SDK for Zero-Knowledge withdrawals on EVM chains.
+
+## Installation
+
+```bash
+npm install zkenclave-sdk
+```
+
+## Quick Start
+
+```typescript
+import { PrivacyVaultSDK, ZKProofClient } from "zkenclave-sdk";
+
+const sdk = new PrivacyVaultSDK(
+  {
+    vaultAddress: "0x68F19280d3030eaE36B8Da42621B66e92a8AEA32",
+    zkVerifierAddress: "0x68491614a84C0410E9Fc0CB59Fc60A4F9188687c",
+    aspRegistryAddress: "0xB041Cff58FB866c7f4326e0767c97B93434aBa9E",
+    chainId: 845320009,
+    rpcUrl: "https://horizen-rpc-testnet.appchain.base.org",
+  },
+  signer
+);
+
+// Deposit
+const { note, txHash, leafIndex } = await sdk.deposit(parseEther("0.1"));
+
+// Withdraw
+const result = await sdk.withdraw(note, recipientAddress);
+```
+
+## Features
+
+- **Privacy-preserving deposits** - Commitment-nullifier scheme
+- **ZK proof generation** - Client-side via `ZKProofClient`
+- **Multi-chain support** - Configurable RPC/chain
+- **TypeScript** - Full type definitions
+
+## API
+
+### `PrivacyVaultSDK`
+
+| Method                       | Description               |
+| ---------------------------- | ------------------------- |
+| `deposit(amount)`            | Deposit ETH, returns note |
+| `withdraw(note, recipient)`  | Withdraw using note       |
+| `getLatestRoot()`            | Get current Merkle root   |
+| `getNextLeafIndex()`         | Get next deposit index    |
+| `isNullifierUsed(nullifier)` | Check if nullifier spent  |
+
+### `ZKProofClient`
+
+| Method                                      | Description               |
+| ------------------------------------------- | ------------------------- |
+| `generateWithdrawalProof(request)`          | Generate ZK proof         |
+| `generateComplianceProof(commitment, root)` | Generate compliance proof |
+
+## Types
+
+```typescript
+interface VaultConfig {
+  vaultAddress: string;
+  zkVerifierAddress: string;
+  aspRegistryAddress: string;
+  chainId: number;
+  rpcUrl: string;
+}
+
+interface DepositNote {
+  commitment: Uint8Array;
+  secret: Uint8Array;
+  nullifierSeed: Uint8Array;
+  amount: bigint;
+  leafIndex: number;
+  timestamp: number;
+}
+```
+
+## Deployed Contracts (Horizen Sepolia)
+
+| Contract     | Address                                      |
+| ------------ | -------------------------------------------- |
+| PrivacyVault | `0x68F19280d3030eaE36B8Da42621B66e92a8AEA32` |
+| ZKVerifier   | `0x68491614a84C0410E9Fc0CB59Fc60A4F9188687c` |
+| ASPRegistry  | `0xB041Cff58FB866c7f4326e0767c97B93434aBa9E` |
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -85,6 +85,7 @@ declare class PrivacyVaultSDK {
     private provider;
     private signer;
     private vault;
+    private readVault;
     private _aspRegistry;
     private zkClient;
     private config;

package/dist/index.d.ts

@@ -85,6 +85,7 @@ declare class PrivacyVaultSDK {
     private provider;
     private signer;
     private vault;
+    private readVault;
     private _aspRegistry;
     private zkClient;
     private config;

package/dist/index.js

@@ -482,6 +482,7 @@ var PrivacyVaultSDK = class {
   provider;
   signer = null;
   vault;
+  readVault;
   _aspRegistry;
   zkClient;
   config;
@@ -497,6 +498,11 @@ var PrivacyVaultSDK = class {
       PRIVACY_VAULT_ABI,
       this.signer ?? this.provider
     );
+    this.readVault = new import_ethers3.ethers.Contract(
+      config.vaultAddress,
+      PRIVACY_VAULT_ABI,
+      this.provider
+    );
     this._aspRegistry = new import_ethers3.ethers.Contract(
       config.aspRegistryAddress,
       ASP_REGISTRY_ABI,
@@ -589,15 +595,15 @@ var PrivacyVaultSDK = class {
     };
   }
   async getLatestRoot() {
-    const root = await this.vault.getLatestRoot();
+    const root = await this.readVault.getLatestRoot();
     return hexToBytes(root);
   }
   async getNextLeafIndex() {
-    const index = await this.vault.getNextLeafIndex();
+    const index = await this.readVault.getNextLeafIndex();
     return Number(index);
   }
   async isNullifierUsed(nullifier) {
-    return await this.vault.isNullifierUsed(bytesToHex(nullifier));
+    return await this.readVault.isNullifierUsed(bytesToHex(nullifier));
   }
   async isKnownRoot(root) {
     return await this.vault.isKnownRoot(bytesToHex(root));

package/dist/index.mjs

@@ -428,6 +428,7 @@ var PrivacyVaultSDK = class {
   provider;
   signer = null;
   vault;
+  readVault;
   _aspRegistry;
   zkClient;
   config;
@@ -443,6 +444,11 @@ var PrivacyVaultSDK = class {
       PRIVACY_VAULT_ABI,
       this.signer ?? this.provider
     );
+    this.readVault = new ethers.Contract(
+      config.vaultAddress,
+      PRIVACY_VAULT_ABI,
+      this.provider
+    );
     this._aspRegistry = new ethers.Contract(
       config.aspRegistryAddress,
       ASP_REGISTRY_ABI,
@@ -535,15 +541,15 @@ var PrivacyVaultSDK = class {
     };
   }
   async getLatestRoot() {
-    const root = await this.vault.getLatestRoot();
+    const root = await this.readVault.getLatestRoot();
     return hexToBytes(root);
   }
   async getNextLeafIndex() {
-    const index = await this.vault.getNextLeafIndex();
+    const index = await this.readVault.getNextLeafIndex();
     return Number(index);
   }
   async isNullifierUsed(nullifier) {
-    return await this.vault.isNullifierUsed(bytesToHex(nullifier));
+    return await this.readVault.isNullifierUsed(bytesToHex(nullifier));
   }
   async isKnownRoot(root) {
     return await this.vault.isKnownRoot(bytesToHex(root));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zkenclave-sdk",
-  "version": "0.1.0",
+  "version": "0.1.5",
   "description": "TypeScript SDK for privacy-preserving vault withdrawals with ZK proofs",
   "main": "dist/index.js",
   "module": "dist/index.mjs",