zcash_address: Add support for ZIP 316, Revision 1 #1135

nuttycom · 2024-01-25T23:49:57Z

Closes #1153.

codecov · 2024-01-26T00:09:32Z

Codecov Report

Attention: Patch coverage is 63.99217% with 184 lines in your changes missing coverage. Please review.

Project coverage is 63.65%. Comparing base (1ef11c2) to head (2eba3a5).

Files	Patch %	Lines
components/zcash_address/src/kind/unified.rs	50.84%	58 Missing ⚠️
zcash_keys/src/keys.rs	69.71%	53 Missing ⚠️
zcash_keys/src/address.rs	50.00%	45 Missing ⚠️
...mponents/zcash_address/src/kind/unified/address.rs	84.84%	10 Missing ⚠️
...ent_backend/src/data_api/wallet/input_selection.rs	0.00%	6 Missing ⚠️
components/zcash_address/src/kind/unified/fvk.rs	77.77%	4 Missing ⚠️
components/zcash_address/src/kind/unified/ivk.rs	77.77%	4 Missing ⚠️
..._sqlite/src/wallet/init/migrations/ufvk_support.rs	66.66%	2 Missing ⚠️
zcash_client_sqlite/src/wallet.rs	50.00%	1 Missing ⚠️
...lite/src/wallet/init/migrations/addresses_table.rs	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1135      +/-   ##
==========================================
- Coverage   63.90%   63.65%   -0.25%     
==========================================
  Files         132      132              
  Lines       15494    15706     +212     
==========================================
+ Hits         9901     9998      +97     
- Misses       5593     5708     +115

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nuttycom · 2024-02-16T04:33:15Z

Returning to draft status to update the parsing of the HRP for ZIP 316, Revision 1

components/zcash_address/src/encoding.rs

components/zcash_address/src/kind/unified.rs

components/zcash_address/src/kind/unified/fvk.rs

components/zcash_address/src/kind/unified/ivk.rs

zcash_keys/src/address.rs

zcash_keys/src/keys.rs

daira

Some changes needed — see the "(blocking)" comments.

daira · 2024-03-06T23:55:40Z

zcash_keys/src/address.rs

    /// Returns `None` if the receivers would produce an invalid Unified Address (namely,
    /// if no shielded receiver is provided).


Suggested change

/// Returns `None` if the receivers would produce an invalid Unified Address (namely,

/// if no shielded receiver is provided).

/// Returns `None` if the receivers would produce an invalid Unified Address (namely,

/// if no receiver is provided, or if there is only a transparent receiver and no expiry

/// height or time).

daira · 2024-03-06T23:57:27Z

zcash_keys/src/address.rs

+                unknown_data: vec![],
+                expiry_height,
+                expiry_time,
+                unknown_metadata: vec![],
            })


Change this to allow creating a UA with only a transparent receiver plus expiration metadata, consistent with the suggested doc change.

daira · 2024-03-07T00:04:12Z

zcash_keys/src/keys.rs

+        if !(has_orchard || has_sapling || has_p2pkh) {
+            panic!("At least one receiver must be requested.")
        }

        Self {
            has_orchard,
            has_sapling,
            has_p2pkh,
+            expiry_height: None,
+            expiry_time: None,
        }


Suggested change

if !(has_orchard || has_sapling || has_p2pkh) {

panic!("At least one receiver must be requested.")

}

Self {

has_orchard,

has_sapling,

has_p2pkh,

expiry_height: None,

expiry_time: None,

}

Self::new(has_orchard, has_sapling, has_p2pkh, None, None)

.expect("At least one shielded receiver must be requested")

This ensures that the validity checking is consistent between new and unsafe_new_without_expiry. It's correct to panic in the case where only has_p2pkh is true here, because we want to require expiry metadata in that case, and here there isn't any.

Also depends upon the resolution to #1135 (comment)

daira · 2024-03-07T00:16:01Z

zcash_keys/src/keys.rs

            #[cfg(feature = "orchard")]
            orchard,
            #[cfg(feature = "sapling")]
            sapling,
            transparent,
+            std::cmp::min(self.expiry_height, request.expiry_height),
+            std::cmp::min(self.expiry_time, request.expiry_time),
        )
        .ok_or(AddressGenerationError::ShieldedReceiverRequired)


We should make sure that an invalid combination isn't representable as a UnifiedAddressRequest, so that this error is impossible (and can be a panic if it does occur due to some inconsistency).

This is certainly the wrong error to return at this point, but what the correct error is depends upon #1135 (comment)

daira · 2024-03-07T00:20:00Z

zcash_keys/src/keys.rs

+        let mut unknown_data = vec![];
+        let mut expiry_height = None;
+        let mut expiry_time = None;
+        let mut unknown_metadata = vec![];


It's unclear whether unified::Ufvk::decode(encoding) enforces the requirement on the allowed receivers and metadata.

The decoding of Unified containers currently disallows transparent-only UAs; this needs to change but will depend upon the resolution of #1135 (comment).

daira · 2024-03-07T00:20:31Z

zcash_keys/src/keys.rs

+            unknown_data,
+            expiry_height,
+            expiry_time,
+            unknown_metadata,
        })


This does not check the requirement on the allowed receivers and metadata. It may be that an invalid combination can't occur here because of checks in unified::Ufvk::decode(encoding), but if so it's not obvious.

zcash_keys/src/keys.rs

zcash_keys/src/address.rs

daira

Changes requested.

daira · 2024-06-21T02:00:21Z

components/zcash_address/src/kind/unified.rs

+pub enum MetadataTypecode {
+    /// Expiration height metadata as specified in [ZIP 316, Revision 1](https://zips.z.cash/zip-0316)
+    ExpiryHeight,
+    /// Expiration height metadata as specified in [ZIP 316, Revision 1](https://zips.z.cash/zip-0316)


Suggested change

/// Expiration height metadata as specified in [ZIP 316, Revision 1](https://zips.z.cash/zip-0316)

/// Expiration time metadata as specified in [ZIP 316, Revision 1](https://zips.z.cash/zip-0316)

…items.

…variant sizes

Co-authored-by: Daira-Emma Hopwood <[email protected]>

nuttycom marked this pull request as draft January 25, 2024 23:50

nuttycom force-pushed the zcash_address/expiry branch from 87bcae5 to 3314d2a Compare January 26, 2024 00:39

nuttycom force-pushed the zcash_address/expiry branch from 3314d2a to e78a5ec Compare February 15, 2024 23:46

nuttycom added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 16, 2024

nuttycom marked this pull request as ready for review February 16, 2024 00:19

nuttycom force-pushed the zcash_address/expiry branch from e78a5ec to 776ec12 Compare February 16, 2024 04:32

nuttycom marked this pull request as draft February 16, 2024 04:32

nuttycom changed the title ~~zcash_address: Add handling for Unified Metadata Items~~ zcash_address: Add support for ZIP 316, Revision 1 Feb 16, 2024

nuttycom marked this pull request as ready for review February 16, 2024 22:04

nuttycom force-pushed the zcash_address/expiry branch from 93225df to 2833744 Compare February 16, 2024 22:16

daira reviewed Feb 19, 2024

View reviewed changes

components/zcash_address/src/encoding.rs Outdated Show resolved Hide resolved

daira reviewed Feb 20, 2024

View reviewed changes

components/zcash_address/src/kind/unified.rs Outdated Show resolved Hide resolved

daira reviewed Feb 20, 2024

View reviewed changes

components/zcash_address/src/kind/unified.rs Outdated Show resolved Hide resolved

daira reviewed Feb 20, 2024

View reviewed changes

components/zcash_address/src/kind/unified.rs Show resolved Hide resolved

daira reviewed Feb 20, 2024

View reviewed changes

components/zcash_address/src/kind/unified.rs Outdated Show resolved Hide resolved