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: help commands for bb #8879

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Maddiaa0
Copy link
Member

@Maddiaa0 Maddiaa0 commented Sep 29, 2024

Overview

fixes: #8464

Alter the main dispatch function from bb such that it supports commands

This pr is more of a showcase and is expected to be iterative as it does change a good bit here

t % ../cpp/build/bin/bb --help
Available commands:
  vk_as_fields_ultra_keccak_honk: Convert Ultra Keccak Honk verification key to fields
  vk_as_fields_ultra_honk: Convert Ultra Honk verification key to fields
  write_vk_mega_honk: Write Mega Honk verification key
  vk_as_fields_mega_honk: Convert Mega Honk verification key to fields
  verify_mega_honk: Verify Mega Honk proof
  write_vk_ultra_keccak_honk: Write Ultra Keccak Honk verification key
  write_vk_ultra_honk: Write Ultra Honk verification key
  prove_ultra_keccak_honk_output_all: Generate Ultra Keccak Honk proof and output all related data
  prove_ultra_keccak_honk: Generate Ultra Keccak Honk proof
  prove_mega_honk_output_all: Generate a Mega Honk proof and output all related data
  prove_output_all: Generate a proof and output all related data
  fold_and_verify_program: Fold and verify program
  vk_as_fields: Convert verification key to fields
  verify_ultra_honk: Verify Ultra Honk proof
  prove_and_verify_mega_honk_program: Prove and verify Mega Honk program
  prove_and_verify_ultra_honk_program: Prove and verify Ultra Honk program
  prove_and_verify_mega_honk: Prove and verify using Mega Honk
  client_ivc_prove_output_all_msgpack: Client IVC prove output all msgpack
  prove_ultra_honk: Generate Ultra Honk proof
  prove_and_verify_ultra_honk: Prove and verify using Ultra Honk
  prove_and_verify: Prove and verify
  avm_verify: Verify AVM proof
  --version: Display version information
  proof_as_fields_honk: Convert Honk proof to fields
  proof_as_fields: Convert proof to fields
  verify_ultra_keccak_honk: Verify Ultra Keccak Honk proof
  prove_tube: Generate a tube proof
  write_recursion_inputs_honk: Write recursion inputs for Honk
  verify_tube: Verify a tube proof
  client_ivc_prove_output_all: Generate a client IVC proof and output all related data
  gates: Count gates for Ultra circuit
  verify_client_ivc: Verify client IVC
  prove: Generate a proof
  gates_mega_honk: Count gates for Mega Honk circuit
  prove_ultra_honk_output_all: Generate an Ultra Honk proof and output all related data
  verify: Verify a proof
  write_vk: Write verification key
  avm_prove: Generate AVM proof
  contract: Generate a contract
  contract_ultra_honk: Generate an Ultra Honk contract
  prove_mega_honk: Generate Mega Honk proof
  write_pk: Write proving key
Use --help with any command for more information.

For an individual command:

t % ../cpp/build/bin/bb vk_as_fields_ultra_keccak_honk --help
vk_as_fields_ultra_keccak_honk: Convert Ultra Keccak Honk verification key to fields
Usage: vk_as_fields_ultra_keccak_honk -k <vk_path> -o <output_path>

Copy link
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @Maddiaa0 and the rest of your teammates on Graphite Graphite

@Maddiaa0 Maddiaa0 self-assigned this Oct 1, 2024
@Maddiaa0 Maddiaa0 added the crypto cryptography label Oct 1, 2024
Base automatically changed from md/09-29-chore_keccak_ultra_-_ultra_keccak to master October 2, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto cryptography
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant