@veilo/sdk-core 0.1.17 → 0.4.0

package/package.json

@@ -1,26 +1,112 @@
 {
   "name": "@veilo/sdk-core",
-  "version": "0.1.17",
-  "description": "Tiny TypeScript SDK for the `privacy-pool` Anchor program.",
-  "homepage": "https://github.com/ZKSOLDev/core-sdk#readme",
+  "version": "0.4.0",
+  "description": "TypeScript SDK for the Veilo Privacy Pool - UTXO-based privacy protocol on Solana with ZK-SNARKs",
+  "homepage": "https://github.com/VeiloSolana/veilo-sdk#readme",
   "bugs": {
-    "url": "https://github.com/ZKSOLDev/core-sdk/issues"
+    "url": "https://github.com/VeiloSolana/veilo-sdk/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ZKSOLDev/core-sdk.git"
+    "url": "git+https://github.com/VeiloSolana/veilo-sdk.git"
   },
   "license": "ISC",
-  "author": "",
+  "author": "Veilo <https://github.com/VeiloSolana>",
   "type": "commonjs",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./config": {
+      "import": {
+        "types": "./dist/esm/config.d.ts",
+        "default": "./dist/esm/config.js"
+      },
+      "require": {
+        "types": "./dist/cjs/config.d.ts",
+        "default": "./dist/cjs/config.js"
+      }
+    },
+    "./poseidon": {
+      "import": {
+        "types": "./dist/esm/poseidon.d.ts",
+        "default": "./dist/esm/poseidon.js"
+      },
+      "require": {
+        "types": "./dist/cjs/poseidon.d.ts",
+        "default": "./dist/cjs/poseidon.js"
+      }
+    },
+    "./proof": {
+      "import": {
+        "types": "./dist/esm/proof.d.ts",
+        "default": "./dist/esm/proof.js"
+      },
+      "require": {
+        "types": "./dist/cjs/proof.d.ts",
+        "default": "./dist/cjs/proof.js"
+      }
+    },
+    "./prover": {
+      "import": {
+        "types": "./dist/esm/prover.d.ts",
+        "default": "./dist/esm/prover.js"
+      },
+      "require": {
+        "types": "./dist/cjs/prover.d.ts",
+        "default": "./dist/cjs/prover.js"
+      }
+    },
+    "./shield": {
+      "import": {
+        "types": "./dist/esm/shield/index.d.ts",
+        "default": "./dist/esm/shield/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/shield/index.d.ts",
+        "default": "./dist/cjs/shield/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/",
+    "config.js",
+    "config.d.ts",
+    "poseidon.js",
+    "poseidon.d.ts",
+    "proof.js",
+    "proof.d.ts",
+    "prover.js",
+    "prover.d.ts",
+    "shield.js",
+    "shield.d.ts",
+    "README.md",
+    "SHIELD_INTEGRATION.md",
+    "LICENSE"
+  ],
   "directories": {
     "test": "tests"
   },
   "scripts": {
-    "build": "rm -rf dist/ && tsc -p tsconfig.json",
-    "test": "ANCHOR_PROVIDER_URL=http://127.0.0.1:8899 ANCHOR_WALLET=$HOME/.config/solana/id.json rm -rf dist/ && tsc -p test-tsconfig.json && mocha -t 1000000 \"dist/tests/**/*.js\""
+    "gen:idl": "node scripts/gen-idl.mjs",
+    "verify:cipher-parity": "npm run build && node scripts/verify-compact-cipher-parity.mjs",
+    "build": "rm -rf dist/ && tsc -p tsconfig.json && tsc -p tsconfig.esm.json && echo '{\"type\":\"module\"}' > dist/esm/package.json",
+    "test": "rm -rf dist/ && export ANCHOR_PROVIDER_URL=https://api.devnet.solana.com && export ANCHOR_WALLET=$HOME/.config/solana/id.json && tsc -p test-tsconfig.json && mocha -t 1000000 \"dist/tests/**/*.js\""
   },
   "dependencies": {
     "@coral-xyz/anchor": "^0.30.0",
@@ -28,12 +114,20 @@
     "@solana/spl-token": "^0.4.6",
     "@solana/web3.js": "^1.95.0",
     "circomlibjs": "^0.1.7",
-    "mocha": "^11.7.5",
     "tweetnacl": "^1.0.3"
   },
+  "peerDependencies": {
+    "snarkjs": ">=0.7.0"
+  },
+  "peerDependenciesMeta": {
+    "snarkjs": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/circomlibjs": "^0.1.6",
     "@types/mocha": "^10.0.10",
+    "mocha": "^11.7.5",
     "@types/node": "^24.10.1",
     "chai": "^6.2.1",
     "ts-node": "^10.9.2",

package/poseidon.d.ts

@@ -0,0 +1,2 @@
+// Stub for legacy resolvers — see poseidon.js
+export * from "./dist/cjs/poseidon.js";

package/poseidon.js

@@ -0,0 +1,4 @@
+// Stub for legacy resolvers (TypeScript moduleResolution: "node", older bundlers)
+// that ignore the "exports" map. Modern resolvers use "./poseidon" from package.json
+// exports and never reach this file.
+module.exports = require("./dist/cjs/poseidon.js");

package/proof.d.ts

@@ -0,0 +1,2 @@
+// Stub for legacy resolvers — see proof.js
+export * from "./dist/cjs/proof.js";

package/proof.js

@@ -0,0 +1,4 @@
+// Stub for legacy resolvers (TypeScript moduleResolution: "node", older bundlers)
+// that ignore the "exports" map. Modern resolvers use "./proof" from package.json
+// exports and never reach this file.
+module.exports = require("./dist/cjs/proof.js");

package/prover.d.ts

@@ -0,0 +1,2 @@
+// Stub for legacy resolvers — see prover.js
+export * from "./dist/cjs/prover.js";

package/prover.js

@@ -0,0 +1,4 @@
+// Stub for legacy resolvers (TypeScript moduleResolution: "node", older bundlers)
+// that ignore the "exports" map. Modern resolvers use "./prover" from package.json
+// exports and never reach this file.
+module.exports = require("./dist/cjs/prover.js");

package/shield.d.ts

@@ -0,0 +1,2 @@
+// Stub for legacy resolvers — see shield.js
+export * from "./dist/cjs/shield/index.js";

package/shield.js

@@ -0,0 +1,4 @@
+// Stub for legacy resolvers (TypeScript moduleResolution: "node", older bundlers)
+// that ignore the "exports" map. Modern resolvers use "./shield" from package.json
+// exports and never reach this file.
+module.exports = require("./dist/cjs/shield/index.js");

package/src/client.ts

@@ -1,352 +0,0 @@
-import * as anchor from "@coral-xyz/anchor";
-import { Program, BN, Idl } from "@coral-xyz/anchor";
-import { PublicKey, SystemProgram, Keypair } from "@solana/web3.js";
-
-import {
-  ProofBuilder,
-  WithdrawCircuitInputs,
-  WithdrawProofStruct,
-  deriveNullifier,
-  encodeSnarkjsProofToWithdrawProof,
-} from "./proof";
-
-import {
-  createNoteWithCommitment,
-  EncryptedNotePlaintext,
-  encryptNote,
-  SerializedNote,
-} from "./note";
-
-import { MerklePath, MerkleTree } from "./merkle";
-import { randomBytes } from "crypto";
-
-// -----------------------------------------------------------------------------
-// Types
-// -----------------------------------------------------------------------------
-
-export type NoteAndMerkleData = {
-  note: SerializedNote;
-  leafIndex: number;
-  root: Uint8Array;
-  merklePath: MerklePath;
-};
-
-// -----------------------------------------------------------------------------
-// High-level deposit helper (off-chain Merkle is just for zk / demos)
-// -----------------------------------------------------------------------------
-
-/**
- * High-level helper:
- *  - Creates a random note + commitment
- *  - Inserts the commitment into an *off-chain* Merkle tree (your zk tree)
- *  - Calls on-chain `depositFixed` with the commitment
- *  - Returns note + index + Merkle path (+ off-chain root)
- *
- * The on-chain program *also* keeps its own rolling 32-byte root, but that is
- * intentionally minimal and independent from this off-chain tree. For a real
- * zk circuit you’d want both to share the same hash function.
- */
-export async function createNoteDepositWithMerkle<T extends Idl>(params: {
-  program: Program<T>;
-  depositor: anchor.Wallet;
-  denomIndex: number;
-  valueLamports: bigint;
-  tree: MerkleTree;
-}): Promise<NoteAndMerkleData> {
-  const { program, depositor, denomIndex, valueLamports, tree } = params;
-
-  const note = createNoteWithCommitment({
-    value: valueLamports,
-    owner: depositor.publicKey,
-  });
-
-  // Maintain your off-chain mirror (for proofs)
-  const { index, root } = tree.insert(note.commitment);
-  const merklePath = tree.getPath(index);
-
-  // Call low-level deposit with just the commitment
-  await depositFixedSol({
-    program,
-    depositor,
-    denomIndex,
-    commitment: note.commitment,
-    note,
-  });
-
-  return {
-    note,
-    leafIndex: index,
-    root,
-    merklePath,
-  };
-}
-
-// -----------------------------------------------------------------------------
-// PDA helpers (v3 seeds)
-// -----------------------------------------------------------------------------
-
-export function getPoolPdas(programId: PublicKey, commitmentSeed?: Uint8Array) {
-  const [config] = PublicKey.findProgramAddressSync(
-    [Buffer.from("privacy_config_v3")],
-    programId
-  );
-  const [vault] = PublicKey.findProgramAddressSync(
-    [Buffer.from("privacy_vault_v3")],
-    programId
-  );
-  const [noteTree] = PublicKey.findProgramAddressSync(
-    [Buffer.from("privacy_note_tree_v3")],
-    programId
-  );
-  const [nullifiers] = PublicKey.findProgramAddressSync(
-    [Buffer.from("privacy_nullifiers_v3")],
-    programId
-  );
-
-  const [noteHint] = PublicKey.findProgramAddressSync(
-    [Buffer.from("privacy_note_hint_v3"), commitmentSeed ?? Buffer.alloc(0)],
-    programId
-  );
-
-  return { config, vault, noteTree, nullifiers, noteHint };
-}
-
-// -----------------------------------------------------------------------------
-// Pool initialization
-// -----------------------------------------------------------------------------
-
-export async function initializePool<T extends Idl>(params: {
-  program: Program<T>;
-  admin: anchor.Wallet;
-  denomsLamports: (bigint | number)[];
-  feeBps: number; // 0–10000
-}) {
-  const { program, admin, denomsLamports, feeBps } = params;
-  const { config, vault, noteTree, nullifiers } = getPoolPdas(
-    program.programId
-  );
-
-  await (program.methods as any)
-    .initialize(
-      denomsLamports.map((d) => new BN(d.toString())),
-      feeBps
-    )
-    .accounts({
-      config,
-      vault,
-      noteTree,
-      nullifiers,
-      admin: admin.publicKey,
-      systemProgram: SystemProgram.programId,
-    } as any)
-    .rpc();
-}
-
-// -----------------------------------------------------------------------------
-// Deposit helpers
-// -----------------------------------------------------------------------------
-
-export type DepositNoteResult = {
-  commitment: Uint8Array; // 32 bytes
-};
-
-/**
- * Low-level deposit helper.
- * Expects a 32-byte commitment; on-chain NoteTree keeps a rolling 32-byte root.
- */
-export async function depositFixedSol<T extends Idl>(params: {
-  program: Program<T>;
-  depositor: anchor.Wallet;
-  denomIndex: number;
-  commitment: Uint8Array; // 32
-  note: SerializedNote;
-}) {
-  const { program, depositor, denomIndex, commitment, note } = params;
-  const { config, vault, noteTree, noteHint } = getPoolPdas(
-    program.programId,
-    commitment
-  );
-
-  if (commitment.length !== 32) {
-    throw new Error("commitment must be 32 bytes");
-  }
-
-  const notePlain: EncryptedNotePlaintext = {
-    secret: randomBytes(32),
-    nullifier: deriveNullifier(note),
-    denomIndex: 0,
-  };
-
-  const sharedKey = randomBytes(32); // derive from recipient pubkey in real wallet
-  const encryptedNote = encryptNote(notePlain, sharedKey);
-
-  await (program.methods as any)
-    .depositFixed(
-      denomIndex,
-      Array.from(commitment) // [u8;32]
-    )
-    .accounts({
-      config,
-      vault,
-      noteTree,
-      noteHint,
-      depositor: depositor.publicKey,
-      systemProgram: SystemProgram.programId,
-    } as any)
-    .rpc();
-}
-
-/**
- * Convenience: build a random Note off-chain, commit it, and call deposit.
- */
-export async function createNoteAndDeposit<T extends Idl>(params: {
-  program: Program<T>;
-  depositor: anchor.Wallet;
-  denomIndex: number;
-  valueLamports: bigint;
-}) {
-  const { program, depositor, denomIndex, valueLamports } = params;
-
-  const note = createNoteWithCommitment({
-    value: valueLamports,
-    owner: depositor.publicKey,
-  });
-
-  await depositFixedSol({
-    program,
-    depositor,
-    denomIndex,
-    commitment: note.commitment,
-    note,
-  });
-
-  return note;
-}
-
-// -----------------------------------------------------------------------------
-// Relayers & Withdrawals
-// -----------------------------------------------------------------------------
-
-export async function addRelayer<T extends Idl>(params: {
-  program: Program<T>;
-  admin: anchor.Wallet;
-  newRelayer: PublicKey;
-}) {
-  const { program, admin, newRelayer } = params;
-  const { config } = getPoolPdas(program.programId);
-
-  await (program.methods as any)
-    .addRelayer(newRelayer)
-    .accounts({
-      config,
-      admin: admin.publicKey,
-    } as any)
-    .rpc();
-}
-
-/**
- * Low-level withdraw:
- *  - Expects the **already packed** WithdrawProofStruct
- *    (matching Rust `WithdrawProof` fields).
- */
-export async function withdrawViaRelayer<T extends Idl>(params: {
-  program: Program<T>;
-  relayer: Keypair;
-  recipient: PublicKey;
-  denomIndex: number;
-  root: Uint8Array; // 32 bytes
-  nullifier: Uint8Array; // 32 bytes
-  proof: WithdrawProofStruct;
-}) {
-  const { program, relayer, recipient, denomIndex, root, nullifier, proof } =
-    params;
-  const { config, vault, noteTree, nullifiers } = getPoolPdas(
-    program.programId
-  );
-
-  if (root.length !== 32) throw new Error("root must be 32 bytes");
-  if (nullifier.length !== 32) throw new Error("nullifier must be 32 bytes");
-
-  await (program.methods as any)
-    .withdraw(
-      Array.from(root),
-      Array.from(nullifier),
-      denomIndex,
-      recipient,
-      proof // <- Anchor / IDL maps this to WithdrawProof { proof_a, proof_b, proof_c }
-    )
-    .accounts({
-      config,
-      vault,
-      noteTree,
-      nullifiers,
-      relayer: relayer.publicKey,
-      recipient,
-      systemProgram: SystemProgram.programId,
-    } as any)
-    .signers([relayer])
-    .rpc();
-}
-
-/**
- * High-level withdraw:
- *  - Takes note + Merkle path + denom + fee info
- *  - Uses a pluggable ProofBuilder (snarkjs.groth16) to create a RawProof
- *  - Encodes RawProof into WithdrawProofStruct
- *  - Calls the low-level withdrawViaRelayer
- *
- * In production, you'd typically call a relayer HTTP API instead, and let it
- * build/verify the proof server-side. But this is handy for tools / tests.
- */
-export async function withdrawViaRelayerWithProof<T extends Idl>(params: {
-  program: Program<T>;
-  relayer: Keypair;
-  recipient: PublicKey;
-  denomIndex: number;
-  feeBps: number;
-  root: Uint8Array;
-  nullifier: Uint8Array;
-  noteData: SerializedNote;
-  merklePath: MerklePath;
-  builder: ProofBuilder; // must produce a valid snarkjs Groth16 proof
-}) {
-  const {
-    program,
-    relayer,
-    recipient,
-    denomIndex,
-    feeBps,
-    root,
-    nullifier,
-    noteData,
-    merklePath,
-    builder,
-  } = params;
-
-  const inputs: WithdrawCircuitInputs = {
-    root,
-    note: noteData,
-    merklePath,
-    nullifier,
-    denomIndex,
-    recipient,
-    relayer: relayer.publicKey,
-    feeBps,
-  };
-
-  // Build snarkjs proof off-chain
-  const rawProof = await builder(inputs);
-
-  // Pack into the struct expected by the on-chain Rust program
-  const withdrawProof = encodeSnarkjsProofToWithdrawProof(rawProof);
-
-  await withdrawViaRelayer({
-    program,
-    relayer,
-    recipient,
-    denomIndex,
-    root,
-    nullifier,
-    proof: withdrawProof,
-  });
-}

package/src/config.ts

@@ -1,13 +0,0 @@
-// config.ts
-import { LAMPORTS_PER_SOL } from "@solana/web3.js";
-
-export const DEFAULT_FEE_BPS = 50; // 0.5%
-
-export function sol(n: number): bigint {
-	return BigInt(n) * BigInt(LAMPORTS_PER_SOL);
-}
-
-export type PoolInitConfig = {
-	denomsSol: number[]; // [1, 5] etc
-	feeBps?: number;
-};

package/src/index.ts

@@ -1,6 +0,0 @@
-export * from "./client";
-export * from "./note";
-export * from "./config";
-export * from "./merkle";
-export * from "./proof";
-export { initPoseidon } from "./poseidon";