{"_id":"@alpha-network/keccak256-zk","name":"@alpha-network/keccak256-zk","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@alpha-network/keccak256-zk","version":"0.0.1","description":"The JavaScript SDK designed for verifying data existence using zero-knowledge proofs (ZKP) based on the Keccak256 hashing algorithm.","main":"lib/index.js","author":{"name":"regison@alphaos.net"},"license":"ISC","scripts":{"build":"tsc","postinstall":"node bin/postinstall"},"dependencies":{"snarkjs":"^0.7.4"},"devDependencies":{"@types/snarkjs":"^0.7.8","ts-node":"^10.9.2","tsconfig-paths":"^4.2.0","typescript":"^5.6.2"},"_id":"@alpha-network/keccak256-zk@0.0.1","gitHead":"86ce13b9731043e2a9c467ead7ce30a25be8ef3e","_nodeVersion":"18.19.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-uZXj1KfDCwJiAZvSMkZJfys+ekj95QboAhp3PJUxwLnlV6g8NfgKt6OJfEG2U1ltvlJ9LQqhkGhU64sBLX6OLA==","shasum":"d4d1f516c322c98c36ac37e3fd9b1be7f8d0d6e5","tarball":"https://registry.npmjs.org/@alpha-network/keccak256-zk/-/keccak256-zk-0.0.1.tgz","fileCount":13,"unpackedSize":4143623,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH3mZZ0i3wXHkJ1bEtRPSkpVcySJQPzI6KF4RXn8rdwcAiEAtGAEqHzXijaVFWyRzQD+eOap+1HNFKMvoqe/6nlznIY="}]},"_npmUser":{"name":"regison_zzz","email":"zhangdad13@gmail.com"},"directories":{},"maintainers":[{"name":"regison_zzz","email":"zhangdad13@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keccak256-zk_0.0.1_1727613183293_0.2625683095677662"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-29T12:33:03.193Z","0.0.1":"2024-09-29T12:33:03.659Z","modified":"2024-09-29T12:33:03.973Z"},"maintainers":[{"name":"regison_zzz","email":"zhangdad13@gmail.com"}],"description":"The JavaScript SDK designed for verifying data existence using zero-knowledge proofs (ZKP) based on the Keccak256 hashing algorithm.","author":{"name":"regison@alphaos.net"},"license":"ISC","readme":"# @alpha-network/keccak256-zk\n\n## Description\nThe JavaScript SDK designed for verifying data existence using zero-knowledge proofs (ZKP) based on the Keccak256 hashing algorithm.\n\nThis SDK enables developers to confirm the validity of data in blockchain or distributed storage systems without revealing its actual content. It’s easy to integrate, making it ideal for blockchain applications, data privacy solutions, and decentralized projects.\n\n## Installation\n```shell\nnpm install @alpha-network/keccak256-zk\n```\n\n## Usage\n### Generate ZK Proof\nTo generate a zero-knowledge proof, use the `generateZkProof` function:\n```typescript\nimport { generateZkProof } from '@alpha-network/keccak256-zk';\n\nconst dataBytes = new Uint8Array([/* your data bytes here */]);\nconst nonce = '12345678'; // Example nonce (must be 8 characters long)\n\ntry {\n  const { proof, publicSignals } = await generateZkProof({ dataBytes, nonce });\n  console.log('ZK Proof generated:', proof);\n  console.log('Public Signals:', publicSignals);\n  return { proof, publicSignals };\n} catch (error) {\n  console.error('Error generating ZK Proof:', error.message);\n}\n```\n\n### Verify ZK Proof\nTo verify a generated proof, use the `verifyZkProof` function:\n```typescript\nimport { verifyZkProof } from '@alpha-network/keccak256-zk';\n\ntry {\n  const isValid = await verifyZkProof({\n    hash: expectedHash, // Keccak256 Hash\n    nonce: expectedNonce,\n    proof,\n    publicSignals,\n  });\n  console.log('ZK Proof verification result:', isValid);\n} catch (error) {\n  console.error('Error verifying ZK Proof:', error.message);\n}\n```\n\n## License\nMIT","readmeFilename":"README.md"}