Work-in-progress database support for ZIP 320.

Co-authored-by: Kris Nuttycombe <[email protected]>
Co-authored-by: Jack Grigg <[email protected]>
Signed-off-by: Daira-Emma Hopwood <[email protected]>

Author: 3 people

zcash_client_sqlite/src/wallet/init.rs

@@ -234,6 +234,8 @@ mod tests {
                 p2pkh_fvk_item_cache BLOB,
                 birthday_height INTEGER NOT NULL,
                 recover_until_height INTEGER,
+                first_unmined_ephemeral_index INTEGER NOT NULL DEFAULT 0,
+                first_unused_ephemeral_index INTEGER NOT NULL DEFAULT 0 CONSTRAINT unused_gte_unmined CHECK (first_unused_ephemeral_index >= first_unmined_ephemeral_index),
                 CHECK ( (account_kind = 0 AND hd_seed_fingerprint IS NOT NULL AND hd_account_index IS NOT NULL AND ufvk IS NOT NULL) OR (account_kind = 1 AND hd_seed_fingerprint IS NULL AND hd_account_index IS NULL) )
             )"#,
             r#"CREATE TABLE "addresses" (

zcash_client_sqlite/src/wallet/init/migrations.rs

@@ -13,6 +13,7 @@ mod sapling_memo_consistency;
 mod sent_notes_to_internal;
 mod shardtree_support;
 mod ufvk_support;
+mod used_addresses;
 mod utxos_table;
 mod v_sapling_shard_unscanned_ranges;
 mod v_transactions_net;
@@ -61,8 +62,8 @@ pub(super) fn all_migrations<P: consensus::Parameters + 'static>(
     //                                               \       |       v_transactions_note_uniqueness
     //                                                \      |        /
     //                                                full_account_ids
-    //                                                       |
-    //                                             orchard_received_notes
+    //                                               /                \
+    //                              orchard_received_notes        used_addresses
     vec![
         Box::new(initial_setup::Migration {}),
         Box::new(utxos_table::Migration {}),
@@ -109,5 +110,6 @@ pub(super) fn all_migrations<P: consensus::Parameters + 'static>(
             params: params.clone(),
         }),
         Box::new(orchard_received_notes::Migration),
+        Box::new(used_addresses::Migration),
     ]
 }

zcash_client_sqlite/src/wallet/init/migrations/used_addresses.rs

@@ -0,0 +1,55 @@
+//! The migration that records ephemeral addresses used beyond the last known mined address, for each account.
+use std::collections::HashSet;
+
+use rusqlite;
+use schemer;
+use schemer_rusqlite::RusqliteMigration;
+use uuid::Uuid;
+
+use crate::wallet::init::WalletMigrationError;
+
+use super::full_account_ids;
+
+pub(super) const MIGRATION_ID: Uuid = Uuid::from_u128(0x0e1d4274_1f8e_44e2_909d_689a4bc2967b);
+
+pub(super) struct Migration;
+
+impl schemer::Migration for Migration {
+    fn id(&self) -> Uuid {
+        MIGRATION_ID
+    }
+
+    fn dependencies(&self) -> HashSet<Uuid> {
+        [full_account_ids::MIGRATION_ID].into_iter().collect()
+    }
+
+    fn description(&self) -> &'static str {
+        "Record ephemeral addresses used beyond the last known mined address, for each account."
+    }
+}
+
+impl RusqliteMigration for Migration {
+    type Error = WalletMigrationError;
+
+    fn up(&self, transaction: &rusqlite::Transaction) -> Result<(), WalletMigrationError> {
+        transaction.execute_batch(
+            r#"
+            ALTER TABLE accounts ADD first_unmined_ephemeral_index INTEGER NOT NULL DEFAULT 0;
+            ALTER TABLE accounts ADD first_unused_ephemeral_index INTEGER NOT NULL DEFAULT 0
+                CONSTRAINT unused_gte_unmined CHECK (first_unused_ephemeral_index >= first_unmined_ephemeral_index);
+            "#,
+        )?;
+        Ok(())
+    }
+
+    fn down(&self, transaction: &rusqlite::Transaction) -> Result<(), WalletMigrationError> {
+        transaction.execute_batch(
+            r#"
+            -- Dropping first_unused_ephemeral_index also drops its constraint.
+            ALTER TABLE accounts DROP COLUMN first_unused_ephemeral_index;
+            ALTER TABLE accounts DROP COLUMN first_unmined_ephemeral_index;
+            "#,
+        )?;
+        Ok(())
+    }
+}