@unlink-xyz/core 0.1.0

package/dist/utils/validators.js

@@ -0,0 +1,70 @@
+import { CoreError } from "../errors.js";
+import { assertNonNegative } from "./bigint.js";
+export const SNARK_SCALAR_FIELD = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+export function ensurePositiveInt(label, value) {
+    if (!Number.isInteger(value) || value < 0) {
+        throw new CoreError(`${label} must be a non-negative integer`);
+    }
+}
+export function ensureChainId(chainId) {
+    if (!Number.isInteger(chainId) || chainId <= 0) {
+        throw new CoreError("chainId must be a positive integer");
+    }
+}
+/** Guards master public key strings against empty values. */
+export function ensureMpk(mpk) {
+    if (typeof mpk !== "string" || mpk.length === 0) {
+        throw new CoreError("note mpk must be a non-empty string");
+    }
+}
+export function ensureBigIntString(label, value) {
+    let parsed;
+    try {
+        parsed = BigInt(value);
+    }
+    catch {
+        throw new CoreError(`${label} must be a base-10 bigint string`);
+    }
+    if (parsed < 0n) {
+        throw new CoreError(`${label} must be non-negative`);
+    }
+}
+const ADDRESS_REGEX = /^0x[0-9a-fA-F]{40}$/;
+export function ensureAddress(label, value) {
+    if (typeof value !== "string" || !ADDRESS_REGEX.test(value)) {
+        throw new CoreError(`${label} must be a 0x-prefixed hex address`);
+    }
+}
+/** Confirms the bigint resides in the SNARK scalar field range. */
+export function ensureFieldElement(label, value) {
+    if (value < 0n) {
+        throw new CoreError(`${label} must be a non-negative field element`);
+    }
+    if (value >= SNARK_SCALAR_FIELD) {
+        throw new CoreError(`${label} must be less than the SNARK scalar field`);
+    }
+}
+/** Validates withdrawal note public data before encoding calldata. */
+export function ensureWithdrawalInput(label, withdrawal) {
+    assertNonNegative(`${label}.npk`, withdrawal.npk);
+    ensureFieldElement(`${label}.npk`, withdrawal.npk);
+    assertNonNegative(`${label}.amount`, withdrawal.amount);
+    // if (withdrawal.amount === 0n) {
+    //   throw new CoreError(`${label}.amount must be greater than zero`);
+    // }
+    ensureFieldElement(`${label}.amount`, withdrawal.amount);
+    ensureAddress(`${label}.token`, withdrawal.token);
+    return withdrawal;
+}
+/** Validates note parameters before producing a Poseidon commitment. */
+export function ensureNoteCommitmentInput(label, note) {
+    assertNonNegative(`${label}.npk`, note.npk);
+    ensureFieldElement(`${label}.npk`, note.npk);
+    assertNonNegative(`${label}.amount`, note.amount);
+    if (note.amount === 0n) {
+        throw new CoreError(`${label}.amount must be greater than zero`);
+    }
+    ensureFieldElement(`${label}.amount`, note.amount);
+    ensureAddress(`${label}.token`, note.token);
+    return note;
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@unlink-xyz/core",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist"],
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier . --write",
+    "format:check": "prettier . --check",
+    "test": "tsc -p tsconfig.json && vitest run --test-timeout 0",
+    "setup:artifacts": "./setup-artifacts.sh"
+  },
+  "dependencies": {
+    "@noble/ed25519": "3.0.0",
+    "@noble/hashes": "2.0.0",
+    "@railgun-community/circomlibjs": "0.0.8",
+    "@scure/base": "2.0.0",
+    "@scure/bip39": "2.0.1",
+    "@types/snarkjs": "^0.7.9",
+    "@zk-kit/imt": "2.0.0-beta.8",
+    "ethereum-cryptography": "3.2.0",
+    "ethers": "6.15.0",
+    "ky": "^1.14.0",
+    "snarkjs": "^0.7.5",
+    "tweetnacl": "^1.0.3",
+    "uuid": "^13.0.0"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.1.0",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.57.1",
+    "fake-indexeddb": "6.2.4",
+    "prettier": "^3.5.3",
+    "typescript": "^5.9.2",
+    "vitest": "4.0.1"
+  }
+}