0xMiden / 0xMiden/miden-vm

Document values of constants using `insta`

Open
#2,221 3 comments 2 reactions 1 assignee Assigned to @Nashtare View on GitHub
documentation processor
Dominant language
Rust
Stars
772
Forks
352
Avg merge
1d 12h
Merged PRs (30d)
93

Description

We currently define many constants which are defined programmatically rather than using "magic numbers". This ensures for example that column indices are properly computed. Unfortunately, this also makes it hard to easily figure out what the values actually are. In my particular workflow, my IDE is not smart enough to actually compute and display the values.

While we should always update the docs whenever we make any changes that might affect things like trace widths and offsets, these must be done manually and are hard to check, and easily lead to outdated documentation.

The codebase is and should be the single source of truth when it comes to specification of our VM. We can make it easier to understand by writing tests using `insta` to document parameters such as
- the widths of all our traces along with their offsets
- the specific range of sets of columns for some chiplets (e.g. capacity portion of RPO inside the hasher chiplet)

The docs could then point to this specific test when trying to understand the structure of the VM.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.