refactor(utils): remove @zk-kit/utils/snark-artifacts (#288)

* refactor(utils): remove `@zk-kit/utils/snark-artifacts`

Move it into `@zk-kit/artifacts`
https://github.com/privacy-scaling-explorations/snark-artifacts

re #287

* chore: add `@zk-kit/artifacts` dep

* chore: update `rollup.config.ts`

jest.config.ts

@@ -12,6 +12,7 @@ const projects: any = fs
         rootDir: `packages/${name}`,
         displayName: name,
         moduleNameMapper: {
+            "@zk-kit/artifacts": ["<rootDir>/../../node_modules/@zk-kit/artifacts/dist/index.node.cjs"],
             "@zk-kit/(.*)/(.*)": ["<rootDir>/../$1/src/$2.ts", "<rootDir>/../$1/src/$2/$2.node.ts"],
             "@zk-kit/(.*)": "<rootDir>/../$1/src/index.ts"
         }

packages/poseidon-proof/package.json

@@ -44,6 +44,7 @@
         "rollup-plugin-cleanup": "^3.2.1"
     },
     "dependencies": {
+        "@zk-kit/artifacts": "^1.3.1",
         "@zk-kit/utils": "1.0.0-beta.4",
         "ethers": "^6.12.0",
         "snarkjs": "^0.7.3"

packages/poseidon-proof/src/generate.ts

@@ -1,7 +1,6 @@
 import { BigNumber } from "@ethersproject/bignumber"
-import type { SnarkArtifacts } from "@zk-kit/utils"
+import { maybeGetSnarkArtifacts, Project, type SnarkArtifacts } from "@zk-kit/artifacts"
 import { packGroth16Proof } from "@zk-kit/utils/proof-packing"
-import maybeGetSnarkArtifacts, { Project } from "@zk-kit/utils/snark-artifacts"
 import { BigNumberish } from "ethers"
 import { NumericString, groth16 } from "snarkjs"
 import hash from "./hash"

packages/utils/rollup.config.ts

@@ -44,13 +44,7 @@ export default [
         external: Object.keys(pkg.dependencies),
         plugins: [
             alias({
-                entries: [
-                    { find: "./crypto/crypto.node", replacement: "./crypto/crypto.browser" },
-                    {
-                        find: "./snark-artifacts/snark-artifacts.node",
-                        replacement: "./snark-artifacts/snark-artifacts.browser"
-                    }
-                ]
+                entries: [{ find: "./crypto/crypto.node", replacement: "./crypto/crypto.browser" }]
             }),
             typescript({
                 tsconfig: "./build.tsconfig.json"
@@ -77,13 +71,7 @@ export default [
         external: [],
         plugins: [
             alias({
-                entries: [
-                    { find: "./crypto/crypto.node", replacement: "./crypto/crypto.browser" },
-                    {
-                        find: "./snark-artifacts/snark-artifacts.node",
-                        replacement: "./snark-artifacts/snark-artifacts.browser"
-                    }
-                ]
+                entries: [{ find: "./crypto/crypto.node", replacement: "./crypto/crypto.browser" }]
             }),
             typescript({
                 tsconfig: "./build.tsconfig.json"

packages/utils/src/index.ts

@@ -4,12 +4,11 @@ import * as errorHandlers from "./error-handlers"
 import F1Field from "./f1-field"
 import * as packing from "./proof-packing"
 import * as scalar from "./scalar"
-import maybeGetSnarkArtifacts from "./snark-artifacts/snark-artifacts.node"
 import * as typeChecks from "./type-checks"
 
 export * from "./conversions"
 export * from "./error-handlers"
 export * from "./proof-packing"
 export * from "./type-checks"
 export * from "./types"
-export { F1Field, conversions, crypto, errorHandlers, maybeGetSnarkArtifacts, packing, scalar, typeChecks }
+export { F1Field, conversions, crypto, errorHandlers, packing, scalar, typeChecks }

packages/utils/src/types/index.ts

@@ -15,27 +15,3 @@ export type PackedGroth16Proof = [
     NumericString,
     NumericString
 ]
-
-/**
- * @prop SnarkArtifacts.wasm
- * @prop SnarkArtifacts.zkey
- * @interface
- */
-export type SnarkArtifacts = Record<"wasm" | "zkey", string>
-
-type Digit = `${number}`
-type PreRelease = "alpha" | "beta"
-
-/**
- * Semantic version.
- * @example
- * 1.0.0-beta
- * 2.0.0
- * @example
- * "latest"
- */
-export type Version =
-    | `${Digit}.${Digit}.${Digit}`
-    | `${Digit}.${Digit}.${Digit}-${PreRelease}`
-    | `${Digit}.${Digit}.${Digit}-${PreRelease}.${Digit}`
-    | "latest"

yarn.lock

@@ -3437,6 +3437,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@zk-kit/artifacts@npm:^1.3.1":
+  version: 1.3.1
+  resolution: "@zk-kit/artifacts@npm:1.3.1"
+  checksum: 10/8be21e3967c05b0b8ed250db84c0d37c86bcbc389b0792b55b27313c5b8fdae03e8fd5fdcafd8dfcbabee253f7d90669c485b168790eaf96e60e38261698a4d4
+  languageName: node
+  linkType: hard
+
 "@zk-kit/baby-jubjub@npm:1.0.0, @zk-kit/baby-jubjub@workspace:packages/baby-jubjub":
   version: 0.0.0-use.local
   resolution: "@zk-kit/baby-jubjub@workspace:packages/baby-jubjub"
@@ -3590,6 +3597,7 @@ __metadata:
     "@types/download": "npm:^8.0.5"
     "@types/snarkjs": "npm:^0"
     "@types/tmp": "npm:^0.2.6"
+    "@zk-kit/artifacts": "npm:^1.3.1"
     "@zk-kit/utils": "npm:1.0.0-beta.4"
     ethers: "npm:^6.12.0"
     poseidon-lite: "npm:^0.2.0"