Apply suggestions from code review

Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
zcash · Oct 25, 2024 · 2cc6775 · 2cc6775
1 parent f2b51cf
commit 2cc6775
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/zcash_client_backend/CHANGELOG.md b/zcash_client_backend/CHANGELOG.md
@@ -17,7 +17,7 @@ and this library adheres to Rust's notion of
   - `SplitPolicy`
   - `StandardFeeRule` has been moved here from `zcash_primitives::fees`. Relative
     to that type, the deprecated `PreZip313` and `Zip313` variants have been
-    removed
+    removed.
   - `zip317::MultiOutputChangeStrategy`
   - `standard::MultiOutputChangeStrategy`
 - A new feature flag, `non-standard-fees`, has been added. This flag is now

diff --git a/zcash_primitives/CHANGELOG.md b/zcash_primitives/CHANGELOG.md
@@ -31,7 +31,7 @@ and this library adheres to Rust's notion of
 ### Removed
 - `zcash_primitives::transaction::fees`:
   - `StandardFeeRule` itself has been removed; it was not used in this crate.
-    Is use in `zcash_client_backend` has been replaced with
+    Its use in `zcash_client_backend` has been replaced with
     `zcash_client_backend::fees::StandardFeeRule`.
   - `fixed::FeeRule::standard`. This constructor was misleadingly named: using a
     fixed fee does not conform to any current Zcash standard. To calculate the

diff --git a/zcash_primitives/src/transaction/fees/zip317.rs b/zcash_primitives/src/transaction/fees/zip317.rs
@@ -76,6 +76,14 @@ impl FeeRule {
 
     /// Construct a new FeeRule instance with the specified parameter values.
     ///
+    /// Using this fee rule with
+    /// ```compile_fail
+    /// marginal_fee < 5000 || grace_actions < 2 \
+    ///     || p2pkh_standard_input_size > P2PKH_STANDARD_INPUT_SIZE \
+    ///     || p2pkh_standard_output_size > P2PKH_STANDARD_OUTPUT_SIZE
+    /// ```
+    /// violates ZIP 317, and might cause transactions built with it to fail.
+    ///
     /// Returns `None` if either `p2pkh_standard_input_size` or `p2pkh_standard_output_size` are
     /// zero.
     #[cfg(feature = "non-standard-fees")]