0xMiden / 0xMiden/miden-vm

Document values of constants using `insta`

Aperta
#2,221 3 commenti 2 reazioni 1 assegnatario Assegnata a @Nashtare Vedi su GitHub
documentation processor
Lingua principale
Rust
Stelle
772
Fork
352
Merge medio
1g 12h
PR unite (30g)
93

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.