search

filecoin-project / rust-fil-proofs

Proofs for Filecoin in Rust
Other
492 stars 314 forks source link

refactor: clarify `h` and `h_select` #1696

Closed vmx closed 1 year ago

vmx commented 1 year ago

The circuit supports a fixed hard-coded list of h values (7-12). Those values are addressed by their index in the list. It can be seen as a 6-bit bit-pattern, which is called h_select.

The vanilla proof always uses 1 for sector sizes <= 32KiB and 10 for bigger sector sizes. That value is now hard-coded.

All this should make the code more consistent and easier to follow.

BREAKING CHANGE: hs and HSelect are not longer part of the filecoin-proofs public API.

vmx commented 1 year ago

I decided to do a force push as the commit message wasn't accurate after the changes I made due to the review. I wanted the commit message to be correct and not trying to get it right when squashing. So please also have a look at the commit message.

I also did not rebase the change yet, so that one can easily review the changes between the already reviewed and the new version.

Thanks @DrPeterVanNostrand for the detailed review message, I think I understood what you mean and hope I made the changes in the expected way. Please let me know if I got it wrong.

DrPeterVanNostrand commented 1 year ago

Nice, thanks for the update; one last comment around the naming of fn num_high_bits.