Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): add extractor witness gen #90

Merged
merged 12 commits into from
Sep 13, 2024
Merged

feat(cli): add extractor witness gen #90

merged 12 commits into from
Sep 13, 2024

Conversation

lonerapier
Copy link
Collaborator

@lonerapier lonerapier commented Sep 11, 2024

  • codegen writes circuit param config to circuits.json. Overwrites if config with circuit-name already present

Usage:

pabuild:

Usage: pabuild <COMMAND>

Commands:
  parser-witness     
  extractor-witness  
  codegen            
  help               Print this message or the help of the given subcommand(s)

codegen:

Usage: pabuild codegen [OPTIONS] --circuit-name <CIRCUIT_NAME> --input-file <INPUT_FILE> --lockfile <LOCKFILE> <SUBCOMMAND>

Arguments:
  <SUBCOMMAND>  [possible values: json, http]

Options:
      --circuit-name <CIRCUIT_NAME>  Name of the circuit (to be used in circomkit config)
      --input-file <INPUT_FILE>      Path to the JSON/HTTP file
      --lockfile <LOCKFILE>          Path to the lockfile
  -d, --debug                        Optional circuit debug logs
  -h, --help                         Print help

witness:

Usage: pabuild parser-witness --input-file <INPUT_FILE> --circuit-name <CIRCUIT_NAME> <SUBCOMMAND>

Arguments:
  <SUBCOMMAND>  [possible values: json, http]

Options:
      --input-file <INPUT_FILE>      Path to the JSON file
      --circuit-name <CIRCUIT_NAME>  Name of the circuit (to be used in circomkit config)
  -h, --help                         Print help

==============================================================================

Usage: pabuild extractor-witness --circuit-name <CIRCUIT_NAME> --input-file <INPUT_FILE> --lockfile <LOCKFILE> <SUBCOMMAND>

Arguments:
  <SUBCOMMAND>  [possible values: json, http]

Options:
      --circuit-name <CIRCUIT_NAME>  Name of the circuit (to be used in circomkit config)
      --input-file <INPUT_FILE>      Path to the JSON file
      --lockfile <LOCKFILE>          Path to the lockfile
  -h, --help                         Print help

Copy link
Contributor

@Autoparallel Autoparallel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Can we add/edit docs to explain how to use the CLI more effectively? Best practices/etc.?

circuits/test/http/codegen.test.ts Show resolved Hide resolved
@Autoparallel
Copy link
Contributor

The CLI help menus you shared here are great!

I'm gonna pull locally and mess around more. I might add/edit docs myself to carry this over.

@lonerapier
Copy link
Collaborator Author

added updated docs with proof steps for both json and http

Copy link
Contributor

@Autoparallel Autoparallel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!! So good!

@@ -3,13 +3,13 @@
</h1>

<div align="center">
<a href="https://github.com/pluto/extractor/graphs/contributors">
<a href="https://github.com/pluto/parser-attestor/graphs/contributors">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THANKS!

@@ -120,10 +120,10 @@ From the root of this repository, run:
```sh
cargo install --path .
```
to install the `wpbuild` binary.
to install the `pabuild` binary.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DOUBLE THANKS

@Autoparallel Autoparallel merged commit fc67ae7 into main Sep 13, 2024
1 check passed
@Autoparallel Autoparallel deleted the feat/cli-improvs branch September 13, 2024 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants