@coordination-network/zk-artifacts 0.0.1

package/dist/browser.js

@@ -0,0 +1,31 @@
+// Vite and webpack only rewrite `new URL(<string literal>, import.meta.url)`, so each
+// artifact needs its own literal: build one from a variable and the bundler emits no
+// asset and the URL is wrong at runtime.
+const URLS = {
+    "circuit.json": new URL("../credential/circuit.json", import.meta.url),
+    vk: new URL("../credential/vk", import.meta.url)
+};
+/** Where the bundler placed `artifact`. */
+function credentialArtifactUrl(artifact) {
+    return new URL(URLS[artifact]);
+}
+const fetchArtifact = async (artifact) => {
+    const response = await fetch(URLS[artifact]);
+    if (!response.ok) {
+        throw new Error(`failed to fetch ${artifact}: ${response.status} ${response.statusText}`);
+    }
+    return response;
+};
+/** Fetches the compiled credential circuit. */
+async function getCredentialCircuit() {
+    return (await (await fetchArtifact("circuit.json")).json());
+}
+/**
+ * Fetches the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+async function getCredentialVerificationKey() {
+    return new Uint8Array(await (await fetchArtifact("vk")).arrayBuffer());
+}
+
+export { credentialArtifactUrl, getCredentialCircuit, getCredentialVerificationKey };

package/dist/index.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+var promises = require('node:fs/promises');
+var node_url = require('node:url');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+// Written as separate literals rather than a template so a bundler that resolves this
+// entry can still see which files are referenced. The URLs are relative to the built
+// module in `dist/`, which sits at the same depth as `src/`, so both resolve alike.
+const URLS = {
+    "circuit.json": new URL("../credential/circuit.json", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))),
+    vk: new URL("../credential/vk", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))
+};
+/** Where this package keeps `artifact`, as a `file:` URL. */
+function credentialArtifactUrl(artifact) {
+    return new URL(URLS[artifact]);
+}
+/**
+ * Where this package keeps `artifact`, as an absolute path, for callers that take a
+ * path rather than the file's contents.
+ */
+function credentialArtifactPath(artifact) {
+    return node_url.fileURLToPath(URLS[artifact]);
+}
+/** Reads the compiled credential circuit. */
+async function getCredentialCircuit() {
+    return JSON.parse(await promises.readFile(URLS["circuit.json"], "utf8"));
+}
+/**
+ * Reads the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+async function getCredentialVerificationKey() {
+    return new Uint8Array(await promises.readFile(URLS.vk));
+}
+
+exports.credentialArtifactPath = credentialArtifactPath;
+exports.credentialArtifactUrl = credentialArtifactUrl;
+exports.getCredentialCircuit = getCredentialCircuit;
+exports.getCredentialVerificationKey = getCredentialVerificationKey;

package/dist/index.js

@@ -0,0 +1,34 @@
+import { readFile } from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
+
+// Written as separate literals rather than a template so a bundler that resolves this
+// entry can still see which files are referenced. The URLs are relative to the built
+// module in `dist/`, which sits at the same depth as `src/`, so both resolve alike.
+const URLS = {
+    "circuit.json": new URL("../credential/circuit.json", import.meta.url),
+    vk: new URL("../credential/vk", import.meta.url)
+};
+/** Where this package keeps `artifact`, as a `file:` URL. */
+function credentialArtifactUrl(artifact) {
+    return new URL(URLS[artifact]);
+}
+/**
+ * Where this package keeps `artifact`, as an absolute path, for callers that take a
+ * path rather than the file's contents.
+ */
+function credentialArtifactPath(artifact) {
+    return fileURLToPath(URLS[artifact]);
+}
+/** Reads the compiled credential circuit. */
+async function getCredentialCircuit() {
+    return JSON.parse(await readFile(URLS["circuit.json"], "utf8"));
+}
+/**
+ * Reads the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+async function getCredentialVerificationKey() {
+    return new Uint8Array(await readFile(URLS.vk));
+}
+
+export { credentialArtifactPath, credentialArtifactUrl, getCredentialCircuit, getCredentialVerificationKey };

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@coordination-network/zk-artifacts",
+  "version": "0.0.1",
+  "description": "Compiled zero-knowledge artifacts for the coordination network: the credential circuit's ACIR bytecode and ABI, and its Barretenberg UltraHonk verification key.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zk-kit/coordination-network.git",
+    "directory": "packages/zk-artifacts"
+  },
+  "homepage": "https://github.com/zk-kit/coordination-network/tree/main/packages/zk-artifacts",
+  "bugs": "https://github.com/zk-kit/coordination-network/issues",
+  "sideEffects": false,
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "types": "./types/browser.d.ts",
+        "default": "./dist/browser.js"
+      },
+      "require": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "default": {
+        "types": "./types/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./browser": {
+      "types": "./types/browser.d.ts",
+      "default": "./dist/browser.js"
+    },
+    "./credential/circuit.json": "./credential/circuit.json",
+    "./credential/vk": "./credential/vk",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "credential/",
+    "dist/",
+    "types/",
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "noir",
+    "barretenberg",
+    "ultrahonk",
+    "zero-knowledge",
+    "circuit",
+    "verification-key",
+    "verifiable-credentials"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@noir-lang/noir_js": "1.0.0-beta.22"
+  },
+  "scripts": {
+    "build": "rimraf dist types && rollup -c rollup.config.mjs",
+    "sync": "tsx scripts/sync.ts",
+    "test": "tsc --noEmit && tsx --test tests/*.test.ts"
+  },
+  "devDependencies": {
+    "@noir-lang/noir_js": "1.0.0-beta.22",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^24.0.0",
+    "rimraf": "^6.1.3",
+    "rollup": "^4.62.2",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-dts": "^6.4.1",
+    "tslib": "^2.8.0",
+    "tsx": "^4.23.0",
+    "typescript": "^6.0.3"
+  }
+}

package/src/browser.ts

@@ -0,0 +1,37 @@
+import type { CompiledCircuit, CredentialArtifact, CredentialCircuit } from "./types"
+
+export type { CompiledCircuit, CredentialArtifact, CredentialCircuit }
+
+// Vite and webpack only rewrite `new URL(<string literal>, import.meta.url)`, so each
+// artifact needs its own literal: build one from a variable and the bundler emits no
+// asset and the URL is wrong at runtime.
+const URLS: Record<CredentialArtifact, URL> = {
+    "circuit.json": new URL("../credential/circuit.json", import.meta.url),
+    vk: new URL("../credential/vk", import.meta.url)
+}
+
+/** Where the bundler placed `artifact`. */
+export function credentialArtifactUrl(artifact: CredentialArtifact): URL {
+    return new URL(URLS[artifact])
+}
+
+const fetchArtifact = async (artifact: CredentialArtifact): Promise<Response> => {
+    const response = await fetch(URLS[artifact])
+    if (!response.ok) {
+        throw new Error(`failed to fetch ${artifact}: ${response.status} ${response.statusText}`)
+    }
+    return response
+}
+
+/** Fetches the compiled credential circuit. */
+export async function getCredentialCircuit(): Promise<CredentialCircuit> {
+    return (await (await fetchArtifact("circuit.json")).json()) as CredentialCircuit
+}
+
+/**
+ * Fetches the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+export async function getCredentialVerificationKey(): Promise<Uint8Array> {
+    return new Uint8Array(await (await fetchArtifact("vk")).arrayBuffer())
+}

package/src/index.ts

@@ -0,0 +1,39 @@
+import { readFile } from "node:fs/promises"
+import { fileURLToPath } from "node:url"
+import type { CompiledCircuit, CredentialArtifact, CredentialCircuit } from "./types"
+
+export type { CompiledCircuit, CredentialArtifact, CredentialCircuit }
+
+// Written as separate literals rather than a template so a bundler that resolves this
+// entry can still see which files are referenced. The URLs are relative to the built
+// module in `dist/`, which sits at the same depth as `src/`, so both resolve alike.
+const URLS: Record<CredentialArtifact, URL> = {
+    "circuit.json": new URL("../credential/circuit.json", import.meta.url),
+    vk: new URL("../credential/vk", import.meta.url)
+}
+
+/** Where this package keeps `artifact`, as a `file:` URL. */
+export function credentialArtifactUrl(artifact: CredentialArtifact): URL {
+    return new URL(URLS[artifact])
+}
+
+/**
+ * Where this package keeps `artifact`, as an absolute path, for callers that take a
+ * path rather than the file's contents.
+ */
+export function credentialArtifactPath(artifact: CredentialArtifact): string {
+    return fileURLToPath(URLS[artifact])
+}
+
+/** Reads the compiled credential circuit. */
+export async function getCredentialCircuit(): Promise<CredentialCircuit> {
+    return JSON.parse(await readFile(URLS["circuit.json"], "utf8")) as CredentialCircuit
+}
+
+/**
+ * Reads the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+export async function getCredentialVerificationKey(): Promise<Uint8Array> {
+    return new Uint8Array(await readFile(URLS.vk))
+}

package/src/types.ts

@@ -0,0 +1,23 @@
+import type { CompiledCircuit } from "@noir-lang/noir_js"
+
+/** The files this package publishes for the credential circuit. */
+export type CredentialArtifact = "circuit.json" | "vk"
+
+/**
+ * What nargo actually writes. `CompiledCircuit` covers the four fields
+ * `@noir-lang/noir_js` consumes; these two record which compiler produced the
+ * artifact and the program hash it settled on, and are the only provenance the
+ * package carries.
+ */
+export type CredentialCircuit = CompiledCircuit & {
+    /** The nargo release that compiled it, as `1.0.0-beta.22+<commit>`. */
+    readonly noir_version: string
+    /** nargo's own hash of the compiled program, a u64 serialised as a string. */
+    readonly hash: string
+}
+
+/**
+ * The compiled credential circuit, as `@noir-lang/noir_js` and
+ * `@coordination-network/credential` consume it.
+ */
+export type { CompiledCircuit }

package/types/browser.d.ts

@@ -0,0 +1,30 @@
+import { CompiledCircuit } from '@noir-lang/noir_js';
+export { CompiledCircuit } from '@noir-lang/noir_js';
+
+/** The files this package publishes for the credential circuit. */
+type CredentialArtifact = "circuit.json" | "vk";
+/**
+ * What nargo actually writes. `CompiledCircuit` covers the four fields
+ * `@noir-lang/noir_js` consumes; these two record which compiler produced the
+ * artifact and the program hash it settled on, and are the only provenance the
+ * package carries.
+ */
+type CredentialCircuit = CompiledCircuit & {
+    /** The nargo release that compiled it, as `1.0.0-beta.22+<commit>`. */
+    readonly noir_version: string;
+    /** nargo's own hash of the compiled program, a u64 serialised as a string. */
+    readonly hash: string;
+};
+
+/** Where the bundler placed `artifact`. */
+declare function credentialArtifactUrl(artifact: CredentialArtifact): URL;
+/** Fetches the compiled credential circuit. */
+declare function getCredentialCircuit(): Promise<CredentialCircuit>;
+/**
+ * Fetches the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+declare function getCredentialVerificationKey(): Promise<Uint8Array>;
+
+export { credentialArtifactUrl, getCredentialCircuit, getCredentialVerificationKey };
+export type { CredentialArtifact, CredentialCircuit };

package/types/index.d.ts

@@ -0,0 +1,35 @@
+import { CompiledCircuit } from '@noir-lang/noir_js';
+export { CompiledCircuit } from '@noir-lang/noir_js';
+
+/** The files this package publishes for the credential circuit. */
+type CredentialArtifact = "circuit.json" | "vk";
+/**
+ * What nargo actually writes. `CompiledCircuit` covers the four fields
+ * `@noir-lang/noir_js` consumes; these two record which compiler produced the
+ * artifact and the program hash it settled on, and are the only provenance the
+ * package carries.
+ */
+type CredentialCircuit = CompiledCircuit & {
+    /** The nargo release that compiled it, as `1.0.0-beta.22+<commit>`. */
+    readonly noir_version: string;
+    /** nargo's own hash of the compiled program, a u64 serialised as a string. */
+    readonly hash: string;
+};
+
+/** Where this package keeps `artifact`, as a `file:` URL. */
+declare function credentialArtifactUrl(artifact: CredentialArtifact): URL;
+/**
+ * Where this package keeps `artifact`, as an absolute path, for callers that take a
+ * path rather than the file's contents.
+ */
+declare function credentialArtifactPath(artifact: CredentialArtifact): string;
+/** Reads the compiled credential circuit. */
+declare function getCredentialCircuit(): Promise<CredentialCircuit>;
+/**
+ * Reads the credential circuit's UltraHonk verification key, in the binary encoding
+ * `UltraHonkVerifierBackend.verifyProof` takes.
+ */
+declare function getCredentialVerificationKey(): Promise<Uint8Array>;
+
+export { credentialArtifactPath, credentialArtifactUrl, getCredentialCircuit, getCredentialVerificationKey };
+export type { CredentialArtifact, CredentialCircuit };