Merge pull request #2059 from blockstack/feat/event-burn-height

feat: add burn_block_height to /new_burn_block event-dispatcher endpoint

Author: Aaron Blankstein

docs/event-dispatcher.md

@@ -94,6 +94,7 @@ Example:
 ```json
 {
   "burn_block_hash": "0x4eaabcd105865e471f697eff5dd5bd85d47ecb5a26a3379d74fae0ae87c40904",
+  "burn_block_height": 331,
   "reward_recipients": [
     {
       "recipient": "1C56LYirKa3PFXFsvhSESgDy2acEHVAEt6",

src/chainstate/coordinator/mod.rs

@@ -120,6 +120,7 @@ pub trait BlockEventDispatcher {
     fn announce_burn_block(
         &self,
         burn_block: &BurnchainHeaderHash,
+        burn_block_height: u64,
         rewards: Vec<(StacksAddress, u64)>,
         burns: u64,
     );
@@ -464,7 +465,12 @@ fn dispatcher_announce_burn_ops<T: BlockEventDispatcher>(
         }
     }
     let reward_recipients_vec = reward_recipients.into_iter().collect();
-    dispatcher.announce_burn_block(&burn_header.block_hash, reward_recipients_vec, burn_amt);
+    dispatcher.announce_burn_block(
+        &burn_header.block_hash,
+        burn_header.block_height,
+        reward_recipients_vec,
+        burn_amt,
+    );
 }
 
 impl<'a, T: BlockEventDispatcher, N: CoordinatorNotices, U: RewardSetProvider>

src/chainstate/coordinator/tests.rs

@@ -243,6 +243,7 @@ impl BlockEventDispatcher for NullEventDispatcher {
     fn announce_burn_block(
         &self,
         _burn_block: &BurnchainHeaderHash,
+        _burn_block_height: u64,
         _rewards: Vec<(StacksAddress, u64)>,
         _burns: u64,
     ) {

testnet/stacks-node/src/event_dispatcher.rs

@@ -117,6 +117,7 @@ impl EventObserver {
 
     fn make_new_burn_block_payload(
         burn_block: &BurnchainHeaderHash,
+        burn_block_height: u64,
         rewards: Vec<(StacksAddress, u64)>,
         burns: u64,
     ) -> serde_json::Value {
@@ -132,6 +133,7 @@ impl EventObserver {
 
         json!({
             "burn_block_hash": format!("0x{}", burn_block),
+            "burn_block_height": burn_block_height,
             "reward_recipients": serde_json::Value::Array(reward_recipients),
             "burn_amount": burns
         })
@@ -291,10 +293,11 @@ impl BlockEventDispatcher for EventDispatcher {
     fn announce_burn_block(
         &self,
         burn_block: &BurnchainHeaderHash,
+        burn_block_height: u64,
         rewards: Vec<(StacksAddress, u64)>,
         burns: u64,
     ) {
-        self.process_burn_block(burn_block, rewards, burns)
+        self.process_burn_block(burn_block, burn_block_height, rewards, burns)
     }
 
     fn dispatch_boot_receipts(&mut self, receipts: Vec<StacksTransactionReceipt>) {
@@ -319,6 +322,7 @@ impl EventDispatcher {
     pub fn process_burn_block(
         &self,
         burn_block: &BurnchainHeaderHash,
+        burn_block_height: u64,
         rewards: Vec<(StacksAddress, u64)>,
         burns: u64,
     ) {
@@ -336,7 +340,12 @@ impl EventDispatcher {
             return;
         }
 
-        let payload = EventObserver::make_new_burn_block_payload(burn_block, rewards, burns);
+        let payload = EventObserver::make_new_burn_block_payload(
+            burn_block,
+            burn_block_height,
+            rewards,
+            burns,
+        );
 
         for (_, observer) in interested_observers.iter() {
             observer.send_new_burn_block(&payload);