Network Sustainability Mechanism - ZIP 234 and 235 implementation

ZcashFoundation · Oct 18, 2024 · ce2eedd · ce2eedd
1 parent 76a5494
commit ce2eedd
Show file tree

Hide file tree

Showing 40 changed files with 982 additions and 576 deletions.
diff --git a/zebra-chain/src/block.rs b/zebra-chain/src/block.rs
@@ -19,14 +19,15 @@ use crate::{
 };
 
 mod commitment;
-mod error;
 mod hash;
 mod header;
 mod height;
 mod serialize;
 
+pub mod error;
 pub mod genesis;
 pub mod merkle;
+pub mod subsidy;
 
 #[cfg(any(test, feature = "proptest-impl"))]
 pub mod arbitrary;

diff --git a/zebra-chain/src/block/error.rs b/zebra-chain/src/block/error.rs
@@ -2,9 +2,22 @@
 
 use thiserror::Error;
 
+use crate::error::SubsidyError;
+
+#[cfg(any(test, feature = "proptest-impl"))]
+use proptest_derive::Arbitrary;
+
+#[derive(Clone, Error, Debug, PartialEq, Eq)]
+#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
 #[allow(missing_docs)]
-#[derive(Error, Debug, PartialEq, Eq)]
 pub enum BlockError {
+    #[error("block has no transactions")]
+    NoTransactions,
+
     #[error("transaction has wrong consensus branch id for block network upgrade")]
     WrongTransactionConsensusBranchId,
+
+    #[error("block failed subsidy validation")]
+    #[cfg_attr(any(test, feature = "proptest-impl"), proptest(skip))]
+    Subsidy(#[from] SubsidyError),
 }
diff --git a/zebra-consensus/src/block/subsidy.rs → zebra-chain/src/block/subsidy.rs b/zebra-consensus/src/block/subsidy.rs → zebra-chain/src/block/subsidy.rs
diff --git a/...nsus/src/block/subsidy/funding_streams.rs → ...hain/src/block/subsidy/funding_streams.rs b/...nsus/src/block/subsidy/funding_streams.rs → ...hain/src/block/subsidy/funding_streams.rs
@@ -4,7 +4,7 @@
 
 use std::collections::HashMap;
 
-use zebra_chain::{
+use crate::{
     amount::{Amount, Error, NonNegative},
     block::Height,
     parameters::{subsidy::*, Network, NetworkUpgrade::*},

diff --git a/...rc/block/subsidy/funding_streams/tests.rs → ...rc/block/subsidy/funding_streams/tests.rs b/...rc/block/subsidy/funding_streams/tests.rs → ...rc/block/subsidy/funding_streams/tests.rs
@@ -1,17 +1,19 @@
 //! Tests for funding streams.
 
 use color_eyre::Report;
-use zebra_chain::parameters::{
-    subsidy::FundingStreamReceiver,
-    testnet::{
-        self, ConfiguredActivationHeights, ConfiguredFundingStreamRecipient,
-        ConfiguredFundingStreams,
+
+use crate::{
+    block::subsidy::general::block_subsidy_pre_nsm,
+    parameters::{
+        subsidy::FundingStreamReceiver,
+        testnet::{
+            self, ConfiguredActivationHeights, ConfiguredFundingStreamRecipient,
+            ConfiguredFundingStreams,
+        },
+        NetworkKind,
     },
-    NetworkKind,
 };
 
-use crate::block::subsidy::general::block_subsidy;
-
 use super::*;
 
 /// Check mainnet funding stream values are correct for the entire period.
@@ -26,7 +28,7 @@ fn test_funding_stream_values() -> Result<(), Report> {
     assert!(funding_stream_values(
         canopy_height_minus1,
         network,
-        block_subsidy(canopy_height_minus1, network)?
+        block_subsidy_pre_nsm(canopy_height_minus1, network)?
     )?
     .is_empty());
 
@@ -50,7 +52,7 @@ fn test_funding_stream_values() -> Result<(), Report> {
         funding_stream_values(
             canopy_height,
             network,
-            block_subsidy(canopy_height, network)?
+            block_subsidy_pre_nsm(canopy_height, network)?
         )
         .unwrap(),
         hash_map
@@ -60,7 +62,7 @@ fn test_funding_stream_values() -> Result<(), Report> {
         funding_stream_values(
             canopy_height_plus1,
             network,
-            block_subsidy(canopy_height_plus1, network)?
+            block_subsidy_pre_nsm(canopy_height_plus1, network)?
         )
         .unwrap(),
         hash_map
@@ -70,7 +72,7 @@ fn test_funding_stream_values() -> Result<(), Report> {
         funding_stream_values(
             canopy_height_plus2,
             network,
-            block_subsidy(canopy_height_plus2, network)?
+            block_subsidy_pre_nsm(canopy_height_plus2, network)?
         )
         .unwrap(),
         hash_map
@@ -82,11 +84,11 @@ fn test_funding_stream_values() -> Result<(), Report> {
     let last = (end - 1).unwrap();
 
     assert_eq!(
-        funding_stream_values(last, network, block_subsidy(last, network)?).unwrap(),
+        funding_stream_values(last, network, block_subsidy_pre_nsm(last, network)?).unwrap(),
         hash_map
     );
 
-    assert!(funding_stream_values(end, network, block_subsidy(end, network)?)?.is_empty());
+    assert!(funding_stream_values(end, network, block_subsidy_pre_nsm(end, network)?)?.is_empty());
 
     // TODO: Replace this with Mainnet once there's an NU6 activation height defined for Mainnet
     let network = testnet::Parameters::build()
@@ -137,7 +139,8 @@ fn test_funding_stream_values() -> Result<(), Report> {
         Height(nu6_height.0 + 1),
     ] {
         assert_eq!(
-            funding_stream_values(height, &network, block_subsidy(height, &network)?).unwrap(),
+            funding_stream_values(height, &network, block_subsidy_pre_nsm(height, &network)?)
+                .unwrap(),
             hash_map
         );
     }
@@ -191,7 +194,8 @@ fn test_funding_stream_values() -> Result<(), Report> {
         Height(nu6_height.0 + 1),
     ] {
         assert_eq!(
-            funding_stream_values(height, &network, block_subsidy(height, &network)?).unwrap(),
+            funding_stream_values(height, &network, block_subsidy_pre_nsm(height, &network)?)
+                .unwrap(),
             hash_map
         );
     }