chore: skip formatting informattable comments (#6288)

I've flipped the config to just skip formatting any comments which would be lost if formatted (really not sure why that was turned on as the default behaviour).
AztecProtocol · May 9, 2024 · 95b499b · 95b499b
1 parent f0a1c89
commit 95b499b
Show file tree

Hide file tree

Showing 19 changed files with 47 additions and 42 deletions.
diff --git a/noir-projects/Earthfile b/noir-projects/Earthfile
@@ -33,9 +33,8 @@ test:
 format:
   FROM +build
 
-  # TODO: https://github.com/noir-lang/noir/issues/4980
-  # WORKDIR /usr/src/noir-projects/noir-protocol-circuits
-  # RUN nargo fmt --check
+  WORKDIR /usr/src/noir-projects/noir-protocol-circuits
+  RUN nargo fmt --check
 
   WORKDIR /usr/src/noir-projects/noir-contracts
   RUN nargo fmt --check

diff --git a/noir-projects/noir-protocol-circuits/crates/private-kernel-init-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/private-kernel-init-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::private_kernel_lib::PrivateKernelInitCircuitPrivateInputs;
 use dep::types::PrivateKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PrivateKernelInitCircuitPrivateInputs) ->  pub PrivateKernelCircuitPublicInputs {
+unconstrained fn main(input: PrivateKernelInitCircuitPrivateInputs) -> pub PrivateKernelCircuitPublicInputs {
     input.native_private_kernel_circuit_initial()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/private-kernel-inner-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/private-kernel-inner-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::private_kernel_lib::PrivateKernelInnerCircuitPrivateInputs;
 use dep::types::PrivateKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PrivateKernelInnerCircuitPrivateInputs) ->  pub PrivateKernelCircuitPublicInputs {
+unconstrained fn main(input: PrivateKernelInnerCircuitPrivateInputs) -> pub PrivateKernelCircuitPublicInputs {
     input.native_private_kernel_circuit_inner()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/private-kernel-lib/src/private_kernel_tail.nr b/noir-projects/noir-protocol-circuits/crates/private-kernel-lib/src/private_kernel_tail.nr
@@ -1,14 +1,15 @@
 use crate::kernel_circuit_public_inputs_composer::KernelCircuitPublicInputsComposer;
 use dep::reset_kernel_lib::{NoteHashReadRequestHints, NullifierReadRequestHints, PrivateValidationRequestProcessor};
 use dep::types::{
-      abis::{
-      private_kernel_data::{PrivateKernelData, verify_previous_kernel_proof}, kernel_circuit_public_inputs::KernelCircuitPublicInputs,
-      note_hash::ScopedNoteHash, nullifier::ScopedNullifier, side_effect::SideEffect
-  },
-      constants::{
-      MAX_NEW_NOTE_HASHES_PER_TX, MAX_NEW_NULLIFIERS_PER_TX, MAX_NOTE_HASH_READ_REQUESTS_PER_TX,
-      MAX_NULLIFIER_KEY_VALIDATION_REQUESTS_PER_TX, MAX_ENCRYPTED_LOGS_PER_TX, MAX_UNENCRYPTED_LOGS_PER_TX
-  },
+    abis::{
+    private_kernel_data::{PrivateKernelData, verify_previous_kernel_proof},
+    kernel_circuit_public_inputs::KernelCircuitPublicInputs, note_hash::ScopedNoteHash,
+    nullifier::ScopedNullifier, side_effect::SideEffect
+},
+    constants::{
+    MAX_NEW_NOTE_HASHES_PER_TX, MAX_NEW_NULLIFIERS_PER_TX, MAX_NOTE_HASH_READ_REQUESTS_PER_TX,
+    MAX_NULLIFIER_KEY_VALIDATION_REQUESTS_PER_TX, MAX_ENCRYPTED_LOGS_PER_TX, MAX_UNENCRYPTED_LOGS_PER_TX
+},
     grumpkin_private_key::GrumpkinPrivateKey, utils::arrays::array_length
 };
 
@@ -94,16 +95,19 @@ mod tests {
     use dep::types::constants::{
         MAX_NOTE_HASH_READ_REQUESTS_PER_TX, MAX_NEW_NOTE_HASHES_PER_TX, MAX_NEW_NULLIFIERS_PER_TX,
         MAX_NULLIFIER_READ_REQUESTS_PER_TX, MAX_NULLIFIER_KEY_VALIDATION_REQUESTS_PER_TX,
-        MAX_ENCRYPTED_LOGS_PER_TX, MAX_UNENCRYPTED_LOGS_PER_TX,
-        DA_BYTES_PER_FIELD, DA_GAS_PER_BYTE
+        MAX_ENCRYPTED_LOGS_PER_TX, MAX_UNENCRYPTED_LOGS_PER_TX, DA_BYTES_PER_FIELD, DA_GAS_PER_BYTE
     };
     use dep::types::{
         abis::{
         kernel_circuit_public_inputs::KernelCircuitPublicInputs, max_block_number::MaxBlockNumber,
-        note_hash::{NoteHash, ScopedNoteHash}, nullifier::{Nullifier, ScopedNullifier}, side_effect::SideEffect, gas::Gas
+        note_hash::{NoteHash, ScopedNoteHash}, nullifier::{Nullifier, ScopedNullifier},
+        side_effect::SideEffect, gas::Gas
     },
         grumpkin_private_key::GrumpkinPrivateKey,
-        hash::{compute_note_hash_nonce, compute_unique_siloed_note_hash, sha256_to_field, silo_note_hash, silo_nullifier},
+        hash::{
+        compute_note_hash_nonce, compute_unique_siloed_note_hash, sha256_to_field, silo_note_hash,
+        silo_nullifier
+    },
         tests::{fixture_builder::FixtureBuilder, sort::sort_get_sorted_hints},
         utils::{arrays::{array_eq, array_length}}, traits::{Empty, is_empty, is_empty_array}
     };
@@ -135,10 +139,7 @@ mod tests {
 
         // A helper function that uses the first nullifer in the previous kernel to compute the unique siloed
         // note_hashes for the given note_hashes.
-        pub fn compute_output_note_hashes<N>(
-            self,
-            note_hashes: [ScopedNoteHash; N]
-        ) -> [Field; N] {
+        pub fn compute_output_note_hashes<N>(self, note_hashes: [ScopedNoteHash; N]) -> [Field; N] {
             let first_nullifier = self.previous_kernel.new_nullifiers.get_unchecked(0);
             let mut unique_siloed_note_hashes = [0; N];
             for i in 0..N {
@@ -308,13 +309,15 @@ mod tests {
             public_inputs.end.unencrypted_log_preimages_length, unencrypted_log_preimages_length + prev_unencrypted_log_preimages_length
         );
 
+        // noir-fmt:ignore
         let hash_bytes: [u8; MAX_ENCRYPTED_LOGS_PER_TX * 32] = prev_encrypted_logs_hash
             .to_be_bytes(32)
             .append(&[0; MAX_ENCRYPTED_LOGS_PER_TX * 32 - 32])
             .as_array();
         let expected_encrypted_logs_hash = sha256_to_field(hash_bytes);
         assert_eq(public_inputs.end.encrypted_logs_hash, expected_encrypted_logs_hash);
 
+        // noir-fmt:ignore
         let hash_bytes: [u8; MAX_UNENCRYPTED_LOGS_PER_TX * 32] = prev_unencrypted_logs_hash
             .to_be_bytes(32)
             .append(unencrypted_logs_hash.to_be_bytes(32))
@@ -584,7 +587,6 @@ mod tests {
         builder.previous_kernel.tx_context.gas_settings.teardown_gas_limits = Gas::new(300, 300);
         let public_inputs = builder.execute();
 
-
         let expected_gas_consumed = Gas::new(300, 300) // teardown gas
             + Gas::tx_overhead() // tx overhead
             + Gas::new(DA_GAS_PER_BYTE * DA_BYTES_PER_FIELD * 1, 0); // tx nullifier

diff --git a/...cts/noir-protocol-circuits/crates/private-kernel-lib/src/private_kernel_tail_to_public.nr b/...cts/noir-protocol-circuits/crates/private-kernel-lib/src/private_kernel_tail_to_public.nr
@@ -2,8 +2,9 @@ use crate::kernel_circuit_public_inputs_composer::KernelCircuitPublicInputsCompo
 use dep::reset_kernel_lib::{NoteHashReadRequestHints, NullifierReadRequestHints, PrivateValidationRequestProcessor};
 use dep::types::{
     abis::{
-    private_kernel_data::{PrivateKernelData, verify_previous_kernel_proof}, kernel_circuit_public_inputs::PublicKernelCircuitPublicInputs,
-    note_hash::ScopedNoteHash, nullifier::ScopedNullifier, side_effect::SideEffect
+    private_kernel_data::{PrivateKernelData, verify_previous_kernel_proof},
+    kernel_circuit_public_inputs::PublicKernelCircuitPublicInputs, note_hash::ScopedNoteHash,
+    nullifier::ScopedNullifier, side_effect::SideEffect
 },
     constants::{
     MAX_NEW_NOTE_HASHES_PER_TX, MAX_NEW_NULLIFIERS_PER_TX, MAX_NOTE_HASH_READ_REQUESTS_PER_TX,

diff --git a/...rojects/noir-protocol-circuits/crates/private-kernel-tail-to-public-simulated/src/main.nr b/...rojects/noir-protocol-circuits/crates/private-kernel-tail-to-public-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::private_kernel_lib::PrivateKernelTailToPublicCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PrivateKernelTailToPublicCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+unconstrained fn main(input: PrivateKernelTailToPublicCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.execute()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-app-logic-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-app-logic-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelAppLogicCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PublicKernelAppLogicCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+unconstrained fn main(input: PublicKernelAppLogicCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.public_kernel_app_logic()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-app-logic/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-app-logic/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelAppLogicCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-fn main(input: PublicKernelAppLogicCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+fn main(input: PublicKernelAppLogicCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.public_kernel_app_logic()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-setup-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-setup-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelSetupCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PublicKernelSetupCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+unconstrained fn main(input: PublicKernelSetupCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.public_kernel_setup()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-setup/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-setup/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelSetupCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-fn main(input: PublicKernelSetupCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+fn main(input: PublicKernelSetupCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.public_kernel_setup()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-tail-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-tail-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelTailCircuitPrivateInputs;
 use dep::types::KernelCircuitPublicInputs;
 
-unconstrained fn main(input: PublicKernelTailCircuitPrivateInputs) ->  pub KernelCircuitPublicInputs {
+unconstrained fn main(input: PublicKernelTailCircuitPrivateInputs) -> pub KernelCircuitPublicInputs {
     input.public_kernel_tail()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-tail/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-tail/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelTailCircuitPrivateInputs;
 use dep::types::KernelCircuitPublicInputs;
 
-fn main(input: PublicKernelTailCircuitPrivateInputs) ->  pub KernelCircuitPublicInputs {
+fn main(input: PublicKernelTailCircuitPrivateInputs) -> pub KernelCircuitPublicInputs {
     input.public_kernel_tail()
 }
diff --git a/noir-projects/noir-protocol-circuits/crates/public-kernel-teardown-simulated/src/main.nr b/noir-projects/noir-protocol-circuits/crates/public-kernel-teardown-simulated/src/main.nr
@@ -1,6 +1,6 @@
 use dep::public_kernel_lib::PublicKernelTeardownCircuitPrivateInputs;
 use dep::types::PublicKernelCircuitPublicInputs;
 
-unconstrained fn main(input: PublicKernelTeardownCircuitPrivateInputs) ->  pub PublicKernelCircuitPublicInputs {
+unconstrained fn main(input: PublicKernelTeardownCircuitPrivateInputs) -> pub PublicKernelCircuitPublicInputs {
     input.public_kernel_teardown()
 }
diff --git a/...s/noir-protocol-circuits/crates/rollup-lib/src/abis/base_or_merge_rollup_public_inputs.nr b/...s/noir-protocol-circuits/crates/rollup-lib/src/abis/base_or_merge_rollup_public_inputs.nr
@@ -1,8 +1,6 @@
 use dep::types::{
     abis::append_only_tree_snapshot::AppendOnlyTreeSnapshot,
-    partial_state_reference::PartialStateReference,
-    mocked::AggregationObject,
-    traits::Empty
+    partial_state_reference::PartialStateReference, mocked::AggregationObject, traits::Empty
 };
 use crate::abis::constant_rollup_data::ConstantRollupData;
 
@@ -44,4 +42,4 @@ impl Empty for BaseOrMergeRollupPublicInputs {
             out_hash : 0, 
         }
     }
-}
+}
diff --git a/noir-projects/noir-protocol-circuits/crates/rollup-lib/src/abis/constant_rollup_data.nr b/noir-projects/noir-protocol-circuits/crates/rollup-lib/src/abis/constant_rollup_data.nr
@@ -40,4 +40,4 @@ impl Empty for ConstantRollupData {
             global_variables: GlobalVariables::empty(),
         }
     }
-}
+}
diff --git a/...ypes/src/abis/kernel_circuit_public_inputs/public_kernel_circuit_public_inputs_builder.nr b/...ypes/src/abis/kernel_circuit_public_inputs/public_kernel_circuit_public_inputs_builder.nr
@@ -4,7 +4,8 @@ use crate::{
     combined_constant_data::CombinedConstantData,
     kernel_circuit_public_inputs::{public_kernel_circuit_public_inputs::PublicKernelCircuitPublicInputs},
     validation_requests::ValidationRequestsBuilder, call_request::CallRequest
-}, traits::Empty
+},
+    traits::Empty
 };
 
 struct PublicKernelCircuitPublicInputsBuilder {

diff --git a/...protocol-circuits/crates/types/src/abis/validation_requests/rollup_validation_requests.nr b/...protocol-circuits/crates/types/src/abis/validation_requests/rollup_validation_requests.nr
@@ -1,4 +1,7 @@
-use crate::{abis::max_block_number::MaxBlockNumber, traits::{Empty, Serialize}, constants::ROLLUP_VALIDATION_REQUESTS_LENGTH};
+use crate::{
+    abis::max_block_number::MaxBlockNumber, traits::{Empty, Serialize},
+    constants::ROLLUP_VALIDATION_REQUESTS_LENGTH
+};
 
 // These are validation requests that cannot be fulfilled in the current context (private or public), and must be 
 // instead forwarded to the rollup for it to take care of them.

diff --git a/...s/noir-protocol-circuits/crates/types/src/abis/validation_requests/validation_requests.nr b/...s/noir-protocol-circuits/crates/types/src/abis/validation_requests/validation_requests.nr
@@ -9,7 +9,8 @@ use crate::{
     MAX_NOTE_HASH_READ_REQUESTS_PER_TX, MAX_NULLIFIER_READ_REQUESTS_PER_TX,
     MAX_NULLIFIER_NON_EXISTENT_READ_REQUESTS_PER_TX, MAX_NULLIFIER_KEY_VALIDATION_REQUESTS_PER_TX,
     MAX_PUBLIC_DATA_READS_PER_TX, VALIDATION_REQUESTS_LENGTH
-}, traits::Serialize
+},
+    traits::Serialize
 };
 
 // TODO - Use specific structs for private and public: PrivateValidationRequests vs PublicValidationRequests
@@ -52,4 +53,4 @@ impl Serialize<VALIDATION_REQUESTS_LENGTH> for ValidationRequests {
 
     fields.storage
   }
-}
+}
diff --git a/noir/noir-repo/tooling/nargo_fmt/src/config.rs b/noir/noir-repo/tooling/nargo_fmt/src/config.rs
@@ -45,7 +45,7 @@ config! {
     max_width: usize, 100, "Maximum width of each line";
     tab_spaces: usize, 4, "Number of spaces per tab";
     remove_nested_parens: bool, true, "Remove nested parens";
-    error_on_lost_comment: bool, true, "Error if unable to get comments";
+    error_on_lost_comment: bool, false, "Error if unable to get comments";
     short_array_element_width_threshold: usize, 10, "Width threshold for an array element to be considered short";
     array_width: usize, 100, "Maximum width of an array literal before falling back to vertical formatting";
     fn_call_width: usize, 60, "Maximum width of the args of a function call before falling back to vertical formatting";