@orbinum/circuits 0.4.2 → 0.4.4

package/README.md

@@ -13,14 +13,15 @@ npm install @orbinum/circuits
 
 ## 📦 Package Contents
 
-This package includes **12 files** for 3 circuits (disclosure, transfer, unshield):
+This package includes **20 files** for 4 circuits (disclosure, transfer, unshield, private_link):
 
-### For Each Circuit (disclosure, transfer, unshield):
+### For Each Circuit (disclosure, transfer, unshield, private_link):
 
-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)
+1. **`{circuit}.wasm`** - Witness calculator (4 files)
+2. **`{circuit}.r1cs`** - R1CS constraint system — for custom provers / verification (4 files)
+3. **`{circuit}_pk.zkey`** - Proving key for snarkjs (4 files)
+4. **`{circuit}_pk.ark`** - Proving key for arkworks/Rust (4 files)
+5. **`verification_key_{circuit}.json`** - Verification key for on-chain verification (4 files)
 
 ## 🔧 Usage
 
@@ -29,17 +30,19 @@ This package includes **12 files** for 3 circuits (disclosure, transfer, unshiel
 ```typescript
 import { join } from "path";
 import { readFileSync } from "fs";
+import { getCircuitPaths } from "@orbinum/circuits";
 
-// Get circuit artifacts
-const circuitsPath = require.resolve("@orbinum/circuits/package.json").replace("package.json", "");
+// Get all paths for a circuit
+const paths = getCircuitPaths("transfer"); // 'disclosure' | 'transfer' | 'unshield' | 'private_link'
 
 // Load WASM witness calculator
-const wasmPath = join(circuitsPath, "transfer.wasm");
-const wasmBuffer = readFileSync(wasmPath);
+const wasmBuffer = readFileSync(paths.wasm);
 
 // Load proving key (.zkey)
-const zkeyPath = join(circuitsPath, "transfer_pk.zkey");
-const zkeyBuffer = readFileSync(zkeyPath);
+const zkeyBuffer = readFileSync(paths.zkey);
+
+// Load R1CS (e.g. for custom prover or constraint inspection)
+const r1csBuffer = readFileSync(paths.r1cs);
 
 // Use with snarkjs for proof generation
 // ... snarkjs proof generation code ...
@@ -82,6 +85,10 @@ Private token transfer circuit with 2 inputs and 2 outputs.
 
 Withdrawal circuit from private pool to public account.
 
+### 4. **Private Link** (`private_link_*`)
+
+Proves linkage between two commitments without revealing their values.
+
 ## 🔗 Related Packages
 
 - [@orbinum/proof-generator](https://www.npmjs.com/package/@orbinum/proof-generator) - High-level proof orchestrator
@@ -101,12 +108,13 @@ 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)
+- **WASM files**: ~1-3 MB each (witness calculators)
+- **R1CS files**: ~1-5 MB each (constraint systems)
+- **`.zkey` files**: ~0.5-20 MB each (snarkjs proving keys)
+- **`.ark` files**: ~0.2-9 MB each (arkworks proving keys)
 - **Verification keys**: ~3-4 KB each (JSON)
 
-**Total package size**: ~50-60 MB
+**Total package size**: ~80-90 MB
 
 ## 🔒 Security Notice
 

package/index.d.ts

@@ -6,6 +6,7 @@
 
 export interface CircuitPaths {
     wasm: string;
+    r1cs: string;
     zkey: string;
     ark: string;
     verificationKey: string;
@@ -14,11 +15,13 @@ export interface CircuitPaths {
 /**
  * Get paths to all files for a specific circuit
  */
-export function getCircuitPaths(circuit: "disclosure" | "transfer" | "unshield"): CircuitPaths;
+export function getCircuitPaths(
+    circuit: "disclosure" | "transfer" | "unshield" | "private_link"
+): CircuitPaths;
 
 /**
  * Available circuits
  */
-export type CircuitType = "disclosure" | "transfer" | "unshield";
+export type CircuitType = "disclosure" | "transfer" | "unshield" | "private_link";
 
 export const CIRCUITS: CircuitType[];

package/index.js

@@ -6,11 +6,11 @@
 
 const { join } = require("path");
 
-const CIRCUITS = ["disclosure", "transfer", "unshield"];
+const CIRCUITS = ["disclosure", "transfer", "unshield", "private_link"];
 
 /**
  * Get paths to all files for a specific circuit
- * @param {string} circuit - Circuit name: 'disclosure', 'transfer', or 'unshield'
+ * @param {string} circuit - Circuit name: 'disclosure', 'transfer', 'unshield', or 'private_link'
  * @returns {Object} Paths to circuit files
  */
 function getCircuitPaths(circuit) {
@@ -22,6 +22,7 @@ function getCircuitPaths(circuit) {
 
     return {
         wasm: join(basePath, `${circuit}.wasm`),
+        r1cs: join(basePath, `${circuit}.r1cs`),
         zkey: join(basePath, `${circuit}_pk.zkey`),
         ark: join(basePath, `${circuit}_pk.ark`),
         verificationKey: join(basePath, `verification_key_${circuit}.json`),

package/manifest.json

@@ -0,0 +1,160 @@
+{
+  "schema_version": "1.0.0",
+  "package_name": "orbinum-circuits",
+  "package_version": "0.4.4",
+  "generated_at": "2026-03-19T14:10:04.861Z",
+  "circuits": {
+    "disclosure": {
+      "active_version": 1,
+      "supported_versions": [
+        1
+      ],
+      "versions": {
+        "1": {
+          "version": 1,
+          "vk_hash": "0xc27372bfd4aaf3b14b47af119d38c42e1aee8be4051bfbc1a0e27c767a13d9cf",
+          "artifacts": {
+            "wasm": {
+              "file": "disclosure.wasm",
+              "localPath": "build/disclosure_js/disclosure.wasm",
+              "bytes": 2220560,
+              "sha256": "db42d0d4941c7d7265717fe44e43048c0800f962a2ea7251353ea2f645aa9f31"
+            },
+            "zkey": {
+              "file": "disclosure_pk.zkey",
+              "localPath": "keys/disclosure_pk.zkey",
+              "bytes": 554204,
+              "sha256": "dbc292073cf2b8c9dc304b8e7de6cd206277f5b9e7ed4c67efe4b7fa27137efb"
+            },
+            "vk_json": {
+              "file": "verification_key_disclosure.json",
+              "localPath": "build/verification_key_disclosure.json",
+              "bytes": 3471,
+              "sha256": "c27372bfd4aaf3b14b47af119d38c42e1aee8be4051bfbc1a0e27c767a13d9cf"
+            },
+            "r1cs": {
+              "file": "disclosure.r1cs",
+              "localPath": "build/disclosure.r1cs",
+              "bytes": 159840,
+              "sha256": "c8dc1ba76e133ebd39db020ce52b1d8587103209d83dbf02d7eb7545557042f0"
+            }
+          }
+        }
+      }
+    },
+    "transfer": {
+      "active_version": 1,
+      "supported_versions": [
+        1
+      ],
+      "versions": {
+        "1": {
+          "version": 1,
+          "vk_hash": "0x2ab60d1597eacb9bdc80e8ceedcf678fff2349d40c350af9192c98fdda0990c0",
+          "artifacts": {
+            "wasm": {
+              "file": "transfer.wasm",
+              "localPath": "build/transfer_js/transfer.wasm",
+              "bytes": 3359868,
+              "sha256": "97cae6deed6c526ed0a287da3d3ab4b8f2cc71ccc956278d262f850ec435b7e5"
+            },
+            "zkey": {
+              "file": "transfer_pk.zkey",
+              "localPath": "keys/transfer_pk.zkey",
+              "bytes": 20484784,
+              "sha256": "c5d6dfb9dba43687a5cdada1f5a244807971a2ae596125568e736ae7d85313ac"
+            },
+            "vk_json": {
+              "file": "verification_key_transfer.json",
+              "localPath": "build/verification_key_transfer.json",
+              "bytes": 3658,
+              "sha256": "2ab60d1597eacb9bdc80e8ceedcf678fff2349d40c350af9192c98fdda0990c0"
+            },
+            "r1cs": {
+              "file": "transfer.r1cs",
+              "localPath": "build/transfer.r1cs",
+              "bytes": 6629624,
+              "sha256": "96757770bbd03e7cff1a313a58d76296823774328966e7ebf088cabe90655592"
+            }
+          }
+        }
+      }
+    },
+    "unshield": {
+      "active_version": 1,
+      "supported_versions": [
+        1
+      ],
+      "versions": {
+        "1": {
+          "version": 1,
+          "vk_hash": "0x73401aa0b77bb475478d0be2005a20fcd60196a68ee4abea6cecb6f77124050d",
+          "artifacts": {
+            "wasm": {
+              "file": "unshield.wasm",
+              "localPath": "build/unshield_js/unshield.wasm",
+              "bytes": 2396830,
+              "sha256": "aebf93eb6d7544742eb8bffdbedc82101ff524efdfb649839e3f5b3960c3f06e"
+            },
+            "zkey": {
+              "file": "unshield_pk.zkey",
+              "localPath": "keys/unshield_pk.zkey",
+              "bytes": 5326768,
+              "sha256": "a19e057e669e28df35c231b10d90824493a969f896f6f865448db981d77491e0"
+            },
+            "vk_json": {
+              "file": "verification_key_unshield.json",
+              "localPath": "build/verification_key_unshield.json",
+              "bytes": 3657,
+              "sha256": "73401aa0b77bb475478d0be2005a20fcd60196a68ee4abea6cecb6f77124050d"
+            },
+            "r1cs": {
+              "file": "unshield.r1cs",
+              "localPath": "build/unshield.r1cs",
+              "bytes": 1584412,
+              "sha256": "bebc3fe2a0e9eae6128fb402225ca18276e127daac0df15bad2da7b14e123428"
+            }
+          }
+        }
+      }
+    },
+    "private_link": {
+      "active_version": 1,
+      "supported_versions": [
+        1
+      ],
+      "versions": {
+        "1": {
+          "version": 1,
+          "vk_hash": "0x5370006e31d603618b2487d6f61077d86160f2de5cb188c517036be8ce63d9e6",
+          "artifacts": {
+            "wasm": {
+              "file": "private_link.wasm",
+              "localPath": "build/private_link_js/private_link.wasm",
+              "bytes": 1750902,
+              "sha256": "3190bb18260b294c2dccad6f509867a2fdd756707a3c1d10a483551e18796e08"
+            },
+            "zkey": {
+              "file": "private_link_pk.zkey",
+              "localPath": "keys/private_link_pk.zkey",
+              "bytes": 508588,
+              "sha256": "0fbb22eb4917d36d1664bf5a7435bda83fb91543c02fe36548900a0354be5ffb"
+            },
+            "vk_json": {
+              "file": "verification_key_private_link.json",
+              "localPath": "build/verification_key_private_link.json",
+              "bytes": 3108,
+              "sha256": "5370006e31d603618b2487d6f61077d86160f2de5cb188c517036be8ce63d9e6"
+            },
+            "r1cs": {
+              "file": "private_link.r1cs",
+              "localPath": "build/private_link.r1cs",
+              "bytes": 138248,
+              "sha256": "62b38b485b501d0423580c5f217f5cc088d46ead3956097cd893358df7b3fa8c"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@orbinum/circuits",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "Zero-Knowledge circuits for Orbinum privacy blockchain",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "*.wasm",
+    "*.r1cs",
     "*.zkey",
     "*.ark",
     "*.json",

package/verification_key_disclosure.json

@@ -37,12 +37,12 @@
  ],
  "vk_delta_2": [
   [
-   "15891488507266392457506126879904299590646143497545573658070845046860313168900",
-   "17932936512660402537945596421514282776231371752944152874563145263497597450760"
+   "17217040771673193595057726921783631627855097326348120963208522878512499029330",
+   "13885070462915928008454037293608534517313451468269061002600563284403343119679"
   ],
   [
-   "3499547373407916183334246733416920057398428467450155425825370305197257091551",
-   "19552021655696733860272339514203367725306524797267373214782737566735379534814"
+   "3294658414414120993425471992804336667610262589234319138843342065557453098560",
+   "17737015192861348799337032595899967396123214324126230194042205099833539151635"
   ],
   [
    "1",

package/verification_key_private_link.json

@@ -37,12 +37,12 @@
  ],
  "vk_delta_2": [
   [
-   "10017835699183705898959917136102492144834257686815545884930858162381601990409",
-   "931443350602532557937041795504460956825516039268595684065058096905709951092"
+   "18708088501824770155642880639406132276019586927975426545919843091107665711136",
+   "7281146943269352647233370615143721749052948920156705386694100248139135409054"
   ],
   [
-   "5422627372590078623437693585780294233708885223015825213203251737533870277450",
-   "283187716635581259790955746698071893681197794322898971002784670258068039290"
+   "561349355935335715726998988887632818489251333881052239604755799880817608689",
+   "19376843534964904315969326338320223321824520867819696102836942219623770579841"
   ],
   [
    "1",

package/verification_key_transfer.json

@@ -37,12 +37,12 @@
  ],
  "vk_delta_2": [
   [
-   "13592358905892806894609749704924498653340310428666562825012485043168406251517",
-   "3211692905624887612709603909359343249636321946591964015653041273643645227074"
+   "16534541960038203730922153431011952520231502248102204627778677469454764257863",
+   "612718894073470502899294133376956338400130590801671068885296033589842631143"
   ],
   [
-   "13578083370589112277533348698319334184076656186483533721611127475200402183319",
-   "1108626797718921918393637882276842818263529189049174090035812773418872629637"
+   "13344470759550869768113821122007863796610274203571333884277796728461553136702",
+   "17939730979332296194637439421341086527627400250626716559950805216086863237071"
   ],
   [
    "1",

package/verification_key_unshield.json

@@ -37,12 +37,12 @@
  ],
  "vk_delta_2": [
   [
-   "14018664169821405030103251176282245231130962942915865206666085788024510483344",
-   "18071845854913103053394274596987694171637401535194883546405614579067243429300"
+   "13485340673905960649139915426847429419411563348595946927397116672747480831694",
+   "1095836256349972235647488149588381659699652235902169087555248652538356328950"
   ],
   [
-   "15299874059012859661606442170730830993341770196170954699235150146401785745498",
-   "5987421919169714599301773144652260474271539718465406299442363505585632972816"
+   "1002081672113001348839112824395978772012000343800109361341868255356781827876",
+   "10671240843878105133627292009960428867606819728877311425314008749951591965216"
   ],
   [
    "1",