starkshield 1.0.0

package/README.md

@@ -0,0 +1,101 @@
+# starkshield
+
+**Write Circom. Compile. Deploy. Verify — all in just one click, Powered by Starknet**
+
+A zero-setup toolkit to build, deploy, and verify ZK circuits using Circom — with **no Web3 knowledge required**.
+
+---
+
+## ✨ Features
+
+- 🧠 Write simple Circom circuits
+- 🛠 Compile to `.r1cs`, `.wasm`, `.zkey`, and Solidity verifier
+- 🚀 Deploy verifier to **Starknet** with one command
+- ✅ Verify proofs using a single JavaScript function
+- 🧪 No Web3 scripting, no ABI handling — fully abstracted
+
+---
+
+## 📦 Installation
+
+Install in your project:
+
+```bash
+npm install starkshield
+```
+
+⚡ Usage
+
+### ✅ Compile Circom circuit
+
+```bash
+npx starkshield compile <path-to-your-circom-file>
+```
+
+This command:
+
+- Compiles your .circom file
+- Runs Groth16 trusted setup
+- Outputs .r1cs, .wasm, circuit_final.zkey, and verifier.sol
+- All files are saved in a folder named after your circuit (e.g., ./yourCircuit/)
+
+### ✅ Test Compiled Circom Circuit
+
+```bash
+npx starkshield test <path-to-generated-folder> <path-to-input.json>
+```
+
+This command:
+
+- Tests the zk System produced by the compile command
+- Uses inputs provided by the developer from input.json provided
+- produces proof.json and public.json
+- proof.json contains the smart contract parameters, which will be used to verify it onchain
+- public.json contains human verifiable outputs and proofs
+
+### ✅ Deploy Compiled Circom Circuit
+
+```bash
+npx starkshield deploy <path-to-generated-folder> <PRIVATE_KEY_OF_WALLET>
+```
+
+This command:
+
+- Compiles verifier.sol generated during compilation using solc
+- Deploys the compiled binary to Starknet, taking fees from the provided wallet's private key
+
+
+### ✅ Verify ZK Proof Programmatically
+
+You can verify a proof directly using a single function call.
+
+```js
+const { verifyProof } = require("starkshield");
+
+const result = await verifyProof({
+  input: {
+    // Your circuit input goes here
+  },
+  "<relative-path-to-generated-folder>",
+});
+
+console.log(result ? "✅ Valid proof" : "❌ Invalid proof");
+```
+
+- You pass input (in the form of json) & Relative path to the generated folder, which was generated during compilation process
+- Automatically generates the proof and public signals
+- Formats the calldata for the Solidity verifier
+- Calls the deployed verifier contract on Starknet and returns the result
+
+# You don’t need to manually use snarkjs or interact with web3 directly — the SDK abstracts it all for you.
+
+## 🛠 Commands Overview
+
+| Command                                       | Description                                      |
+|----------------------------------------------|--------------------------------------------------|
+| `npx starkshield compile <path-to-circuit>` | Compiles the `.circom` file and runs Groth16 setup |
+| `npx starkshield test <output-folder> <path-to-input.json>` | Tests the Circom logic locally using ZK Proofs        |
+| `npx starkshield deploy <output-folder> <private-key>` | Deploys the verifier contract to Starknet        |
+| `verifyProof(input,"<relative-path-to-output-folder>")` *(programmatic only)* | Generates proof and verifies it on-chain using deployed contract |
+
+

package/bin/cli.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const { compileCircuit } = require('../lib/compile');
+const { testCircuit } = require('../lib/test');
+const { deployVerifier } = require('../lib/deploy');
+// const { verifyProof } = require('../lib/verify');
+
+program
+  .command('compile <circomFilePath>')
+  .description('Compile a circom circuit')
+  .action((circomFilePath) => {
+    compileCircuit(circomFilePath);
+  });
+
+  program
+  .command('test <folder> <inputJson>')
+  .description('Test the circuit with input.json and generate proof/public.json')
+  .action((folder, inputJson) => {
+    testCircuit(folder, inputJson);
+  });
+
+  program
+  .command('deploy <folder> <privateKey> <accountAddress>')
+  .description('Deploy verifier.sol in folder to Starknet using provided private key and account address')
+  .action((folder, privateKey, accountAddress) => {
+    deployVerifier(folder, privateKey, accountAddress);
+  });
+
+
+  program.parse(process.argv);
+
+
+module.exports = {
+  // verifyProof
+};    

package/bin/index.js

@@ -0,0 +1,13 @@
+const { compileCircuit } = require('../lib/compile');
+const { testCircuit } = require('../lib/test');
+// const { deployVerifier } = require('../lib/deploy');
+// const { verifyProof } = require('../lib/verify');
+
+
+
+module.exports = {
+    // verifyProof,
+    compileCircuit,
+    testCircuit,
+    // deployVerifier
+};

package/circomlib/.vscode/launch.json

@@ -0,0 +1,63 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/calcoptimizedposeidonconsts/test_poseidon.js",
+            "cwd": "${workspaceFolder}/calcoptimizedposeidonconsts"
+        },
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Tests",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "cwd": "${workspaceFolder}",
+            "args": ["test/smtverifier.js"]
+        },
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Test Poseidon",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "cwd": "${workspaceFolder}",
+            "args": ["test/poseidoncircuit.js"]
+        },
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Test binsum",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "cwd": "${workspaceFolder}",
+            "args": ["test/binsum.js"]
+        },
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Test babyjub",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "cwd": "${workspaceFolder}",
+            "args": ["test/babyjub.js"]
+        }
+
+    ]
+}

package/circomlib/README.md

@@ -0,0 +1,18 @@
+# CircomLib
+
+## Description
+
+- This repository contains a library of circuit templates. 
+- All files are copyrighted under 2018 0KIMS association and part of the free software [circom](https://github.com/iden3/circom) (Zero Knowledge Circuit Compiler). 
+- You can read more about the circom language in [the circom documentation webpage](https://docs.circom.io/).
+
+## Organisation
+
+This respository contains 5 folders:
+- `circuits`: it contains the implementation of different cryptographic primitives in circom language.
+- `calcpedersenbases`: set of functions in JavaScript used to find a set of points in [Baby Jubjub](https://github.com/barryWhiteHat/baby_jubjub) elliptic curve that serve as basis for the [Pedersen Hash](https://github.com/zcash/zcash/issues/2234).
+- `doc`: it contains some circuit schemes in ASCII (must be opened with Monodraw, an ASCII art editor for Mac).
+- `src`: it contains similar implementation of circuits in JavaScript.
+- `test`: tests.
+
+A description of the specific circuit templates for the `circuit` folder will be soon updated.