chore: Generate declaration files for VKs

noir-projects/noir-protocol-circuits/scripts/generate_vk_json.js

@@ -184,18 +184,22 @@ async function readVKFromS3(artifactName, artifactHash) {
   if (process.env.DISABLE_VK_S3_CACHE) {
     return;
   }
+  const key = `${PREFIX}/${artifactName}-${artifactHash}.json`;
 
   try {
     const s3 = generateS3Client();
     const { Body: response } = await s3.getObject({
       Bucket: BUCKET_NAME,
-      Key: `${PREFIX}/${artifactName}-${artifactHash}.json`,
+      Key: key,
     });
 
     const result = JSON.parse(await response.transformToString());
     return result;
   } catch (err) {
-    console.warn("Could not read VK from remote cache", err.message);
+    console.warn(
+      `Could not read VK from remote cache at s3://${BUCKET_NAME}/${key}`,
+      err.message
+    );
     return undefined;
   }
 }

yarn-project/noir-protocol-circuits-types/src/scripts/generate_declaration_files.ts

@@ -3,19 +3,31 @@ import { fileURLToPath } from '@aztec/foundation/url';
 import { readdir, writeFile } from 'fs/promises';
 import { join } from 'path';
 
-const content = `\
+const contract = `\
 import { type NoirCompiledCircuit } from '@aztec/types/noir';
 const circuit: NoirCompiledCircuit;
 export = circuit;
 `;
 
-const target = fileURLToPath(new URL('../../artifacts', import.meta.url).href);
-const files = await readdir(target);
-for (const file of files) {
-  // guard against running this script twice without cleaning the artifacts/ dir first
-  if (!file.endsWith('.json')) {
-    continue;
+const vk = `\
+const vk: { keyAsBytes: string; keyAsFields: string[] };
+export = vk;
+`;
+
+async function generateDeclarationFor(target: string, content: string) {
+  const files = await readdir(target);
+  for (const file of files) {
+    // guard against running this script twice without cleaning the artifacts/ dir first
+    if (!file.endsWith('.json')) {
+      continue;
+    }
+    const name = file.replace('.json', '');
+    await writeFile(join(target, `${name}.d.json.ts`), content);
   }
-  const name = file.replace('.json', '');
-  await writeFile(join(target, `${name}.d.json.ts`), content);
 }
+
+// Generate declaration files for contracts
+await generateDeclarationFor(fileURLToPath(new URL('../../artifacts', import.meta.url).href), contract);
+
+// Generate declaration files for vks
+await generateDeclarationFor(fileURLToPath(new URL('../../artifacts/keys', import.meta.url).href), vk);

yarn-project/noir-protocol-circuits-types/tsconfig.json

@@ -26,5 +26,5 @@
       "path": "../merkle-tree"
     }
   ],
-  "include": ["src", "artifacts/*.d.json.ts"]
+  "include": ["src", "artifacts/*.d.json.ts", "artifacts/**/*.d.json.ts", ]
 }