zcash_protocol: Rename value amounts to Zatoshis and ZatBalance

zcash · Jan 27, 2024 · af15ecf · af15ecf
1 parent 9cf0d55
commit af15ecf
Show file tree

Hide file tree

Showing 9 changed files with 198 additions and 186 deletions.
diff --git a/components/zcash_protocol/src/value.rs b/components/zcash_protocol/src/value.rs
diff --git a/zcash_client_backend/src/data_api/wallet.rs b/zcash_client_backend/src/data_api/wallet.rs
@@ -10,7 +10,10 @@ use zcash_primitives::{
     memo::MemoBytes,
     transaction::{
         builder::{BuildConfig, Builder},
-        components::{amount::{Amount, NonNegativeAmount}, sapling::zip212_enforcement},
+        components::{
+            amount::{Amount, NonNegativeAmount},
+            sapling::zip212_enforcement,
+        },
         fees::{zip317::FeeError as Zip317FeeError, FeeRule, StandardFeeRule},
         Transaction, TxId,
     },
@@ -777,10 +780,7 @@ where
                             try_sapling_note_decryption(
                                 &internal_ivk,
                                 &bundle.shielded_outputs()[output_index],
-                                zip212_enforcement(
-                                    params,
-                                    proposal.min_target_height(),
-                                ),
+                                zip212_enforcement(params, proposal.min_target_height()),
                             )
                             .map(|(note, _, _)| (account, note))
                         })

diff --git a/zcash_client_backend/src/decrypt.rs b/zcash_client_backend/src/decrypt.rs
@@ -6,7 +6,7 @@ use sapling::note_encryption::{
 use zcash_primitives::{
     consensus::{self, BlockHeight},
     memo::MemoBytes,
-    transaction::{Transaction, components::sapling::zip212_enforcement},
+    transaction::{components::sapling::zip212_enforcement, Transaction},
     zip32::{AccountId, Scope},
 };
 

diff --git a/zcash_client_sqlite/src/testing.rs b/zcash_client_sqlite/src/testing.rs
@@ -761,13 +761,12 @@ pub(crate) fn fake_compact_block<P: consensus::Parameters>(
 
     // Create a fake Note for the account
     let mut rng = OsRng;
-    let rseed = generate_random_rseed(
-        zip212_enforcement(params, height),
-        &mut rng,
-    );
-    let note = Note::from_parts(to, 
+    let rseed = generate_random_rseed(zip212_enforcement(params, height), &mut rng);
+    let note = Note::from_parts(
+        to,
         sapling::value::NoteValue::from_raw(value.into_u64()),
-        rseed);
+        rseed,
+    );
     let encryptor = sapling_note_encryption(
         Some(dfvk.fvk().ovk),
         note.clone(),
@@ -876,9 +875,11 @@ pub(crate) fn fake_compact_block_spending<P: consensus::Parameters>(
 
     // Create a fake Note for the payment
     ctx.outputs.push({
-        let note = Note::from_parts(to, 
-        sapling::value::NoteValue::from_raw(value.into_u64()),
-            rseed);
+        let note = Note::from_parts(
+            to,
+            sapling::value::NoteValue::from_raw(value.into_u64()),
+            rseed,
+        );
         let encryptor = sapling_note_encryption(
             Some(dfvk.fvk().ovk),
             note.clone(),

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/receiving_key_scopes.rs b/zcash_client_sqlite/src/wallet/init/migrations/receiving_key_scopes.rs
@@ -19,7 +19,10 @@ use sapling::{
 use zcash_client_backend::{data_api::SAPLING_SHARD_HEIGHT, keys::UnifiedFullViewingKey};
 use zcash_primitives::{
     consensus::{self, BlockHeight, BranchId},
-    transaction::{components::{amount::NonNegativeAmount, sapling::zip212_enforcement}, Transaction},
+    transaction::{
+        components::{amount::NonNegativeAmount, sapling::zip212_enforcement},
+        Transaction,
+    },
     zip32::Scope,
 };
 

diff --git a/zcash_client_sqlite/src/wallet/sapling.rs b/zcash_client_sqlite/src/wallet/sapling.rs
@@ -9,10 +9,7 @@ use sapling::{self, Diversifier, Nullifier, Rseed};
 use zcash_primitives::{
     consensus::{self, BlockHeight},
     memo::MemoBytes,
-    transaction::{
-        components::Amount,
-        TxId,
-    },
+    transaction::{components::Amount, TxId},
     zip32::{AccountId, Scope},
 };
 
@@ -483,7 +480,7 @@ pub(crate) mod tests {
         legacy::TransparentAddress,
         memo::{Memo, MemoBytes},
         transaction::{
-            components::{amount::NonNegativeAmount, Amount, sapling::zip212_enforcement},
+            components::{amount::NonNegativeAmount, sapling::zip212_enforcement, Amount},
             fees::{
                 fixed::FeeRule as FixedFeeRule, zip317::FeeError as Zip317FeeError, StandardFeeRule,
             },

diff --git a/zcash_primitives/benches/note_decryption.rs b/zcash_primitives/benches/note_decryption.rs
@@ -16,7 +16,7 @@ use sapling::{
 use zcash_note_encryption::batch;
 use zcash_primitives::{
     consensus::{NetworkUpgrade::Canopy, Parameters, TEST_NETWORK},
-    transaction::components::{Amount, sapling::zip212_enforcement},
+    transaction::components::{sapling::zip212_enforcement, Amount},
 };
 
 #[cfg(unix)]

diff --git a/zcash_primitives/src/transaction/components.rs b/zcash_primitives/src/transaction/components.rs
@@ -1,6 +1,17 @@
 //! Structs representing the components within Zcash transactions.
+pub mod amount {
+    pub use zcash_protocol::value::{
+        BalanceError, ZatBalance as Amount, Zatoshis as NonNegativeAmount, COIN,
+    };
 
-pub use zcash_protocol::value as amount;
+    #[cfg(feature = "test-dependencies")]
+    pub mod testing {
+        pub use zcash_protocol::value::testing::{
+            arb_positive_zat_balance as arb_positive_amount, arb_zat_balance as arb_amount,
+            arb_zatoshis as arb_nonnegative_amount,
+        };
+    }
+}
 pub mod orchard;
 pub mod sapling;
 pub mod sprout;

diff --git a/zcash_primitives/src/transaction/components/sapling.rs b/zcash_primitives/src/transaction/components/sapling.rs
@@ -1,7 +1,7 @@
 use ff::PrimeField;
 use redjubjub::SpendAuth;
 use sapling::note_encryption::Zip212Enforcement;
-use zcash_protocol::consensus::{Parameters, NetworkUpgrade, BlockHeight, ZIP212_GRACE_PERIOD};
+use zcash_protocol::consensus::{BlockHeight, NetworkUpgrade, Parameters, ZIP212_GRACE_PERIOD};
 
 use std::io::{self, Read, Write};
 
@@ -24,10 +24,7 @@ use crate::{
 use super::{Amount, GROTH_PROOF_SIZE};
 
 /// Returns the enforcement policy for ZIP 212 at the given height.
-pub fn zip212_enforcement(
-    params: &impl Parameters,
-    height: BlockHeight,
-) -> Zip212Enforcement {
+pub fn zip212_enforcement(params: &impl Parameters, height: BlockHeight) -> Zip212Enforcement {
     if params.is_nu_active(NetworkUpgrade::Canopy, height) {
         let grace_period_end_height =
             params.activation_height(NetworkUpgrade::Canopy).unwrap() + ZIP212_GRACE_PERIOD;