From eaf5473efc8e820f122acdf14f3080b15823334e Mon Sep 17 00:00:00 2001
From: Jane Lusby <jlusby42@gmail.com>
Date: Fri, 9 Oct 2020 02:05:09 -0700
Subject: [PATCH] Add verification and state tracing events and spans (#1131)

---
 zebra-consensus/src/chain.rs            |  3 +++
 zebra-consensus/src/checkpoint.rs       |  2 ++
 zebra-state/src/service/memory_state.rs | 14 +++++++++++++-
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/zebra-consensus/src/chain.rs b/zebra-consensus/src/chain.rs
index 6b07f779..ecb37fce 100644
--- a/zebra-consensus/src/chain.rs
+++ b/zebra-consensus/src/chain.rs
@@ -77,6 +77,9 @@ where
 
     fn call(&mut self, block: Arc<Block>) -> Self::Future {
         let height = block.coinbase_height();
+        let span = tracing::info_span!("chain_call", ?height);
+        let _entered = span.enter();
+        tracing::debug!("verifying new block");
 
         // TODO: do we still need this logging?
         // Log an info-level message on unexpected out of order blocks
diff --git a/zebra-consensus/src/checkpoint.rs b/zebra-consensus/src/checkpoint.rs
index ede45e58..15ef2d10 100644
--- a/zebra-consensus/src/checkpoint.rs
+++ b/zebra-consensus/src/checkpoint.rs
@@ -27,6 +27,7 @@ use thiserror::Error;
 use tokio::sync::oneshot;
 use tower::{Service, ServiceExt};
 
+use tracing::instrument;
 use zebra_chain::{
     block::{self, Block},
     parameters::Network,
@@ -784,6 +785,7 @@ where
         Poll::Ready(Ok(()))
     }
 
+    #[instrument(name = "checkpoint_call", skip(self, block))]
     fn call(&mut self, block: Arc<Block>) -> Self::Future {
         // Immediately reject all incoming blocks that arrive after we've finished.
         if let FinalCheckpoint = self.previous_checkpoint_height() {
diff --git a/zebra-state/src/service/memory_state.rs b/zebra-state/src/service/memory_state.rs
index d5a85fcf..3d47af30 100644
--- a/zebra-state/src/service/memory_state.rs
+++ b/zebra-state/src/service/memory_state.rs
@@ -10,7 +10,7 @@ use std::{
     sync::Arc,
 };
 
-use tracing::instrument;
+use tracing::{debug_span, instrument, trace};
 use zebra_chain::{
     block::{self, Block},
     primitives::Groth16Proof,
@@ -37,17 +37,21 @@ struct Chain {
 
 impl Chain {
     /// Push a contextually valid non-finalized block into a chain as the new tip.
+    #[instrument(skip(self), fields(%block))]
     pub fn push(&mut self, block: Arc<Block>) {
         let block_height = block
             .coinbase_height()
             .expect("valid non-finalized blocks have a coinbase height");
 
+        trace!(?block_height, "Pushing new block into chain state");
+
         // update cumulative data members
         self.update_chain_state_with(&block);
         self.blocks.insert(block_height, block);
     }
 
     /// Remove the lowest height block of the non-finalized portion of a chain.
+    #[instrument(skip(self))]
     pub fn pop_root(&mut self) -> Arc<Block> {
         let block_height = self.lowest_height();
 
@@ -197,6 +201,7 @@ impl UpdateWith<Arc<Block>> for Chain {
         }
     }
 
+    #[instrument(skip(self), fields(%block))]
     fn revert_chain_state_with(&mut self, block: &Arc<Block>) {
         let block_hash = block.hash();
 
@@ -312,18 +317,25 @@ impl UpdateWith<Option<transaction::JoinSplitData<Groth16Proof>>> for Chain {
     ) {
         if let Some(joinsplit_data) = joinsplit_data {
             for sprout::JoinSplit { nullifiers, .. } in joinsplit_data.joinsplits() {
+                let span = debug_span!("revert_chain_state_with", ?nullifiers);
+                let _entered = span.enter();
+                trace!("Adding sprout nullifiers.");
                 self.sprout_nullifiers.insert(nullifiers[0]);
                 self.sprout_nullifiers.insert(nullifiers[1]);
             }
         }
     }
 
+    #[instrument(skip(self, joinsplit_data))]
     fn revert_chain_state_with(
         &mut self,
         joinsplit_data: &Option<transaction::JoinSplitData<Groth16Proof>>,
     ) {
         if let Some(joinsplit_data) = joinsplit_data {
             for sprout::JoinSplit { nullifiers, .. } in joinsplit_data.joinsplits() {
+                let span = debug_span!("revert_chain_state_with", ?nullifiers);
+                let _entered = span.enter();
+                trace!("Removing sprout nullifiers.");
                 assert!(
                     self.sprout_nullifiers.remove(&nullifiers[0]),
                     "nullifiers must be present if block was"