refactor FinalizationHandler to expose intrinsics like creator and ro…

…und of a finalized unit

README.md

@@ -60,7 +60,7 @@ More details are available [in the book][reference-link-implementation-details].
 - Import AlephBFT in your crate
   ```toml
   [dependencies]
-  aleph-bft = "^0.35"
+  aleph-bft = "^0.36"
   ```
 - The main entry point is the `run_session` function, which returns a Future that runs the
   consensus algorithm.

consensus/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aleph-bft"
-version = "0.35.0"
+version = "0.36.0"
 edition = "2021"
 authors = ["Cardinal Cryptography"]
 categories = ["algorithms", "data-structures", "cryptography", "database"]
@@ -14,7 +14,7 @@ description = "AlephBFT is an asynchronous and Byzantine fault tolerant consensu
 
 [dependencies]
 aleph-bft-rmc = { path = "../rmc", version = "0.12" }
-aleph-bft-types = { path = "../types", version = "0.12" }
+aleph-bft-types = { path = "../types", version = "0.13" }
 anyhow = "1.0"
 async-trait = "0.1"
 codec = { package = "parity-scale-codec", version = "3.0", default-features = false, features = ["derive"] }

consensus/src/runway/mod.rs

@@ -649,23 +649,18 @@ where
     }
 
     fn on_ordered_batch(&mut self, batch: Vec<H::Hash>) {
-        let data_iter: Vec<_> = batch
-            .iter()
-            .map(|h| {
-                let unit = self
-                    .store
-                    .unit_by_hash(h)
-                    .expect("Ordered units must be in store")
-                    .as_signable();
-
-                (unit.data().clone(), unit.creator())
-            })
-            .collect();
-
-        for (d, creator) in data_iter {
-            if let Some(d) = d {
-                self.finalization_handler.data_finalized(d, creator);
-            }
+        for hash in batch {
+            let unit = self
+                .store
+                .unit_by_hash(&hash)
+                .expect("Ordered units must be in store")
+                .as_signable();
+
+            self.finalization_handler.unit_finalized(
+                unit.creator(),
+                unit.round(),
+                unit.data().clone(),
+            )
         }
     }
 

examples/ordering/src/dataio.rs

@@ -56,7 +56,7 @@ pub struct FinalizationHandler {
 }
 
 impl FinalizationHandlerT<Data> for FinalizationHandler {
-    fn data_finalized(&mut self, d: Data, _creator: NodeIndex) {
+    fn data_finalized(&mut self, d: Data) {
         if let Err(e) = self.tx.unbounded_send(d) {
             error!(target: "finalization-handler", "Error when sending data from FinalizationHandler {:?}.", e);
         }

mock/Cargo.toml

@@ -11,7 +11,7 @@ readme = "./README.md"
 description = "Mock implementations of traits required by the aleph-bft package. Do NOT use outside of testing!"
 
 [dependencies]
-aleph-bft-types = { path = "../types", version = "0.12" }
+aleph-bft-types = { path = "../types", version = "0.13" }
 async-trait = "0.1"
 codec = { package = "parity-scale-codec", version = "3.0", default-features = false, features = ["derive"] }
 futures = "0.3"

mock/src/dataio.rs

@@ -1,6 +1,4 @@
-use aleph_bft_types::{
-    DataProvider as DataProviderT, FinalizationHandler as FinalizationHandlerT, NodeIndex,
-};
+use aleph_bft_types::{DataProvider as DataProviderT, FinalizationHandler as FinalizationHandlerT};
 use async_trait::async_trait;
 use codec::{Decode, Encode};
 use futures::{channel::mpsc::unbounded, future::pending, AsyncWrite};
@@ -75,7 +73,7 @@ pub struct FinalizationHandler {
 }
 
 impl FinalizationHandlerT<Data> for FinalizationHandler {
-    fn data_finalized(&mut self, d: Data, _creator: NodeIndex) {
+    fn data_finalized(&mut self, d: Data) {
         if let Err(e) = self.tx.unbounded_send(d) {
             error!(target: "finalization-handler", "Error when sending data from FinalizationHandler {:?}.", e);
         }

rmc/Cargo.toml

@@ -14,7 +14,7 @@ description = "Reliable MultiCast - a primitive for Reliable Broadcast protocol.
 
 [dependencies]
 aleph-bft-crypto = { path = "../crypto", version = "0.9" }
-aleph-bft-types = { path = "../types", version = "0.12" }
+aleph-bft-types = { path = "../types", version = "0.13" }
 async-trait = "0.1"
 codec = { package = "parity-scale-codec", version = "3.0", default-features = false, features = ["derive"] }
 futures = "0.3"

types/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aleph-bft-types"
-version = "0.12.0"
+version = "0.13.0"
 edition = "2021"
 authors = ["Cardinal Cryptography"]
 documentation = "https://docs.rs/?"

types/src/dataio.rs

@@ -1,6 +1,7 @@
 use async_trait::async_trait;
 
 use crate::NodeIndex;
+use crate::Round;
 
 /// The source of data items that consensus should order.
 ///
@@ -21,5 +22,14 @@ pub trait DataProvider<Data>: Sync + Send + 'static {
 pub trait FinalizationHandler<Data>: Sync + Send + 'static {
     /// Data, provided by [DataProvider::get_data], has been finalized.
     /// The calls to this function follow the order of finalization.
-    fn data_finalized(&mut self, data: Data, creator: NodeIndex);
+    fn data_finalized(&mut self, data: Data);
+    /// A unit has been finalized. You can overwrite this method for advanced finalisation handling.
+    /// Please note that this interface is less stable as it exposes intrinsics which migh be subject to change.
+    /// Do not implement this method and only implement [`FinalizationHandler::data_finalized`] unless you
+    /// absolutely know what you are doing.
+    fn unit_finalized(&mut self, _creator: NodeIndex, _round: Round, data: Option<Data>) {
+        if let Some(d) = data {
+            self.data_finalized(d);
+        }
+    }
 }