feat: add tracing feature

Author: kaimast

Cargo.lock

@@ -158,6 +158,7 @@ locktick = [
   "snarkvm-parameters?/locktick",
   "snarkvm-synthesizer?/locktick"
 ]
+tracing = [ "snarkvm-ledger/tracing" ]
 noconfig = [ ]
 rocks = [ "snarkvm-ledger/rocks", "snarkvm-synthesizer/rocks" ]
 test = [ "snarkvm-ledger/test" ]

Cargo.toml

@@ -49,9 +49,17 @@ We recommend installing Rust using [rustup](https://www.rustup.rs/). You can ins
 - Windows (64-bit):
 
   Download the [Windows 64-bit executable](https://win.rustup.rs/x86_64) or
-  [Windows 32-bit executable](https://win.rustup.rs/i686) and follow the on-screen instructions.
+  [Windows 32-bit executable](https://win.rustup.rs/i686) and follow the on-screen instructions.i
 
-### 2.2.1 Build from Crates.io
+### 2.2 Additional Dependencies
+
+On Linux, you also need the `lld` linker. For example, on a Debian system you would run the following to install it.
+
+```
+sudo apt install lld
+```
+
+### 2.3.1 Build from Crates.io
 
 We recommend installing `snarkvm` this way. In your terminal, run:
 
@@ -64,27 +72,57 @@ Now to use `snarkvm`, in your terminal, run:
 snarkvm
 ```
 
-### 2.2.2 Build from Source Code
+### 2.3.2 Build from Source Code
 
 Alternatively, you can install `snarkvm` by building from the source code as follows:
 
 ```bash
 # Download the source code
 git clone --branch mainnet --single-branch https://github.com/ProvableHQ/snarkVM.git 
 cd snarkVM
-git checkout tags/testnet-beta
 # Install snarkVM
-cargo install --path .
+cargo install --path . --features=cli
 ```
 
 Now to use `snarkvm`, in your terminal, run:
 ```bash
 snarkvm
 ```
 
+### 2.4 Feature Flags
+
+The following is an (incomplete) list of features flags in the snarkVM crate.
+
+* **cuda** -
+  Allows some operations to run on the (NVidia) GPU, instead of on the CPU.
+* **cli** -
+  Enables the command-line interface. Needed when installing the `snarkvm` binary.
+* **locktick** -
+  This feature turns on code for detecting deadlocks.
+* **test_targets** -
+  This feature allows the lowering of coinbase and proof targets for testing.
+* **tracing** -
+  Adds additional tracing statements to the code. This is useful for profiling, but can clutter the logs.
+* **serial** -
+  *Disables* paralle processing using `rayon`.
+* **algorithms** -
+  Adds the `algorithms` crate to `snarkvm` (as `snarkvm::algorithms`)
+* **circuit** -
+  Adds the `circuit` crate to `snarkvm` (as `snarkvm::circuit`)
+* **fields** -
+  Adds the `fields` crate to `snarkvm` (as `snarkvm::fields`)
+* **ledger** -
+  Adds the `ledger` crate to `snarkvm` (as `snarkvm::ledger`)
+* **synthesizer** -
+  Adds the `synthesizer` crate to `snarkvm` (as `snarkvm::synthesizer`)
+* **parameters** -
+  Adds the `parameters` crate to `snarkvm` (as `snarkvm::parameters`)
+* **wasm** -
+  Enables behavior specific for WebAssembly. This feature should only be enabled when compiling to the `wasm32` architecture.
+
 ## 3. Contributors
 
-Thank you for helping make snarkVM better!  
+Thank you for helping make snarkVM betkter!  
 [🧐 What do the emojis mean?](https://allcontributors.org/docs/en/emoji-key)
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

README.md

@@ -57,7 +57,17 @@ serial = [
   "snarkvm-ledger-store/serial",
   "snarkvm-synthesizer/serial"
 ]
-test = [ "snarkvm-console/test", "snarkvm-ledger-block/test", "snarkvm-ledger-store/test", "snarkvm-synthesizer/test" ]
+tracing = [
+  "snarkvm-synthesizer/tracing",
+  "snarkvm-ledger-block/tracing",
+  "snarkvm-ledger-store/tracing"
+]
+test = [
+  "snarkvm-console/test",
+  "snarkvm-ledger-block/test",
+  "snarkvm-ledger-store/test",
+  "snarkvm-synthesizer/test"
+]
 test-helpers = [
   "snarkvm-ledger-test-helpers",
   "snarkvm-ledger-committee/test-helpers",

ledger/Cargo.toml

@@ -34,6 +34,7 @@ wasm = [
   "snarkvm-synthesizer-program/wasm",
   "snarkvm-synthesizer-snark/wasm"
 ]
+tracing = [ "dep:tracing" ]
 test = [ "snarkvm-synthesizer-process/test" ]
 
 [dependencies.snarkvm-console]
@@ -72,6 +73,10 @@ workspace = true
 workspace = true
 features = [ "serde" ]
 
+[dependencies.tracing]
+workspace = true
+optional = true
+
 [dependencies.rayon]
 workspace = true
 

ledger/block/Cargo.toml

@@ -27,6 +27,7 @@ use rayon::prelude::*;
 
 impl<N: Network> Block<N> {
     /// Ensures the block is correct.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip_all))]
     pub fn verify(
         &self,
         previous_block: &Block<N>,

ledger/block/src/verify.rs

@@ -88,6 +88,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     }
 
     /// Adds the given block as the next block in the ledger.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip_all))]
     pub fn advance_to_next_block(&self, block: &Block<N>) -> Result<()> {
         // Acquire the write lock on the current block.
         let mut current_block = self.current_block.write();

ledger/src/advance.rs

@@ -47,6 +47,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     /// * This will reject any blocks with a height <= the current height and any blocks with a height >= the current height + GC.
     ///   For the former, a valid block already exists and,
     ///   for the latter, the comittte is still unknown.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip(self, block, pending_blocks)))]
     pub fn check_block_subdag(&self, block: Block<N>, pending_blocks: &[PendingBlock<N>]) -> Result<PendingBlock<N>> {
         self.check_block_subdag_inner(&block, pending_blocks)?;
         Ok(PendingBlock(block))
@@ -91,6 +92,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     }
 
     /// Checks the given block is a valid next block with regard to the current state/height of the Ledger.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip(self, block, rng)))]
     pub fn check_next_block<R: CryptoRng + Rng>(&self, block: &Block<N>, rng: &mut R) -> Result<()> {
         self.check_block_subdag_inner(block, &[])?;
         self.check_block_content_inner(block, rng)?;
@@ -226,6 +228,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     ///
     /// This does not verify that the batches are signed correctly or that the edges are valid
     /// (only point to the previous round), as those checks already happened when the node received the batch.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip(self, block, previous_blocks)))]
     fn check_block_subdag_leaves(&self, block: &Block<N>, previous_blocks: &[PendingBlock<N>]) -> Result<()> {
         // Check if the block has a subdag.
         let Authority::Quorum(subdag) = block.authority() else {
@@ -276,6 +279,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     /// Check that the certificates in the block subdag have met quorum requirements.
     ///
     /// Called by [`Self::check_block_subdag`]
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip(self, block)))]
     fn check_block_subdag_quorum(&self, block: &Block<N>) -> Result<()> {
         // Check if the block has a subdag.
         let subdag = match block.authority() {

ledger/src/check_next_block.rs

@@ -50,6 +50,7 @@ impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C> {
     }
 
     /// Returns the committee lookback for the given round.
+    #[cfg_attr(feature = "tracing", tracing::instrument(skip(self)))]
     pub fn get_committee_lookback_for_round(&self, round: u64) -> Result<Option<Committee<N>>> {
         // Get the round number for the previous committee. Note, we subtract 2 from odd rounds,
         // because committees are updated in even rounds.

ledger/src/get.rs

@@ -19,7 +19,7 @@ edition = "2024"
 [features]
 default = [ "indexmap/rayon" ]
 locktick = [ "dep:locktick", "snarkvm-ledger-puzzle/locktick" ]
-rocks = [ "rocksdb", "smallvec", "tracing" ]
+rocks = [ "dep:rocksdb", "dep:smallvec", "dep:tracing" ]
 serial = [
   "snarkvm-console/serial",
   "snarkvm-ledger-block/serial",
@@ -39,6 +39,7 @@ wasm = [
   "snarkvm-synthesizer-snark/wasm"
 ]
 test = [ ]
+tracing = [ "dep:tracing" ]
 
 [dependencies.snarkvm-console]
 workspace = true