Updated names

Author: Avaneesh-axiom

.github/workflows/primitives.yml

@@ -8,7 +8,7 @@ on:
     paths:
       - "crates/circuits/primitives/**"
       - "crates/circuits/poseidon2-air/**"
-      - "crates/circuits/sha256-air/**"
+      - "crates/circuits/sha-air/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
@@ -44,7 +44,7 @@ jobs:
         run: |
           cargo nextest run --cargo-profile fast --features parallel
 
-      - name: Run tests for sha256-air
-        working-directory: crates/circuits/sha256-air
+      - name: Run tests for sha-air
+        working-directory: crates/circuits/sha-air
         run: |
           cargo nextest run --cargo-profile fast --features parallel

Cargo.lock

@@ -112,7 +112,7 @@ openvm-sdk = { path = "crates/sdk", default-features = false }
 cargo-openvm = { path = "crates/cli", default-features = false }
 openvm-mod-circuit-builder = { path = "crates/circuits/mod-builder", default-features = false }
 openvm-poseidon2-air = { path = "crates/circuits/poseidon2-air", default-features = false }
-openvm-sha256-air = { path = "crates/circuits/sha256-air", default-features = false }
+openvm-sha-air = { path = "crates/circuits/sha-air", default-features = false }
 openvm-sha-macros = { path = "crates/circuits/sha-macros", default-features = false }
 openvm-circuit-primitives = { path = "crates/circuits/primitives", default-features = false }
 openvm-circuit-primitives-derive = { path = "crates/circuits/primitives/derive", default-features = false }

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "openvm-sha256-air"
+name = "openvm-sha-air"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true

crates/circuits/sha256-air/Cargo.toml renamed to crates/circuits/sha-air/Cargo.toml

@@ -6,11 +6,11 @@ use openvm_stark_backend::p3_field::FieldAlgebra;
 
 use crate::ShaConfig;
 
-/// In each SHA256 block:
-/// - First 16 rows use Sha256RoundCols
-/// - Final row uses Sha256DigestCols
+/// In each SHA block:
+/// - First C::ROUND_ROWS rows use ShaRoundCols
+/// - Final row uses ShaDigestCols
 ///
-/// Sha256RoundCols and Sha256DigestCols share the same first 3 fields:
+/// ShaRoundCols and ShaDigestCols share the same first 3 fields:
 /// - flags
 /// - work_vars/hash (same type, different name)
 /// - schedule_helper

crates/circuits/sha256-air/src/air.rs renamed to crates/circuits/sha-air/src/air.rs

@@ -79,6 +79,9 @@ pub trait ShaConfig: Send + Sync + Clone {
     };
 }
 
+/// We can notice that `carry_a`'s and `carry_e`'s are always the same on invalid rows
+/// To optimize the trace generation of invalid rows, we precompute those values.
+/// This trait also stores the constants K and H for the given SHA config.
 pub trait ShaPrecomputedValues<T> {
     // these should be appropirately sized for the config
     fn get_invalid_carry_a(round_num: usize) -> &'static [u32];
@@ -109,8 +112,6 @@ impl ShaConfig for Sha256Config {
     const ROW_VAR_CNT: usize = 5;
 }
 
-/// We can notice that `carry_a`'s and `carry_e`'s are always the same on invalid rows
-/// To optimize the trace generation of invalid rows, we have those values precomputed here
 pub const SHA256_INVALID_CARRY_A: [[u32; Sha256Config::WORD_U16S]; Sha256Config::ROUNDS_PER_ROW] = [
     [1230919683, 1162494304],
     [266373122, 1282901987],
@@ -177,8 +178,6 @@ impl ShaConfig for Sha512Config {
     const ROW_VAR_CNT: usize = 6;
 }
 
-/// We can notice that `carry_a`'s and `carry_e`'s are always the same on invalid rows
-/// To optimize the trace generation of invalid rows, we have those values precomputed here
 pub(crate) const SHA512_INVALID_CARRY_A: [[u32; Sha512Config::WORD_U16S];
     Sha512Config::ROUNDS_PER_ROW] = [
     [55971842, 827997017, 993005918, 512731953],
@@ -306,7 +305,7 @@ impl ShaPrecomputedValues<u64> for Sha512Config {
 }
 
 // Needed to avoid compile errors in utils.rs
-// don't ask me why this doesn't inf loop
+// not sure why this doesn't inf loop
 pub trait RotateRight {
     fn rotate_right(self, n: u32) -> Self;
 }

crates/circuits/sha256-air/src/columns.rs renamed to crates/circuits/sha-air/src/columns.rs

@@ -1,4 +1,4 @@
-//! Implementation of the SHA256 compression function without padding
+//! Implementation of the SHA256/SHA512 compression function without padding
 //! This this AIR doesn't constrain any of the message padding
 
 mod air;

crates/circuits/sha256-air/src/config.rs renamed to crates/circuits/sha-air/src/config.rs

@@ -19,7 +19,7 @@ use crate::{
     ShaRoundColsRef, WrappingAdd,
 };
 
-/// The trace generation of SHA256 should be done in two passes.
+/// The trace generation of SHA should be done in two passes.
 /// The first pass should do `get_block_trace` for every block and generate the invalid rows through `get_default_row`
 /// The second pass should go through all the blocks and call `generate_missing_values`
 impl<C: ShaConfig + ShaPrecomputedValues<C::Word>> ShaAir<C> {
@@ -438,7 +438,7 @@ impl<C: ShaConfig + ShaPrecomputedValues<C::Word>> ShaAir<C> {
     /// This function should be called only after `generate_block_trace` was called for all blocks
     /// And [`Self::generate_default_row`] is called for all invalid rows
     /// Will populate the missing values of `trace`, where the width of the trace is `trace_width`
-    /// and the starting column for the `Sha256Air` is `trace_start_col`.
+    /// and the starting column for the `ShaAir` is `trace_start_col`.
     /// Note: `trace` needs to be the rows 1..C::ROWS_PER_BLOCK of a block and the first row of the next block
     pub fn generate_missing_cells<F: PrimeField32>(
         &self,
@@ -737,11 +737,8 @@ pub fn generate_trace<F: PrimeField32, C: ShaConfig + ShaPrecomputedValues<C::Wo
         debug_assert!(input.len() == C::BLOCK_U8S);
     }
 
-    println!("records.len(): {}", records.len());
     let non_padded_height = records.len() * C::ROWS_PER_BLOCK;
-    println!("non_padded_height: {}", non_padded_height);
     let height = next_power_of_two_or_zero(non_padded_height);
-    println!("height: {}", height);
     let width = <ShaAir<C> as BaseAir<F>>::width(sub_air);
     let mut values = F::zero_vec(height * width);