test: check validity of poseidon artifacts

.biome.jsonc

@@ -17,6 +17,8 @@
   "overrides": [
     {
       "include": [
+        "types/ffjavascript/index.d.ts",
+        "packages/poseidon/test/index.test.ts",
         "packages/artifacts/src/cli/spinner.ts",
         "packages/artifacts/src/cli/commands/generate/action.ts",
       ],

jest.config.ts

@@ -1,6 +1,5 @@
 import { join } from 'node:path'
 import type { JestConfigWithTsJest } from 'ts-jest'
-// import preset from 'ts-jest/'
 
 const config: JestConfigWithTsJest = {
   preset: 'ts-jest',
@@ -12,7 +11,7 @@ const config: JestConfigWithTsJest = {
   },
   moduleDirectories: ['node_modules', '<rootDir>/node_modules', '<rootDir>/src'],
   moduleFileExtensions: ['js', 'ts'],
-  projects: ['packages/artifacts/test'],
+  projects: ['packages/artifacts/test', 'packages/poseidon/test'],
 }
 
 export default config

packages/poseidon/package.json

@@ -17,14 +17,16 @@
   "scripts": {
     "test": "node --test index.test.mjs"
   },
-  "files": ["poseidon-*"],
+  "files": [
+    "poseidon-*"
+  ],
   "devDependencies": {
     "@ethersproject/bignumber": "^5.7.0",
+    "@types/snarkjs": "^0.7.8",
     "@zk-kit/poseidon-proof": "1.0.0-beta.4",
     "@zk-kit/utils": "^1.2.0",
     "ethers": "^6.13.1",
     "ffjavascript": "^0.3.0",
-    "poseidon-lite": "^0.2.0",
     "snarkjs": "^0.7.4"
   }
 }

packages/poseidon/test/index.test.ts

@@ -0,0 +1,59 @@
+import { generate, type PoseidonProof } from '@zk-kit/poseidon-proof'
+import { unpackGroth16Proof } from '@zk-kit/utils'
+import { keccak256 } from 'ethers/crypto'
+import { toBeHex } from 'ethers/utils'
+import { getCurveFromName } from 'ffjavascript'
+import assert from 'node:assert/strict'
+import { readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { groth16 } from 'snarkjs'
+
+const INPUTS = Array.from({ length: 16 }, (_, i) => i + 1).map(i => ({
+  inputs: Array.from({ length: i }, (_, j) => j + 1),
+  numberOfInputs: i,
+}))
+const SCOPE = 'scope'
+
+const hash = (message: string) => (BigInt(keccak256(toBeHex(message, 32))) >> BigInt(8)).toString()
+
+async function generateProof(preimages: number[]) {
+  const numParams = preimages.length
+
+  return generate(preimages, SCOPE, {
+    wasm: join(__dirname, '..', `poseidon-${numParams}.wasm`),
+    zkey: join(__dirname, '..', `poseidon-${numParams}.zkey`),
+  })
+}
+
+async function verifyProof(
+  { digest, numberOfInputs, proof, scope }: PoseidonProof,
+) {
+  const verifKey = JSON.parse(readFileSync(join(__dirname, '..', `poseidon-${numberOfInputs}.json`), 'utf8'))
+  return groth16.verify(verifKey, [digest, hash(scope)], unpackGroth16Proof(proof))
+}
+
+describe('poseidon', () => {
+  let curve: any
+
+  beforeAll(async () => {
+    curve = await getCurveFromName('bn128')
+  }, 30_000)
+
+  afterAll(async () => {
+    await curve.terminate()
+  })
+
+  it.each(INPUTS)(
+    'Should verify a poseidon proof with $numberOfInputs input(s)',
+    async ({ inputs, numberOfInputs }) => {
+      const s = `${numberOfInputs > 1 ? 's' : ''}`
+      const proof = await generateProof(inputs)
+      const result = await verifyProof(proof)
+      assert.strictEqual(
+        result,
+        true,
+        `Proof verification failed for ${numberOfInputs} parameter${s}`,
+      )
+    },
+  )
+})

packages/artifacts/test/cli/jest.config.ts → packages/poseidon/test/jest.config.ts

@@ -1,12 +1,12 @@
 import type { JestConfigWithTsJest } from 'ts-jest'
-import _sharedJestConf from '../../../../jest.config'
+import _sharedJestConf from '../../../jest.config'
 
 const { collectCoverage, projects, ...sharedJestConf } = _sharedJestConf
 
 const config: JestConfigWithTsJest = {
   ...sharedJestConf,
-  displayName: 'cli',
-  rootDir: '../..',
+  displayName: 'poseidon',
+  rootDir: '..',
 }
 
 export default config

tsconfig.json

@@ -23,7 +23,8 @@
     "useUnknownInCatchVariables": false,
     "declaration": true,
     "allowSyntheticDefaultImports": true,
-    "declarationDir": "types"
+    "declarationDir": "types",
+    "typeRoots": ["node_modules/@types", "types"]
   },
-  "include": ["jest.config.ts"]
+  "include": ["jest.config.ts", "packages/artifacts/test", "packages/poseidon/test"]
 }

types/ffjavascript/index.d.ts

@@ -0,0 +1,3 @@
+declare module 'ffjavascript' {
+  export function getCurveFromName(name: any, singleThread?: any, plugins?: any): any
+}