Rough cut of modifying sindri.json when adding it.

libs/remix-ws-templates/src/script-templates/sindri/index.ts

@@ -1,36 +1,89 @@
-export const sindriScripts = async (plugin) => {
-  await plugin.call('fileManager', 'writeFile',
-    'scripts/sindri/utils.ts' ,
-    // @ts-ignore
-    (await import('!!raw-loader!./utils.ts')).default)
+const getWorkspaceFilesByPath = async (plugin: any, pathRegex: RegExp | null = null): Promise<{[path: string]: File}> => {
+  const filesByPath: {[path: string]: File} = {}
+  interface Workspace {
+    children?: Workspace
+    content?: string
+  }
+  const workspace: Workspace = await plugin.call('fileManager', 'copyFolderToJson', '/')
+  const childQueue: Array<[string, Workspace]> = Object.entries(workspace)
+  while (childQueue.length > 0) {
+    const [path, child] = childQueue.pop()
+    if ('content' in child && (pathRegex === null || pathRegex.test(path))) {
+      filesByPath[path] = new File([child.content], path)
+    }
+    if ('children' in child) {
+      childQueue.push(...Object.entries(child.children))
+    }
+  }
+  return filesByPath
+}
 
-  await plugin.call('fileManager', 'writeFile',
-    'scripts/sindri/run_compile.ts' ,
-    // @ts-ignore
-    (await import('!!raw-loader!./run_compile.ts')).default)
+export const sindriScripts = async (plugin: any) => {
+  // Load in all of the Sindri or Circom-related files in the workspace.
+  const existingFilesByPath = await getWorkspaceFilesByPath(plugin, /sindri|\.circom$/i)
+  const writeIfNotExists = async (path: string, content: string) => {
+    if (!(path in existingFilesByPath)) {
+      await plugin.call('fileManager', 'writeFile', path, content)
+    }
+  }
 
-  await plugin.call('fileManager', 'writeFile',
-    'scripts/sindri/run_prove.ts' ,
+  // Write out all of the static files if they don't exist.
+  // @ts-ignore
+  await writeIfNotExists('scripts/.sindriignore', (await import('!!raw-loader!./.sindriignore')).default)
+  // @ts-ignore
+  await writeIfNotExists('scripts/sindri/utils.ts', (await import('!!raw-loader!./utils.ts')).default)
+  // @ts-ignore
+  await writeIfNotExists('scripts/sindri/run_compile.ts', (await import('!!raw-loader!./run_compile.ts')).default)
+  // @ts-ignore
+  await writeIfNotExists('scripts/sindri/run_prove.ts', (await import('!!raw-loader!./run_prove.ts')).default)
+
+  // Only write out the `sindri.json` file if it doesn't already exist.
+  if (!('sindri.json' in existingFilesByPath)) {
     // @ts-ignore
-    (await import('!!raw-loader!./run_prove.ts')).default)
+    const sindriManifest = (await import('./sindri.json')).default
 
-  const existingFiles = await plugin.call('fileManager', 'readdir', '')
+    // Infer manifest properties from the existing files in the workspace.
+    switch (sindriManifest.circuitType) {
+      case 'circom':
+        // Try to find the best `.circom` source file to use as the main component.
+        // First, we limit ourselves to `.circom` files.
+        const circomPathsAndContents = await Promise.all(
+          Object.entries(existingFilesByPath)
+            .filter(([path]) => /\.circom$/i.test(path))
+            .map(async ([path, file]) => [path, await file.text()])
+        )
+        // Now we apply some heuristics to find the "best" file.
+        const circomCircuitPath =
+          circomPathsAndContents
+            .map(([path, content]) => ({
+              content,
+              hasMainComponent: !!/^[ \t\f]*component[ \t\f]+main[^\n\r]*;[ \t\f]*$/m.test(content),
+              // These files are the entrypoints to the Remix Circom templates, so we give them a boost if there are multiple main components.
+              isTemplateEntrypoint: !!['calculate_hash.circom', 'rln.circom', 'semaphore.circom'].includes(path.split('/').pop() ?? ''),
+              path,
+            }))
+            .sort((a, b) => {
+              if (a.hasMainComponent !== b.hasMainComponent) return +b.hasMainComponent - +a.hasMainComponent
+              if (a.isTemplateEntrypoint !== b.isTemplateEntrypoint) return +b.isTemplateEntrypoint - +a.isTemplateEntrypoint
+              return a.path.localeCompare(b.path)
+            })
+            .map(({path}) => path)[0] || './circuit.circom'
 
-  // Only write out the `.sindriignore` file if it doesn't already exist.
-  if (!('.sindriignore' in existingFiles)) {
-    await plugin.call('fileManager', 'writeFile',
-      '.sindriignore',
-      // @ts-ignore
-      (await import('raw-loader!./.sindriignore')).default)
-  }
+        // Use the basename of the circuit path as the circuit name.
+        const circomCircuitName =
+          circomCircuitPath
+            .split('/')
+            .pop()
+            .replace(/\.circom$/i, '') || 'my-circom-circuit'
+        sindriManifest.name = circomCircuitName
+        sindriManifest.circuitPath = circomCircuitPath
+        break
+    }
 
-  // Only write out the `sindri.json` file if it doesn't already exist.
-  if (!('sindri.json' in existingFiles)) {
-    await plugin.call('fileManager', 'writeFile',
-      'sindri.json',
-      // @ts-ignore
-      (await import('./sindri.json.raw!=!raw-loader!./sindri.json')).default)
-  }
+    // Remove any unsupported characters from the circuit name.
+    sindriManifest.name = (sindriManifest.name || '').replace(/[^-a-zA-Z0-9_]+/g, '-')
 
-  await plugin.call('fileManager', 'open', 'scripts/sindri/sindri.ts')
+    // Write out the modified manifest file.
+    writeIfNotExists('sindri.json', JSON.stringify(sindriManifest, null, 2))
+  }
 }