@veil-cash/sdk 0.6.2 → 0.6.4

package/dist/index.js

@@ -1,21 +1,15 @@
 import { ethers } from 'ethers';
+import { Buffer } from 'buffer';
 import { privateKeyToAccount, privateKeyToAddress } from 'viem/accounts';
-import * as crypto from 'crypto';
+import ethSigUtil from 'eth-sig-util';
+import circomlib from 'circomlib';
 import { encodeFunctionData, parseEther, parseUnits, createPublicClient, http, formatUnits, keccak256, encodePacked, isAddress, formatEther } from 'viem';
 import { base } from 'viem/chains';
 import MerkleTree from 'fixed-merkle-tree-legacy';
 import { groth16 } from 'snarkjs';
-import * as path from 'path';
-import * as fs from 'fs';
-import { fileURLToPath } from 'url';
+import { utils } from 'ffjavascript';
 
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-var circomlib = __require("circomlib");
+// src/keypair.ts
 var poseidon = circomlib.poseidon;
 var FIELD_SIZE = BigInt(
   "21888242871839275222246405745257275088548364400416034343698204186575808495617"
@@ -23,7 +17,11 @@ var FIELD_SIZE = BigInt(
 var poseidonHash = (items) => BigInt(poseidon(items).toString());
 var poseidonHash2 = (a, b) => poseidonHash([a, b]);
 var randomBN = (nbytes = 31) => {
-  const bytes = crypto.randomBytes(nbytes);
+  const cryptoApi = globalThis.crypto;
+  if (!cryptoApi?.getRandomValues) {
+    throw new Error("Secure random number generation is unavailable in this runtime");
+  }
+  const bytes = cryptoApi.getRandomValues(new Uint8Array(nbytes));
   let hex = "0x";
   for (let i = 0; i < bytes.length; i++) {
     hex += bytes[i].toString(16).padStart(2, "0");
@@ -50,8 +48,7 @@ var toBuffer = (value, length) => {
   return Buffer.from(hex, "hex");
 };
 function getExtDataHash(extData) {
-  const { ethers: ethers2 } = __require("ethers");
-  const abi = ethers2.AbiCoder.defaultAbiCoder();
+  const abi = ethers.AbiCoder.defaultAbiCoder();
   const encodedData = abi.encode(
     ["tuple(address,int256,address,uint256,bytes,bytes)"],
     [[
@@ -63,7 +60,7 @@ function getExtDataHash(extData) {
       extData.encryptedOutput2
     ]]
   );
-  const hash = ethers2.keccak256(encodedData);
+  const hash = ethers.keccak256(encodedData);
   return BigInt(hash) % FIELD_SIZE;
 }
 function shuffle(array) {
@@ -79,7 +76,6 @@ function shuffle(array) {
 
 // src/keypair.ts
 var VEIL_SIGNED_MESSAGE = "Sign this message to create your Veil Wallet private key. This will be used to decrypt your balances. Ensure you are signing this message on the Veil Cash website.";
-var ethSigUtil = __require("eth-sig-util");
 function packEncryptedMessage(encryptedMessage) {
   const nonceBuf = Buffer.from(encryptedMessage.nonce, "base64");
   const ephemPublicKeyBuf = Buffer.from(encryptedMessage.ephemPublicKey, "base64");
@@ -262,8 +258,6 @@ var Keypair = class _Keypair {
     );
   }
 };
-
-// src/utxo.ts
 var Utxo = class _Utxo {
   amount;
   blinding;
@@ -597,6 +591,14 @@ var QUEUE_ABI = [
     outputs: [{ name: "count", type: "uint256" }],
     stateMutability: "view",
     type: "function"
+  },
+  // Get remaining daily free deposits for an address (V3+)
+  {
+    inputs: [{ name: "_depositor", type: "address" }],
+    name: "getDailyFreeRemaining",
+    outputs: [{ name: "remaining", type: "uint256" }],
+    stateMutability: "view",
+    type: "function"
   }
 ];
 var POOL_ABI = [
@@ -1314,6 +1316,25 @@ async function getQueueBalance(options) {
     pendingCount: pendingDeposits.length
   };
 }
+async function getDailyFreeRemaining(options) {
+  const { address, pool = "eth", rpcUrl } = options;
+  const queueAddress = getQueueAddress(pool);
+  const publicClient = createPublicClient({
+    chain: base,
+    transport: http(rpcUrl)
+  });
+  try {
+    const remaining = await publicClient.readContract({
+      address: queueAddress,
+      abi: QUEUE_ABI,
+      functionName: "getDailyFreeRemaining",
+      args: [address]
+    });
+    return Number(remaining);
+  } catch {
+    return 0;
+  }
+}
 async function getPrivateBalance(options) {
   const { keypair, pool = "eth", rpcUrl, onProgress } = options;
   const poolAddress = getPoolAddress(pool);
@@ -1429,21 +1450,37 @@ function getMerklePath(tree, commitment) {
     pathIndices: index
   };
 }
-var utils = null;
-try {
-  const ffjavascript = __require("ffjavascript");
-  utils = ffjavascript.utils;
-} catch {
-  console.warn("ffjavascript not found. Proof generation may not work.");
+var ffUtils = utils;
+function isBrowserRuntime() {
+  return !(typeof process !== "undefined" && !!process.versions?.node);
 }
-function findKeysDirectory() {
+function stripTrailingSlash(value) {
+  return value.endsWith("/") ? value.slice(0, -1) : value;
+}
+function normalizeCircuitBasePath(provingKeyPath, circuitName) {
+  const resolvedPath = typeof provingKeyPath === "function" ? provingKeyPath(circuitName) : provingKeyPath;
+  const withoutExtension = resolvedPath.replace(/\.(wasm|zkey)$/i, "");
+  if (withoutExtension.endsWith(`/${circuitName}`) || withoutExtension.endsWith(`\\${circuitName}`)) {
+    return withoutExtension;
+  }
+  return `${stripTrailingSlash(withoutExtension)}/${circuitName}`;
+}
+function importNodeModule(specifier) {
+  const dynamicImport = new Function("specifier", "return import(specifier)");
+  return dynamicImport(specifier);
+}
+async function findNodeKeysDirectory() {
+  const [{ existsSync }, pathModule, { fileURLToPath }] = await Promise.all([
+    importNodeModule("node:fs"),
+    importNodeModule("node:path"),
+    importNodeModule("node:url")
+  ]);
+  const path = pathModule;
   const possiblePaths = [
     // When running from package (installed via npm)
-    path.resolve(__dirname, "..", "keys"),
-    path.resolve(__dirname, "..", "..", "keys"),
+    path.resolve(process.cwd(), "node_modules", "@veil-cash", "sdk", "keys"),
     // When running from source
     path.resolve(process.cwd(), "keys")
-    // ESM module path
   ];
   try {
     const currentFilePath = fileURLToPath(import.meta.url);
@@ -1452,7 +1489,7 @@ function findKeysDirectory() {
   } catch {
   }
   for (const p of possiblePaths) {
-    if (fs.existsSync(p) && fs.existsSync(path.join(p, "transaction2.wasm"))) {
+    if (existsSync(p) && existsSync(path.join(p, "transaction2.wasm"))) {
       return p;
     }
   }
@@ -1460,26 +1497,48 @@ function findKeysDirectory() {
     "Circuit keys not found. Expected to find keys/ directory with transaction2.wasm and transaction2.zkey files."
   );
 }
-async function prove(input, circuitName) {
-  if (!utils) {
-    throw new Error("ffjavascript is required for proof generation. Please install it: npm install ffjavascript");
+async function resolveProvingKeyPaths(circuitName, provingKeyPath) {
+  if (provingKeyPath) {
+    const circuitBasePath = normalizeCircuitBasePath(provingKeyPath, circuitName);
+    return {
+      wasmPath: `${circuitBasePath}.wasm`,
+      zkeyPath: `${circuitBasePath}.zkey`
+    };
+  }
+  if (isBrowserRuntime()) {
+    return {
+      wasmPath: `/keys/${circuitName}.wasm`,
+      zkeyPath: `/keys/${circuitName}.zkey`
+    };
+  }
+  const keysDir = await findNodeKeysDirectory();
+  return {
+    wasmPath: `${keysDir}/${circuitName}.wasm`,
+    zkeyPath: `${keysDir}/${circuitName}.zkey`
+  };
+}
+async function assertNodeKeyFilesExist(wasmPath, zkeyPath) {
+  if (isBrowserRuntime() || wasmPath.startsWith("http://") || wasmPath.startsWith("https://")) {
+    return;
   }
-  const keysDir = findKeysDirectory();
-  const wasmPath = path.join(keysDir, `${circuitName}.wasm`);
-  const zkeyPath = path.join(keysDir, `${circuitName}.zkey`);
-  if (!fs.existsSync(wasmPath)) {
+  const { existsSync } = await importNodeModule("node:fs");
+  if (!existsSync(wasmPath)) {
     throw new Error(`Circuit WASM file not found: ${wasmPath}`);
   }
-  if (!fs.existsSync(zkeyPath)) {
+  if (!existsSync(zkeyPath)) {
     throw new Error(`Circuit zkey file not found: ${zkeyPath}`);
   }
+}
+async function prove(input, circuitName, options = {}) {
+  const { wasmPath, zkeyPath } = await resolveProvingKeyPaths(circuitName, options.provingKeyPath);
+  await assertNodeKeyFilesExist(wasmPath, zkeyPath);
   const result = await groth16.fullProve(
-    utils.stringifyBigInts(input),
+    ffUtils.stringifyBigInts(input),
     wasmPath,
     zkeyPath,
     void 0,
     void 0,
-    { singleThread: true }
+    { singleThread: options.singleThread ?? true }
   );
   const proof = result.proof;
   return "0x" + toFixedHex(proof.pi_a[0]).slice(2) + toFixedHex(proof.pi_a[1]).slice(2) + toFixedHex(proof.pi_b[0][1]).slice(2) + toFixedHex(proof.pi_b[0][0]).slice(2) + toFixedHex(proof.pi_b[1][1]).slice(2) + toFixedHex(proof.pi_b[1][0]).slice(2) + toFixedHex(proof.pi_c[0]).slice(2) + toFixedHex(proof.pi_c[1]).slice(2);
@@ -1507,7 +1566,8 @@ async function getProof({
   fee,
   recipient,
   relayer,
-  onProgress
+  onProgress,
+  provingKeyPath
 }) {
   inputs = shuffle([...inputs]);
   outputs = shuffle([...outputs]);
@@ -1567,7 +1627,7 @@ async function getProof({
   };
   onProgress?.("Generating ZK proof...", `${inputs.length} inputs`);
   const circuitName = selectCircuit(inputs.length);
-  const proof = await prove(proofInput, circuitName);
+  const proof = await prove(proofInput, circuitName, { provingKeyPath });
   const args = {
     proof,
     root: toFixedHex(proofInput.root),
@@ -1589,7 +1649,8 @@ async function prepareTransaction({
   fee = 0,
   recipient = 0,
   relayer = 0,
-  onProgress
+  onProgress,
+  provingKeyPath
 }) {
   if (inputs.length > 16 || outputs.length > 2) {
     throw new Error("Incorrect inputs/outputs count. Maximum: 16 inputs, 2 outputs.");
@@ -1611,7 +1672,8 @@ async function prepareTransaction({
     fee: BigInt(fee),
     recipient: String(recipient),
     relayer: String(relayer),
-    onProgress
+    onProgress,
+    provingKeyPath
   });
   return result;
 }
@@ -1769,6 +1831,7 @@ async function buildWithdrawProof(options) {
     keypair,
     pool = "eth",
     rpcUrl,
+    provingKeyPath,
     onProgress
   } = options;
   const poolConfig = POOL_CONFIG[pool];
@@ -1832,7 +1895,8 @@ async function buildWithdrawProof(options) {
     fee: 0,
     recipient,
     relayer: "0x0000000000000000000000000000000000000000",
-    onProgress
+    onProgress,
+    provingKeyPath
   });
   return {
     proofArgs: {
@@ -1929,6 +1993,7 @@ async function buildTransferProof(options) {
     senderKeypair,
     pool = "eth",
     rpcUrl,
+    provingKeyPath,
     onProgress
   } = options;
   const poolConfig = POOL_CONFIG[pool];
@@ -2007,7 +2072,8 @@ async function buildTransferProof(options) {
     fee: 0,
     recipient: "0x0000000000000000000000000000000000000000",
     relayer: "0x0000000000000000000000000000000000000000",
-    onProgress
+    onProgress,
+    provingKeyPath
   });
   return {
     proofArgs: {
@@ -2049,7 +2115,7 @@ async function transfer(options) {
   };
 }
 async function mergeUtxos(options) {
-  const { amount, keypair, pool = "eth", rpcUrl, onProgress } = options;
+  const { amount, keypair, pool = "eth", rpcUrl, provingKeyPath, onProgress } = options;
   const poolConfig = POOL_CONFIG[pool];
   const poolAddress = getPoolAddress(pool);
   onProgress?.("Fetching your UTXOs...");
@@ -2117,7 +2183,8 @@ async function mergeUtxos(options) {
     fee: 0,
     recipient: "0x0000000000000000000000000000000000000000",
     relayer: "0x0000000000000000000000000000000000000000",
-    onProgress
+    onProgress,
+    provingKeyPath
   });
   onProgress?.("Submitting to relay...");
   const relayResult = await submitRelay({
@@ -2529,6 +2596,7 @@ async function mergeSubaccount(options) {
     pool = "eth",
     rpcUrl,
     relayUrl,
+    provingKeyPath,
     onProgress
   } = options;
   const normalizedSlot = normalizeSlot(slot);
@@ -2621,7 +2689,8 @@ async function mergeSubaccount(options) {
     fee: 0,
     recipient: "0x0000000000000000000000000000000000000000",
     relayer: "0x0000000000000000000000000000000000000000",
-    onProgress
+    onProgress,
+    provingKeyPath
   });
   onProgress?.("Submitting to relay...");
   const relayResult = await submitRelay({
@@ -2654,6 +2723,6 @@ async function mergeSubaccount(options) {
   };
 }
 
-export { ADDRESSES, CIRCUIT_CONFIG, ENTRY_ABI, ERC20_ABI, FIELD_SIZE, FORWARDER_ABI, FORWARDER_CONTRACT_VERSION, FORWARDER_FACTORY_ABI, Keypair, MAX_SUBACCOUNT_SLOTS, MERKLE_TREE_HEIGHT, POOL_ABI, POOL_CONFIG, QUEUE_ABI, RelayError, Utxo, VEIL_SIGNED_MESSAGE, buildApproveUSDCTx, buildChangeDepositKeyTx, buildDepositETHTx, buildDepositTx, buildDepositUSDCTx, buildMerkleTree, buildRegisterTx, buildSubaccountRecoveryTx, buildSubaccountWithdrawTypedData, buildTransferProof, buildWithdrawProof, checkRecipientRegistration, checkRelayHealth, deploySubaccountForwarder, deriveSubaccountChildDepositKey, deriveSubaccountChildOwner, deriveSubaccountChildPrivateKey, deriveSubaccountSalt, deriveSubaccountSlot, findNextSubaccountWithdrawNonce, getAddresses, getExtDataHash, getForwarderFactoryAddress, getMerklePath, getPoolAddress, getPrivateBalance, getQueueAddress, getQueueBalance, getRelayInfo, getRelayUrl, getSubaccountPrivateBalance, getSubaccountStatus, isSubaccountForwarderDeployed, isSubaccountWithdrawNonceUsed, mergeSubaccount, mergeUtxos, packEncryptedMessage, poseidonHash, poseidonHash2, predictSubaccountForwarder, prepareTransaction, prove, randomBN, selectCircuit, selectUtxosForWithdraw, shuffle, signSubaccountWithdraw, submitRelay, sweepSubaccountForwarder, toBuffer, toFixedHex, transfer, unpackEncryptedMessage, withdraw };
+export { ADDRESSES, CIRCUIT_CONFIG, ENTRY_ABI, ERC20_ABI, FIELD_SIZE, FORWARDER_ABI, FORWARDER_CONTRACT_VERSION, FORWARDER_FACTORY_ABI, Keypair, MAX_SUBACCOUNT_SLOTS, MERKLE_TREE_HEIGHT, POOL_ABI, POOL_CONFIG, QUEUE_ABI, RelayError, Utxo, VEIL_SIGNED_MESSAGE, buildApproveUSDCTx, buildChangeDepositKeyTx, buildDepositETHTx, buildDepositTx, buildDepositUSDCTx, buildMerkleTree, buildRegisterTx, buildSubaccountRecoveryTx, buildSubaccountWithdrawTypedData, buildTransferProof, buildWithdrawProof, checkRecipientRegistration, checkRelayHealth, deploySubaccountForwarder, deriveSubaccountChildDepositKey, deriveSubaccountChildOwner, deriveSubaccountChildPrivateKey, deriveSubaccountSalt, deriveSubaccountSlot, findNextSubaccountWithdrawNonce, getAddresses, getDailyFreeRemaining, getExtDataHash, getForwarderFactoryAddress, getMerklePath, getPoolAddress, getPrivateBalance, getQueueAddress, getQueueBalance, getRelayInfo, getRelayUrl, getSubaccountPrivateBalance, getSubaccountStatus, isSubaccountForwarderDeployed, isSubaccountWithdrawNonceUsed, mergeSubaccount, mergeUtxos, packEncryptedMessage, poseidonHash, poseidonHash2, predictSubaccountForwarder, prepareTransaction, prove, randomBN, selectCircuit, selectUtxosForWithdraw, shuffle, signSubaccountWithdraw, submitRelay, sweepSubaccountForwarder, toBuffer, toFixedHex, transfer, unpackEncryptedMessage, withdraw };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map