zcash_client_sqlite: Assign UUIDs to each account #1631

str4d · 2024-11-21T11:14:44Z

This provides equivalent uniqueness to the accounts table primary key, but avoids collisions across wallet recreation events (to defend against downstream crate users who don't flush any persisted account IDs at those events).

Closes #1629.

codecov · 2024-11-21T12:36:48Z

Codecov Report

Attention: Patch coverage is 72.94833% with 89 lines in your changes missing coverage. Please review.

Project coverage is 56.41%. Comparing base (2df4497) to head (6e1933b).

Files with missing lines	Patch %	Lines
zcash_client_sqlite/src/wallet.rs	71.30%	33 Missing ⚠️
...e/src/wallet/init/migrations/tx_retrieval_queue.rs	56.86%	22 Missing ⚠️
zcash_client_sqlite/src/wallet/transparent.rs	64.70%	12 Missing ⚠️
zcash_client_sqlite/src/lib.rs	61.11%	7 Missing ⚠️
...te/src/wallet/init/migrations/add_account_uuids.rs	92.18%	5 Missing ⚠️
zcash_client_sqlite/src/wallet/orchard.rs	0.00%	5 Missing ⚠️
zcash_client_sqlite/src/error.rs	0.00%	1 Missing ⚠️
zcash_client_sqlite/src/wallet/common.rs	83.33%	1 Missing ⚠️
.../src/wallet/init/migrations/ephemeral_addresses.rs	80.00%	1 Missing ⚠️
zcash_client_sqlite/src/wallet/sapling.rs	85.71%	1 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1631      +/-   ##
==========================================
+ Coverage   56.39%   56.41%   +0.02%     
==========================================
  Files         148      149       +1     
  Lines       19232    19404     +172     
==========================================
+ Hits        10845    10947     +102     
- Misses       8387     8457      +70

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

str4d · 2024-11-22T09:45:04Z

I discovered that the Android SDK is misusing v_tx_outputs by putting to_account_id into a type that actually stores a ZIP 32 account index. These previously were indeed the same type, until #1235 was merged. I think we need to alter the views to expose the account UUIDs instead of the account IDs, particularly as after this PR the account IDs cannot be extracted from AccountId and are intended to be entirely internal.

zcash_client_sqlite/src/lib.rs

zcash_client_sqlite/src/wallet/init/migrations.rs

daira

utACK with comments.

str4d · 2024-11-23T05:51:02Z

Force-pushed to replace account_id in the views with account_uuid (because account_id is now intended to be an internal-only value). cc @AArnott for awareness (though I've also documented it in the changelogs).

zcash_client_sqlite/CHANGELOG.md

zcash_client_sqlite/src/wallet.rs

daira

utACK with this suggestion: https://github.com/zcash/librustzcash/pull/1631/files#r1855319372

nuttycom

If we're going to make this change, we should do so wholesale: replace the contents of the AccountId type with the UUID, and change all the queries to take the UUID (and join to the accounts table if necessary).

zcash_client_sqlite/src/lib.rs

nuttycom · 2024-11-27T05:18:30Z

zcash_client_backend/src/data_api/testing/pool.rs


    st.reset();

    // Account creation and DFVK derivation should be deterministic.
-    let (_, restored_usk) = st.wallet_mut().create_account(&seed, &birthday).unwrap();
+    let (account1, restored_usk) = st.wallet_mut().create_account(&seed, &birthday).unwrap();


This change is necessary because we get new account UUIDs when we regenerate the wallet.

…`AccountUuid` This requires a few annoying changes to migrations in order to avoid hitting cases where account UUIDs are expected before they exist in the database schema.

This is now consistent with how we name other internal primary key type wrappers.

daira · 2024-11-28T20:40:44Z

zcash_client_sqlite/src/error.rs

@@ -129,7 +124,7 @@ pub enum SqliteClientError {
    /// ephemeral address outputs have been mined. The parameters are the account id and


Suggested change

/// ephemeral address outputs have been mined. The parameters are the account id and

/// ephemeral address outputs have been mined. The parameters are the account UUID and

Also s/account_id/account_uuid/ on lines 190 and 192.

daira · 2024-11-28T20:45:17Z

zcash_client_sqlite/src/error.rs

@@ -181,8 +176,7 @@ impl fmt::Display for SqliteClientError {
            SqliteClientError::UnknownZip32Derivation => write!(f, "ZIP-32 derivation information is not known for this account."),
            SqliteClientError::KeyDerivationError(acct_id) => write!(f, "Key derivation failed for account {}", u32::from(*acct_id)),


Suggested change

SqliteClientError::KeyDerivationError(acct_id) => write!(f, "Key derivation failed for account {}", u32::from(*acct_id)),

SqliteClientError::KeyDerivationError(zip32_index) => write!(f, "Key derivation failed for ZIP 32 account index {}", u32::from(*zip32_index)),

daira · 2024-11-28T20:46:24Z

zcash_client_sqlite/src/error.rs

@@ -181,8 +176,7 @@ impl fmt::Display for SqliteClientError {
            SqliteClientError::UnknownZip32Derivation => write!(f, "ZIP-32 derivation information is not known for this account."),
            SqliteClientError::KeyDerivationError(acct_id) => write!(f, "Key derivation failed for account {}", u32::from(*acct_id)),
            SqliteClientError::BadAccountData(e) => write!(f, "Failed to add account: {}", e),
-            SqliteClientError::AccountIdDiscontinuity => write!(f, "Wallet account identifiers must be sequential."),
-            SqliteClientError::AccountIdOutOfRange => write!(f, "Wallet account identifiers must be less than 0x7FFFFFFF."),
+            SqliteClientError::Zip32AccountIndexOutOfRange => write!(f, "ZIP 32 account identifiers must be less than 0x7FFFFFFF."),
            SqliteClientError::AccountCollision(id) => write!(f, "An account corresponding to the data provided already exists in the wallet with internal identifier {}.", id.0),


Suggested change

SqliteClientError::AccountCollision(id) => write!(f, "An account corresponding to the data provided already exists in the wallet with internal identifier {}.", id.0),

SqliteClientError::AccountCollision(account_uuid) => write!(f, "An account corresponding to the data provided already exists in the wallet with UUID {account_uuid:?}."),

(probably needs a rustfmt)

daira · 2024-11-28T20:51:44Z

zcash_client_sqlite/src/lib.rs

@@ -818,7 +848,10 @@ impl<P: consensus::Parameters> WalletWrite for WalletDb<rusqlite::Connection, P>
                    )
                })?;
            let account_index = wallet::max_zip32_account_index(wdb.conn.0, &seed_fingerprint)?


Rename to zip32_account_index.

zcash_client_sqlite: Add missing leaf migration states for tests

45392cf

str4d marked this pull request as ready for review November 22, 2024 02:48

str4d mentioned this pull request Nov 22, 2024

Support for multiple accounts #1335

Open

daira reviewed Nov 22, 2024

View reviewed changes

zcash_client_sqlite/src/lib.rs Outdated Show resolved Hide resolved

daira reviewed Nov 22, 2024

View reviewed changes

zcash_client_sqlite/src/wallet/init/migrations.rs Outdated Show resolved Hide resolved

daira previously approved these changes Nov 22, 2024

View reviewed changes

str4d added 2 commits November 23, 2024 05:49

zcash_client_sqlite: Add a uuid column to the accounts table

fd5bb46

zcash_client_sqlite: Add AccountUuid to expose the uuid column

bf42ec2

str4d dismissed daira’s stale review via bf42ec2 November 23, 2024 05:49

str4d force-pushed the 1629-zcs-account-id branch from c8aff5b to bf42ec2 Compare November 23, 2024 05:49

daira mentioned this pull request Nov 23, 2024

[#1511] Refactor account representation from int to a dedicated account structure Electric-Coin-Company/zcash-swift-wallet-sdk#1515

Merged

14 tasks

daira reviewed Nov 23, 2024

View reviewed changes

zcash_client_sqlite/CHANGELOG.md Outdated Show resolved Hide resolved

daira reviewed Nov 23, 2024

View reviewed changes

zcash_client_sqlite/src/wallet.rs Show resolved Hide resolved

daira reviewed Nov 24, 2024

View reviewed changes

zcash_client_sqlite/src/wallet.rs Outdated Show resolved Hide resolved

daira previously approved these changes Nov 24, 2024

View reviewed changes

nuttycom requested changes Nov 25, 2024

View reviewed changes

zcash_client_sqlite/src/lib.rs Outdated Show resolved Hide resolved

zcash_client_sqlite/src/lib.rs Outdated Show resolved Hide resolved

daira reviewed Nov 25, 2024

View reviewed changes

zcash_client_sqlite/src/lib.rs Outdated Show resolved Hide resolved

nuttycom dismissed daira’s stale review via 48d6694 November 27, 2024 00:27

nuttycom force-pushed the 1629-zcs-account-id branch 2 times, most recently from 4885b4d to 03e68c6 Compare November 27, 2024 00:56

nuttycom reviewed Nov 27, 2024

View reviewed changes

zcash_client_sqlite: Change WalletDb::AccountId associated type to …

546481e

…`AccountUuid` This requires a few annoying changes to migrations in order to avoid hitting cases where account UUIDs are expected before they exist in the database schema.

nuttycom force-pushed the 1629-zcs-account-id branch from 03e68c6 to 546481e Compare November 27, 2024 05:25

zcash_client_sqlite: Rename AccountId internal type to AccountRef

6e1933b

This is now consistent with how we name other internal primary key type wrappers.

daira reviewed Nov 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zcash_client_sqlite: Assign UUIDs to each account #1631

zcash_client_sqlite: Assign UUIDs to each account #1631

str4d commented Nov 21, 2024

codecov bot commented Nov 21, 2024 •

edited

Loading

str4d commented Nov 22, 2024

daira left a comment

str4d commented Nov 23, 2024

daira left a comment

nuttycom left a comment

nuttycom Nov 27, 2024

daira Nov 28, 2024 •

edited

Loading

daira Nov 28, 2024

daira Nov 28, 2024 •

edited

Loading

daira Nov 28, 2024

		@@ -129,7 +124,7 @@ pub enum SqliteClientError {
		/// ephemeral address outputs have been mined. The parameters are the account id and

		@@ -181,8 +176,7 @@ impl fmt::Display for SqliteClientError {
		SqliteClientError::UnknownZip32Derivation => write!(f, "ZIP-32 derivation information is not known for this account."),
		SqliteClientError::KeyDerivationError(acct_id) => write!(f, "Key derivation failed for account {}", u32::from(*acct_id)),

	SqliteClientError::KeyDerivationError(acct_id) => write!(f, "Key derivation failed for account {}", u32::from(*acct_id)),
	SqliteClientError::KeyDerivationError(zip32_index) => write!(f, "Key derivation failed for ZIP 32 account index {}", u32::from(*zip32_index)),

	SqliteClientError::AccountCollision(id) => write!(f, "An account corresponding to the data provided already exists in the wallet with internal identifier {}.", id.0),
	SqliteClientError::AccountCollision(account_uuid) => write!(f, "An account corresponding to the data provided already exists in the wallet with UUID {account_uuid:?}."),

zcash_client_sqlite: Assign UUIDs to each account #1631

Are you sure you want to change the base?

zcash_client_sqlite: Assign UUIDs to each account #1631

Conversation

str4d commented Nov 21, 2024

codecov bot commented Nov 21, 2024 • edited Loading

Codecov Report

str4d commented Nov 22, 2024

daira left a comment

Choose a reason for hiding this comment

str4d commented Nov 23, 2024

daira left a comment

Choose a reason for hiding this comment

nuttycom left a comment

Choose a reason for hiding this comment

nuttycom Nov 27, 2024

Choose a reason for hiding this comment

daira Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

daira Nov 28, 2024

Choose a reason for hiding this comment

daira Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

daira Nov 28, 2024

Choose a reason for hiding this comment

codecov bot commented Nov 21, 2024 •

edited

Loading

daira Nov 28, 2024 •

edited

Loading

daira Nov 28, 2024 •

edited

Loading