-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
sindri init command for project scaffolding (initially gnark-only)
This adds a new `sindri init` command and all of the boilerplate around
scaffolding out projects under the `templates/{{ circuitType }}/` directory. It
includes `gnark` as a proof of concept.
Merges #19- Loading branch information
Showing
16 changed files
with
519 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| import { execSync } from "child_process"; | ||
| import { existsSync, mkdirSync, readdirSync, rmSync, statSync } from "fs"; | ||
| import path from "path"; | ||
| import process from "process"; | ||
|
|
||
| import { Command } from "@commander-js/extra-typings"; | ||
| import { confirm, input, select } from "@inquirer/prompts"; | ||
|
|
||
| import { logger } from "cli/logging"; | ||
| import { scaffoldDirectory } from "cli/utils"; | ||
|
|
||
| export const initCommand = new Command() | ||
| .name("init") | ||
| .description("Initialize a new Sindri project.") | ||
| .argument( | ||
| "[directory]", | ||
| "The directory where the new project should be initialized.", | ||
| ".", | ||
| ) | ||
| .action(async (directory) => { | ||
| // Prepare the directory paths. | ||
| const directoryPath = path.resolve(directory); | ||
| const directoryName = path.basename(directoryPath); | ||
|
|
||
| // Ensure that the directory exists. | ||
| if (!existsSync(directoryPath)) { | ||
| mkdirSync(directoryPath, { recursive: true }); | ||
| } else if (!statSync(directoryPath).isDirectory()) { | ||
| logger.warn( | ||
| `File "${directoryPath}" exists and is not a directory, aborting.`, | ||
| ); | ||
| return process.exit(1); | ||
| } | ||
|
|
||
| // Check that the directory is empty. | ||
| const existingFiles = readdirSync(directoryPath); | ||
| if (existingFiles.length > 0) { | ||
| const proceed = await confirm({ | ||
| message: | ||
| `The "${directoryPath}" directory already exists and contains files. Continuing will ` + | ||
| "overwrite your existing files. Are you *SURE* you would like to proceed?", | ||
| default: false, | ||
| }); | ||
| if (!proceed) { | ||
| logger.info("Aborting."); | ||
| return process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| // Collect common fields. | ||
| const circuitName = await input({ | ||
| message: "Circuit Name:", | ||
| default: directoryName.replace(/[^-a-zA-Z0-9_]/g, "-"), | ||
| validate: (input): boolean | string => { | ||
| if (input.length === 0) { | ||
| return "You must specify a circuit name."; | ||
| } | ||
| if (!/^[-a-zA-Z0-9_]+$/.test(input)) { | ||
| return "Only alphanumeric characters, hyphens, and underscores are allowed."; | ||
| } | ||
| return true; | ||
| }, | ||
| }); | ||
| const circuitType: "circom" | "gnark" | "halo2" | "noir" = await select({ | ||
| message: "Proving Framework:", | ||
| default: "gnark", | ||
| choices: [ | ||
| { name: "Circom", value: "circom" }, | ||
| { name: "Gnark", value: "gnark" }, | ||
| { name: "Halo2", value: "halo2" }, | ||
| { name: "Noir", value: "noir" }, | ||
| ], | ||
| }); | ||
| const context: object = { circuitName, circuitType }; | ||
|
|
||
| // Handle individual circuit types. | ||
| // Gnark. | ||
| if (circuitType === "gnark") { | ||
| const packageName = await input({ | ||
| message: "Go Package Name:", | ||
| default: circuitName | ||
| .replace(/[^a-zA-Z0-9]/g, "") | ||
| .replace(/^[^a-z]*/, ""), | ||
| validate: (input): boolean | string => { | ||
| if (input.length === 0) { | ||
| return "You must specify a package name."; | ||
| } | ||
| if (!/^[a-z][a-z0-9]*$/.test(input)) { | ||
| return ( | ||
| "Package names must begin with a lowercase letter and only be followed by " + | ||
| "alphanumeric characters." | ||
| ); | ||
| } | ||
| return true; | ||
| }, | ||
| }); | ||
| const provingScheme: "groth16" = await select({ | ||
| message: "Proving Scheme:", | ||
| default: "groth16", | ||
| choices: [{ name: "Groth16", value: "groth16" }], | ||
| }); | ||
| const curveName: | ||
| | "bn254" | ||
| | "bls12-377" | ||
| | "bls12-381" | ||
| | "bls24-315" | ||
| | "bw6-633" | ||
| | "bw6-761" = await select({ | ||
| message: "Curve Name:", | ||
| default: "bn254", | ||
| choices: [ | ||
| { name: "BN254", value: "bn254" }, | ||
| { name: "BLS12-377", value: "bls12-377" }, | ||
| { name: "BLS12-381", value: "bls12-381" }, | ||
| { name: "BLS24-315", value: "bls24-315" }, | ||
| { name: "BW6-633", value: "bw6-633" }, | ||
| { name: "BW6-761", value: "bw6-761" }, | ||
| ], | ||
| }); | ||
| const gnarkCurveName = curveName.toUpperCase().replace("-", "_"); | ||
| Object.assign(context, { | ||
| curveName, | ||
| gnarkCurveName, | ||
| packageName, | ||
| provingScheme, | ||
| }); | ||
| } else { | ||
| logger.fatal(`Sorry, ${circuitType} is not yet supported.`); | ||
| return process.exit(1); | ||
| } | ||
|
|
||
| // Perform the scaffolding. | ||
| logger.info( | ||
| `Proceeding to generate scaffolded project in "${directoryPath}".`, | ||
| ); | ||
| await scaffoldDirectory("common", directoryPath, context); | ||
| await scaffoldDirectory(circuitType, directoryPath, context); | ||
| // We use this in `common` right now to keep the directory tracked, we can remove this once we | ||
| // add files there. | ||
| const gitKeepFile = path.join(directoryPath, ".gitkeep"); | ||
| if (existsSync(gitKeepFile)) { | ||
| rmSync(gitKeepFile); | ||
| } | ||
| logger.info("Project scaffolding successful."); | ||
|
|
||
| // Optionally, initialize a git repository. | ||
| let gitInstalled: boolean = false; | ||
| try { | ||
| execSync("git --version"); | ||
| gitInstalled = true; | ||
| } catch { | ||
| logger.debug( | ||
| "Git is not installed, skipping git initialization questions.", | ||
| ); | ||
| } | ||
| const gitAlreadyInitialized = existsSync(path.join(directoryPath, ".git")); | ||
| if (gitInstalled && !gitAlreadyInitialized) { | ||
| const initializeGit = await confirm({ | ||
| message: `Would you like to initialize a git repository in "${directoryPath}"?`, | ||
| default: true, | ||
| }); | ||
| if (initializeGit) { | ||
| logger.info(`Initializing git repository in "${directoryPath}".`); | ||
| try { | ||
| execSync("git init .", { cwd: directoryPath }); | ||
| execSync("git add .", { cwd: directoryPath }); | ||
| execSync("git commit -m 'Initial commit.'", { cwd: directoryPath }); | ||
| logger.info("Successfully initialized git repository."); | ||
| } catch (error) { | ||
| logger.error("Error occurred while initializing the git repository."); | ||
| // Node.js doesn't seem to have a typed version of this error, so we assert it as | ||
| // something that's at least in the right ballpark. | ||
| const execError = error as NodeJS.ErrnoException & { | ||
| output: Buffer | string; | ||
| stderr: Buffer | string; | ||
| stdout: Buffer | string; | ||
| }; | ||
| // The output is a really long list of numbers because it's a buffer, so truncate it. | ||
| const noisyKeys: Array<"output" | "stderr" | "stdout"> = [ | ||
| "output", | ||
| "stderr", | ||
| "stdout", | ||
| ]; | ||
| noisyKeys.forEach((key) => { | ||
| if (key in execError) { | ||
| execError[key] = "<truncated>"; | ||
| } | ||
| }); | ||
| logger.error(execError); | ||
| } | ||
| } | ||
| } | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.