@orbinum/circuits 0.3.0

package/LICENSE

@@ -0,0 +1,17 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2026 Orbinum Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,130 @@
+# @orbinum/circuits
+
+Zero-Knowledge circuits for Orbinum privacy blockchain. This package contains compiled circuit artifacts for proof generation and verification.
+
+[![npm version](https://img.shields.io/npm/v/@orbinum/circuits.svg)](https://www.npmjs.com/package/@orbinum/circuits)
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue)](https://github.com/orbinum/circuits/blob/main/LICENSE)
+
+## 🚀 Installation
+
+```bash
+npm install @orbinum/circuits
+```
+
+## 📦 Package Contents
+
+This package includes **12 files** for 3 circuits (disclosure, transfer, unshield):
+
+### For Each Circuit (disclosure, transfer, unshield):
+
+1. **`{circuit}.wasm`** - Witness calculator (3 files)
+2. **`{circuit}_pk.zkey`** - Proving key for snarkjs (3 files)
+3. **`{circuit}_pk.ark`** - Proving key for arkworks/Rust (3 files)
+4. **`verification_key_{circuit}.json`** - Verification key for on-chain verification (3 files)
+
+## 🔧 Usage
+
+### With snarkjs (JavaScript/TypeScript)
+
+```typescript
+import { join } from "path";
+import { readFileSync } from "fs";
+
+// Get circuit artifacts
+const circuitsPath = require.resolve("@orbinum/circuits/package.json").replace("package.json", "");
+
+// Load WASM witness calculator
+const wasmPath = join(circuitsPath, "transfer.wasm");
+const wasmBuffer = readFileSync(wasmPath);
+
+// Load proving key (.zkey)
+const zkeyPath = join(circuitsPath, "transfer_pk.zkey");
+const zkeyBuffer = readFileSync(zkeyPath);
+
+// Use with snarkjs for proof generation
+// ... snarkjs proof generation code ...
+```
+
+### With arkworks (Rust)
+
+```rust
+use std::fs::File;
+use ark_circom::read_zkey;
+
+// Load proving key (.ark format)
+let mut ark_file = File::open("transfer_pk.ark")?;
+let proving_key = read_proving_key(&mut ark_file)?;
+
+// Use for proof generation
+// ... arkworks proof generation code ...
+```
+
+### Verification Keys (On-chain)
+
+```typescript
+import verificationKey from "@orbinum/circuits/verification_key_transfer.json";
+
+// Use for on-chain verification in Substrate runtime
+// The JSON contains the verification key in a format ready for the runtime
+```
+
+## 📋 Available Circuits
+
+### 1. **Disclosure** (`disclosure_*`)
+
+Selective disclosure circuit for privacy-preserving attribute revelation.
+
+### 2. **Transfer** (`transfer_*`)
+
+Private token transfer circuit with 2 inputs and 2 outputs.
+
+### 3. **Unshield** (`unshield_*`)
+
+Withdrawal circuit from private pool to public account.
+
+## 🔗 Related Packages
+
+- [@orbinum/proof-generator](https://www.npmjs.com/package/@orbinum/proof-generator) - High-level proof orchestrator
+- [@orbinum/groth16-proofs](https://www.npmjs.com/package/@orbinum/groth16-proofs) - Arkworks WASM proof generator
+
+## 💡 Usage Example with @orbinum/proof-generator
+
+```typescript
+import { generateProof, CircuitType } from "@orbinum/proof-generator";
+
+// Proof generator automatically loads circuits from @orbinum/circuits
+const result = await generateProof(CircuitType.Transfer, witnessInputs, numPublicSignals);
+
+console.log("Proof:", result.proof);
+console.log("Public signals:", result.publicSignals);
+```
+
+## 📄 File Sizes
+
+- **WASM files**: ~1-2 MB each (witness calculators)
+- **`.zkey` files**: ~7-9 MB each (snarkjs proving keys)
+- **`.ark` files**: ~7-9 MB each (arkworks proving keys)
+- **Verification keys**: ~3-4 KB each (JSON)
+
+**Total package size**: ~50-60 MB
+
+## 🔒 Security Notice
+
+⚠️ **Important**: These circuit artifacts are for **testing and development only**.
+
+For production deployment, a **multi-party trusted setup ceremony** is required to generate secure proving/verification keys.
+
+## 📖 Circuit Specifications
+
+For detailed circuit specifications, constraints, and integration guides:
+
+- [Circuit Documentation](https://github.com/orbinum/circuits/tree/main/docs)
+- [Integration Guide](https://github.com/orbinum/circuits/blob/main/docs/INTEGRATION.md)
+
+## 🐛 Issues
+
+Report issues at: https://github.com/orbinum/circuits/issues
+
+## 📄 License
+
+GPL-3.0 - See [LICENSE](https://github.com/orbinum/circuits/blob/main/LICENSE)

package/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @orbinum/circuits - Circuit artifacts index
+ *
+ * Helper functions to load circuit artifacts
+ */
+
+export interface CircuitPaths {
+    wasm: string;
+    zkey: string;
+    ark: string;
+    verificationKey: string;
+}
+
+/**
+ * Get paths to all files for a specific circuit
+ */
+export function getCircuitPaths(circuit: "disclosure" | "transfer" | "unshield"): CircuitPaths;
+
+/**
+ * Available circuits
+ */
+export type CircuitType = "disclosure" | "transfer" | "unshield";
+
+export const CIRCUITS: CircuitType[];

package/index.js

@@ -0,0 +1,34 @@
+/**
+ * @orbinum/circuits - Circuit artifacts index
+ *
+ * Helper functions to load circuit artifacts
+ */
+
+const { join } = require("path");
+
+const CIRCUITS = ["disclosure", "transfer", "unshield"];
+
+/**
+ * Get paths to all files for a specific circuit
+ * @param {string} circuit - Circuit name: 'disclosure', 'transfer', or 'unshield'
+ * @returns {Object} Paths to circuit files
+ */
+function getCircuitPaths(circuit) {
+    if (!CIRCUITS.includes(circuit)) {
+        throw new Error(`Invalid circuit: ${circuit}. Must be one of: ${CIRCUITS.join(", ")}`);
+    }
+
+    const basePath = __dirname;
+
+    return {
+        wasm: join(basePath, `${circuit}.wasm`),
+        zkey: join(basePath, `${circuit}_pk.zkey`),
+        ark: join(basePath, `${circuit}_pk.ark`),
+        verificationKey: join(basePath, `verification_key_${circuit}.json`),
+    };
+}
+
+module.exports = {
+    getCircuitPaths,
+    CIRCUITS,
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@orbinum/circuits",
+  "version": "0.3.0",
+  "description": "Zero-Knowledge circuits for Orbinum privacy blockchain",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "*.wasm",
+    "*.zkey",
+    "*.ark",
+    "*.json",
+    "index.js",
+    "index.d.ts",
+    "LICENSE"
+  ],
+  "keywords": [
+    "zk-snark",
+    "groth16",
+    "circom",
+    "circuits",
+    "privacy",
+    "orbinum",
+    "zero-knowledge"
+  ],
+  "author": "Orbinum",
+  "license": "GPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/orbinum/circuits"
+  },
+  "homepage": "https://github.com/orbinum/circuits",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/verification_key_disclosure.json

@@ -0,0 +1,109 @@
+{
+ "protocol": "groth16",
+ "curve": "bn128",
+ "nPublic": 4,
+ "vk_alpha_1": [
+  "20491192805390485299153009773594534940189261866228447918068658471970481763042",
+  "9383485363053290200918347156157836566562967994039712273449902621266178545958",
+  "1"
+ ],
+ "vk_beta_2": [
+  [
+   "6375614351688725206403948262868962793625744043794305715222011528459656738731",
+   "4252822878758300859123897981450591353533073413197771768651442665752259397132"
+  ],
+  [
+   "10505242626370262277552901082094356697409835680220590971873171140371331206856",
+   "21847035105528745403288232691147584728191162732299865338377159692350059136679"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_gamma_2": [
+  [
+   "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+   "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+  ],
+  [
+   "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+   "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_delta_2": [
+  [
+   "17181498531159263629882165870813697779346883078645466145783271498545766806464",
+   "4103758893379416054048842959380474068052324667650307530147789116301376054674"
+  ],
+  [
+   "17240782462632988568877834665875325743663801812824474063393589053354835026260",
+   "10727175232410694244198044736795714331219651403982597624913437252546529983481"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_alphabeta_12": [
+  [
+   [
+    "2029413683389138792403550203267699914886160938906632433982220835551125967885",
+    "21072700047562757817161031222997517981543347628379360635925549008442030252106"
+   ],
+   [
+    "5940354580057074848093997050200682056184807770593307860589430076672439820312",
+    "12156638873931618554171829126792193045421052652279363021382169897324752428276"
+   ],
+   [
+    "7898200236362823042373859371574133993780991612861777490112507062703164551277",
+    "7074218545237549455313236346927434013100842096812539264420499035217050630853"
+   ]
+  ],
+  [
+   [
+    "7077479683546002997211712695946002074877511277312570035766170199895071832130",
+    "10093483419865920389913245021038182291233451549023025229112148274109565435465"
+   ],
+   [
+    "4595479056700221319381530156280926371456704509942304414423590385166031118820",
+    "19831328484489333784475432780421641293929726139240675179672856274388269393268"
+   ],
+   [
+    "11934129596455521040620786944827826205713621633706285934057045369193958244500",
+    "8037395052364110730298837004334506829870972346962140206007064471173334027475"
+   ]
+  ]
+ ],
+ "IC": [
+  [
+   "15964950830910202244217667436665733776997447861553802623999698138484110595957",
+   "1040079402286714073647109609323335894210500907477000571792043915719024030224",
+   "1"
+  ],
+  [
+   "3340210474460277437662732981813692576850795858372732555286041366326257354427",
+   "9836565355755721050636876037692518662635375900213403984966267475206475658524",
+   "1"
+  ],
+  [
+   "12060419398997673887064863238328225795227850230778535632787590613985993920427",
+   "5881790740170267272776729282842338197965403298580720322757247992346504212644",
+   "1"
+  ],
+  [
+   "14940581636929495647429694768793509851524492245737760358779578356534185051021",
+   "8199470560675183315870564454703278914683812654862355184904152407412888877972",
+   "1"
+  ],
+  [
+   "10409564891268817626963180756840234046972055191382429263672757341041082599476",
+   "20153095266914888386311759097574228223575358889458887322529392137999194059340",
+   "1"
+  ]
+ ]
+}

package/verification_key_transfer.json

@@ -0,0 +1,114 @@
+{
+ "protocol": "groth16",
+ "curve": "bn128",
+ "nPublic": 5,
+ "vk_alpha_1": [
+  "20491192805390485299153009773594534940189261866228447918068658471970481763042",
+  "9383485363053290200918347156157836566562967994039712273449902621266178545958",
+  "1"
+ ],
+ "vk_beta_2": [
+  [
+   "6375614351688725206403948262868962793625744043794305715222011528459656738731",
+   "4252822878758300859123897981450591353533073413197771768651442665752259397132"
+  ],
+  [
+   "10505242626370262277552901082094356697409835680220590971873171140371331206856",
+   "21847035105528745403288232691147584728191162732299865338377159692350059136679"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_gamma_2": [
+  [
+   "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+   "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+  ],
+  [
+   "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+   "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_delta_2": [
+  [
+   "13240232876868386494108652779817474952316318952810878973254412692911558867632",
+   "16347590663521732394025581272898538630471281498601579993469941176971924600386"
+  ],
+  [
+   "13557005240656553772818805810517429799550918083210432911140321093840076700542",
+   "14700656657294163774759001919282652049154398781032001485800913171547479111289"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_alphabeta_12": [
+  [
+   [
+    "2029413683389138792403550203267699914886160938906632433982220835551125967885",
+    "21072700047562757817161031222997517981543347628379360635925549008442030252106"
+   ],
+   [
+    "5940354580057074848093997050200682056184807770593307860589430076672439820312",
+    "12156638873931618554171829126792193045421052652279363021382169897324752428276"
+   ],
+   [
+    "7898200236362823042373859371574133993780991612861777490112507062703164551277",
+    "7074218545237549455313236346927434013100842096812539264420499035217050630853"
+   ]
+  ],
+  [
+   [
+    "7077479683546002997211712695946002074877511277312570035766170199895071832130",
+    "10093483419865920389913245021038182291233451549023025229112148274109565435465"
+   ],
+   [
+    "4595479056700221319381530156280926371456704509942304414423590385166031118820",
+    "19831328484489333784475432780421641293929726139240675179672856274388269393268"
+   ],
+   [
+    "11934129596455521040620786944827826205713621633706285934057045369193958244500",
+    "8037395052364110730298837004334506829870972346962140206007064471173334027475"
+   ]
+  ]
+ ],
+ "IC": [
+  [
+   "12521353044701549515327655017850372472462274389676752451261564850795277210784",
+   "17537427920533725255683527309076964578961889733887641292864968986005206833227",
+   "1"
+  ],
+  [
+   "9054540875357326821742569992875343778082451382872166255139682380736118336965",
+   "19145371190592659949158552383366523068893276589381638814741619309597554902109",
+   "1"
+  ],
+  [
+   "4742393298120554619433281305566496971436669707311583698440427823952632276050",
+   "3877416000326877112020382111726729873163167304724326109191809999398145068082",
+   "1"
+  ],
+  [
+   "13596656322317975043597922138537730020108978263529423575433634179437267442285",
+   "9742436487435369435567344764161265311134349467077942742196530523569923539419",
+   "1"
+  ],
+  [
+   "10688916237036738808967339930842102783882829011167399097753073924876231581798",
+   "15541123047651505099565506020079072290645702361358638026159150320227489549290",
+   "1"
+  ],
+  [
+   "10594341809050651078348790198511832237136162370751007990030736876706319494726",
+   "8811599578125639162916289173502210672259754599803755307954551465982761005752",
+   "1"
+  ]
+ ]
+}

package/verification_key_unshield.json

@@ -0,0 +1,114 @@
+{
+ "protocol": "groth16",
+ "curve": "bn128",
+ "nPublic": 5,
+ "vk_alpha_1": [
+  "20491192805390485299153009773594534940189261866228447918068658471970481763042",
+  "9383485363053290200918347156157836566562967994039712273449902621266178545958",
+  "1"
+ ],
+ "vk_beta_2": [
+  [
+   "6375614351688725206403948262868962793625744043794305715222011528459656738731",
+   "4252822878758300859123897981450591353533073413197771768651442665752259397132"
+  ],
+  [
+   "10505242626370262277552901082094356697409835680220590971873171140371331206856",
+   "21847035105528745403288232691147584728191162732299865338377159692350059136679"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_gamma_2": [
+  [
+   "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+   "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+  ],
+  [
+   "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+   "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_delta_2": [
+  [
+   "1545032554073779649356239631893752244649696827187815861670397162826183754931",
+   "20314999785314503565623024867913636156801164997066449897860768907774370581592"
+  ],
+  [
+   "9043720973115289314904265089531027469020347117089218856801223721531103662056",
+   "1731759157587106468048280763944125674612517726686059643642432234957314643786"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_alphabeta_12": [
+  [
+   [
+    "2029413683389138792403550203267699914886160938906632433982220835551125967885",
+    "21072700047562757817161031222997517981543347628379360635925549008442030252106"
+   ],
+   [
+    "5940354580057074848093997050200682056184807770593307860589430076672439820312",
+    "12156638873931618554171829126792193045421052652279363021382169897324752428276"
+   ],
+   [
+    "7898200236362823042373859371574133993780991612861777490112507062703164551277",
+    "7074218545237549455313236346927434013100842096812539264420499035217050630853"
+   ]
+  ],
+  [
+   [
+    "7077479683546002997211712695946002074877511277312570035766170199895071832130",
+    "10093483419865920389913245021038182291233451549023025229112148274109565435465"
+   ],
+   [
+    "4595479056700221319381530156280926371456704509942304414423590385166031118820",
+    "19831328484489333784475432780421641293929726139240675179672856274388269393268"
+   ],
+   [
+    "11934129596455521040620786944827826205713621633706285934057045369193958244500",
+    "8037395052364110730298837004334506829870972346962140206007064471173334027475"
+   ]
+  ]
+ ],
+ "IC": [
+  [
+   "4759917404823790432407520088534459023356590579383652181465364916912449624695",
+   "3832863574771841234331076301811290460934931101437953774708549890327258738564",
+   "1"
+  ],
+  [
+   "5336337706419091211868472399687230066131810167568242892809804587865519165344",
+   "11353185051357039508206677538186633821853103335512576778299092029039610062882",
+   "1"
+  ],
+  [
+   "15084681146036149779834232651527344012418671089935933939397885561760086121969",
+   "10673952063622217067979641197117245279252423258914282179285754313970092562596",
+   "1"
+  ],
+  [
+   "21039779822942533132271658631716796333199025786313218659510617689739394153598",
+   "11163282276070815586063767846812914624591347999168289386275553753092237495248",
+   "1"
+  ],
+  [
+   "3095712311814508041135867864726006035419219310141511809667041762596327080341",
+   "17159247848061658623919878194408282495395946967527260450426770075448330620486",
+   "1"
+  ],
+  [
+   "4168950959496505617599330781731644101559373119770356275626759863667568305184",
+   "5644689731760572677103844719463014317690882565098456772580613601327065049357",
+   "1"
+  ]
+ ]
+}