0xMiden/examples

Benchmarking CLI improvements

Open

#39 opened on Dec 21, 2022

View on GitHub
 (2 comments) (0 reactions) (1 assignee)TypeScript (25 forks)github user discovery
good first issue

Repository metrics

Stars
 (21 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

A few small things that would be great to improve in benchmarking CLI:

  1. We should use structop instead of clap as thats what we use for all other CLIs (e.g., here).
  2. We should keep CLI parameters as consistent as possible across different CLIs (e.g., for how we specify security, number of outputs etc.). See example here.
  3. Let's change the executable file name to something like miden-bench (miden-benchmarking-cli is way too long).
  4. miden::prove() also includes execution time, I believe. So, to make things more clear, we should probably label it as "Execution + proving time" or something like that.
  5. Would also be great to print out proof size.

Contributor guide

Research direction
Examine the current benchmarking CLI implementation in the examples repository. Identify where clap is used and replace it with structop, following the pattern in the miden vm main.rs. Review other CLIs (e.g., prove.rs) for consistent parameter naming. Rename the executable to miden bench. Update the output label to include 'Execution + proving time'. Add printing of proof size.
Tech stack
rust
Domain
clitooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75