Merge pull request #1575 from zcash/schemerz-0.1

zcash_client_sqlite: Migrate from `schemer` to `schemerz`
zcash · Oct 16, 2024 · 4bccae7 · 4bccae7
2 parents dd51c2a + 6fa96f6
commit 4bccae7
Show file tree

Hide file tree

Showing 42 changed files with 123 additions and 125 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -124,8 +124,8 @@ subtle = "2.2.3"
 #   CocoaPods, due to being bound to React Native. We need to ensure that the SQLite
 #   version required for `rusqlite` is a version that is available through CocoaPods.
 rusqlite = { version = "0.29.0", features = ["bundled"] }
-schemer = "0.2"
-schemer-rusqlite = "0.2.2"
+schemerz = "0.1"
+schemerz-rusqlite = "0.290"
 time = "0.3.22"
 uuid = "1.1"
 

diff --git a/supply-chain/audits.toml b/supply-chain/audits.toml
@@ -717,6 +717,18 @@ user-id = 169181 # Kris Nuttycombe (nuttycom)
 start = "2024-08-12"
 end = "2025-08-12"
 
+[[trusted.schemerz]]
+criteria = "safe-to-deploy"
+user-id = 6289 # Jack Grigg (str4d)
+start = "2024-10-15"
+end = "2025-10-15"
+
+[[trusted.schemerz-rusqlite]]
+criteria = "safe-to-deploy"
+user-id = 6289 # Jack Grigg (str4d)
+start = "2024-10-15"
+end = "2025-10-15"
+
 [[trusted.shardtree]]
 criteria = "safe-to-deploy"
 user-id = 169181 # Kris Nuttycombe (nuttycom)

diff --git a/supply-chain/config.toml b/supply-chain/config.toml
@@ -1042,14 +1042,6 @@ criteria = "safe-to-deploy"
 version = "0.5.0"
 criteria = "safe-to-deploy"
 
-[[exemptions.schemer]]
-version = "0.2.1"
-criteria = "safe-to-deploy"
-
-[[exemptions.schemer-rusqlite]]
-version = "0.2.2"
-criteria = "safe-to-deploy"
-
 [[exemptions.scopeguard]]
 version = "1.1.0"
 criteria = "safe-to-deploy"

diff --git a/supply-chain/imports.lock b/supply-chain/imports.lock
@@ -76,6 +76,20 @@ user-id = 169181
 user-login = "nuttycom"
 user-name = "Kris Nuttycombe"
 
+[[publisher.schemerz]]
+version = "0.1.0"
+when = "2024-10-15"
+user-id = 6289
+user-login = "str4d"
+user-name = "Jack Grigg"
+
+[[publisher.schemerz-rusqlite]]
+version = "0.290.0"
+when = "2024-10-15"
+user-id = 6289
+user-login = "str4d"
+user-name = "Jack Grigg"
+
 [[publisher.shardtree]]
 version = "0.5.0"
 when = "2024-10-04"

diff --git a/zcash_client_sqlite/CHANGELOG.md b/zcash_client_sqlite/CHANGELOG.md
@@ -11,6 +11,9 @@ and this library adheres to Rust's notion of
 - Exposed `AccountId::from_u32` and `AccountId::as_u32` conversions under the
   `unstable` feature flag.
 
+### Changed
+- Migrated from `schemer` to our fork `schemerz`.
+
 ## [0.12.1] - 2024-10-10
 
 ### Fixed

diff --git a/zcash_client_sqlite/Cargo.toml b/zcash_client_sqlite/Cargo.toml
@@ -67,8 +67,8 @@ shardtree = { workspace = true, features = ["legacy-api"] }
 
 # - SQLite databases
 rusqlite = { workspace = true, features = ["time", "array"] }
-schemer.workspace = true
-schemer-rusqlite.workspace = true
+schemerz.workspace = true
+schemerz-rusqlite.workspace = true
 time.workspace = true
 uuid.workspace = true
 regex = "1.4"

diff --git a/zcash_client_sqlite/src/chain/init.rs b/zcash_client_sqlite/src/chain/init.rs
@@ -5,8 +5,8 @@ use crate::BlockDb;
 use {
     super::migrations,
     crate::FsBlockDb,
-    schemer::{Migrator, MigratorError},
-    schemer_rusqlite::RusqliteAdapter,
+    schemerz::{Migrator, MigratorError},
+    schemerz_rusqlite::RusqliteAdapter,
 };
 
 /// Sets up the internal structure of the cache database.

diff --git a/zcash_client_sqlite/src/chain/migrations/blockmeta.rs b/zcash_client_sqlite/src/chain/migrations/blockmeta.rs
@@ -1,13 +1,13 @@
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 
 pub fn all_migrations() -> Vec<Box<dyn RusqliteMigration<Error = rusqlite::Error>>> {
     vec![Box::new(init::Migration {})]
 }
 
 pub mod init {
     use rusqlite::{self};
-    use schemer::{self, migration};
-    use schemer_rusqlite::RusqliteMigration;
+    use schemerz::{self, migration};
+    use schemerz_rusqlite::RusqliteMigration;
     use uuid::Uuid;
 
     pub struct Migration;

diff --git a/zcash_client_sqlite/src/wallet/db.rs b/zcash_client_sqlite/src/wallet/db.rs
@@ -662,8 +662,8 @@ pub(super) const INDEX_NF_MAP_LOCATOR_IDX: &str =
 // Internal tables
 //
 
-/// Internal table used by [`schemer`] to manage migrations.
-pub(super) const TABLE_SCHEMER_MIGRATIONS: &str = "
+/// Internal table used by [`schemerz`] to manage migrations.
+pub(super) const TABLE_SCHEMERZ_MIGRATIONS: &str = "
 CREATE TABLE schemer_migrations (
     id blob PRIMARY KEY
 )";

diff --git a/zcash_client_sqlite/src/wallet/init.rs b/zcash_client_sqlite/src/wallet/init.rs
@@ -4,8 +4,8 @@ use std::fmt;
 use std::rc::Rc;
 
 use regex::Regex;
-use schemer::{Migrator, MigratorError};
-use schemer_rusqlite::RusqliteAdapter;
+use schemerz::{Migrator, MigratorError};
+use schemerz_rusqlite::RusqliteAdapter;
 use secrecy::SecretVec;
 use shardtree::error::ShardTreeError;
 use uuid::Uuid;
@@ -240,7 +240,7 @@ fn sqlite_client_error_to_wallet_migration_error(e: SqliteClientError) -> Wallet
 /// In order to correctly apply migrations to accounts derived from a seed, sometimes the
 /// optional `seed` argument is required. This function should first be invoked with
 /// `seed` set to `None`; if a pending migration requires the seed, the function returns
-/// `Err(schemer::MigratorError::Migration { error: WalletMigrationError::SeedRequired, .. })`.
+/// `Err(schemerz::MigratorError::Migration { error: WalletMigrationError::SeedRequired, .. })`.
 /// The caller can then re-call this function with the necessary seed.
 ///
 /// > Note that currently only one seed can be provided; as such, wallets containing
@@ -251,8 +251,8 @@ fn sqlite_client_error_to_wallet_migration_error(e: SqliteClientError) -> Wallet
 /// _relevance_: if any account in the wallet for which [`Account::source`] is
 /// [`AccountSource::Derived`] can be derived from the given seed, the seed is relevant to
 /// the wallet. If the given seed is not relevant, the function returns
-/// `Err(schemer::MigratorError::Migration { error: WalletMigrationError::SeedNotRelevant, .. })`
-/// or `Err(schemer::MigratorError::Adapter(WalletMigrationError::SeedNotRelevant))`.
+/// `Err(schemerz::MigratorError::Migration { error: WalletMigrationError::SeedNotRelevant, .. })`
+/// or `Err(schemerz::MigratorError::Adapter(WalletMigrationError::SeedNotRelevant))`.
 ///
 /// We do not check whether the seed is relevant to any imported account, because that
 /// would require brute-forcing the ZIP 32 account index space. Consequentially, imported
@@ -480,7 +480,7 @@ mod tests {
             db::TABLE_SAPLING_TREE_CHECKPOINTS,
             db::TABLE_SAPLING_TREE_SHARDS,
             db::TABLE_SCAN_QUEUE,
-            db::TABLE_SCHEMER_MIGRATIONS,
+            db::TABLE_SCHEMERZ_MIGRATIONS,
             db::TABLE_SENT_NOTES,
             db::TABLE_SQLITE_SEQUENCE,
             db::TABLE_TRANSACTIONS,
@@ -1069,7 +1069,7 @@ mod tests {
         );
         assert_matches!(
             init_wallet_db(&mut db_data, Some(Secret::new(other_seed.to_vec()))),
-            Err(schemer::MigratorError::Adapter(
+            Err(schemerz::MigratorError::Adapter(
                 WalletMigrationError::SeedNotRelevant
             ))
         );

diff --git a/zcash_client_sqlite/src/wallet/init/migrations.rs b/zcash_client_sqlite/src/wallet/init/migrations.rs
@@ -31,7 +31,7 @@ mod wallet_summaries;
 
 use std::rc::Rc;
 
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use secrecy::SecretVec;
 use uuid::Uuid;
 use zcash_protocol::consensus;

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/add_account_birthdays.rs b/zcash_client_sqlite/src/wallet/init/migrations/add_account_birthdays.rs
@@ -2,7 +2,7 @@
 
 use std::collections::HashSet;
 
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 use zcash_primitives::consensus::{self, NetworkUpgrade};
 
@@ -18,7 +18,7 @@ pub(super) struct Migration<P> {
     pub(super) params: P,
 }
 
-impl<P> schemer::Migration for Migration<P> {
+impl<P> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/add_transaction_views.rs b/zcash_client_sqlite/src/wallet/init/migrations/add_transaction_views.rs
@@ -2,7 +2,7 @@
 use std::collections::HashSet;
 
 use rusqlite::{self, types::ToSql, OptionalExtension};
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 
 use zcash_primitives::{
@@ -25,7 +25,7 @@ const DEPENDENCIES: &[Uuid] = &[
 
 pub(crate) struct Migration;
 
-impl schemer::Migration for Migration {
+impl schemerz::Migration for Migration {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/add_utxo_account.rs b/zcash_client_sqlite/src/wallet/init/migrations/add_utxo_account.rs
@@ -1,7 +1,6 @@
 //! A migration that adds an identifier for the account that received a UTXO to the utxos table
-use rusqlite;
-use schemer;
-use schemer_rusqlite::RusqliteMigration;
+
+use schemerz_rusqlite::RusqliteMigration;
 use std::collections::HashSet;
 use uuid::Uuid;
 use zcash_primitives::consensus;
@@ -34,7 +33,7 @@ pub(super) struct Migration<P> {
     pub(super) _params: P,
 }
 
-impl<P> schemer::Migration for Migration<P> {
+impl<P> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/addresses_table.rs b/zcash_client_sqlite/src/wallet/init/migrations/addresses_table.rs
@@ -1,8 +1,7 @@
 use std::collections::HashSet;
 
 use rusqlite::{named_params, Transaction};
-use schemer;
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 use zcash_client_backend::{address::Address, keys::UnifiedFullViewingKey};
 use zcash_keys::{address::UnifiedAddress, encoding::AddressCodec, keys::UnifiedAddressRequest};
@@ -26,7 +25,7 @@ pub(crate) struct Migration<P: consensus::Parameters> {
     pub(crate) params: P,
 }
 
-impl<P: consensus::Parameters> schemer::Migration for Migration<P> {
+impl<P: consensus::Parameters> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/ensure_orchard_ua_receiver.rs b/zcash_client_sqlite/src/wallet/init/migrations/ensure_orchard_ua_receiver.rs
@@ -2,7 +2,7 @@
 use std::collections::HashSet;
 
 use rusqlite::named_params;
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 
 use zcash_client_backend::keys::{
@@ -21,7 +21,7 @@ pub(super) struct Migration<P> {
     pub(super) params: P,
 }
 
-impl<P> schemer::Migration for Migration<P> {
+impl<P> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/ephemeral_addresses.rs b/zcash_client_sqlite/src/wallet/init/migrations/ephemeral_addresses.rs
@@ -1,9 +1,7 @@
 //! The migration that records ephemeral addresses for each account.
 use std::collections::HashSet;
 
-use rusqlite;
-use schemer;
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 use zcash_protocol::consensus;
 
@@ -23,7 +21,7 @@ pub(super) struct Migration<P> {
     pub(super) params: P,
 }
 
-impl<P> schemer::Migration for Migration<P> {
+impl<P> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/fix_broken_commitment_trees.rs b/zcash_client_sqlite/src/wallet/init/migrations/fix_broken_commitment_trees.rs
@@ -2,9 +2,8 @@
 //! reorg handling.
 use std::collections::HashSet;
 
-use rusqlite::{self, OptionalExtension};
-use schemer;
-use schemer_rusqlite::RusqliteMigration;
+use rusqlite::OptionalExtension;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 use zcash_protocol::consensus::{self, BlockHeight};
 
@@ -21,7 +20,7 @@ pub(super) struct Migration<P> {
     pub(super) params: P,
 }
 
-impl<P> schemer::Migration for Migration<P> {
+impl<P> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/full_account_ids.rs b/zcash_client_sqlite/src/wallet/init/migrations/full_account_ids.rs
@@ -2,7 +2,7 @@ use std::{collections::HashSet, rc::Rc};
 
 use crate::wallet::{account_kind_code, init::WalletMigrationError};
 use rusqlite::{named_params, OptionalExtension, Transaction};
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use secrecy::{ExposeSecret, SecretVec};
 use uuid::Uuid;
 use zcash_client_backend::{
@@ -33,7 +33,7 @@ const DEPENDENCIES: &[Uuid] = &[
     wallet_summaries::MIGRATION_ID,
 ];
 
-impl<P: consensus::Parameters> schemer::Migration for Migration<P> {
+impl<P: consensus::Parameters> schemerz::Migration for Migration<P> {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }

diff --git a/zcash_client_sqlite/src/wallet/init/migrations/initial_setup.rs b/zcash_client_sqlite/src/wallet/init/migrations/initial_setup.rs
@@ -1,9 +1,7 @@
 //! The migration that performs the initial setup of the wallet database.
 use std::collections::HashSet;
 
-use rusqlite;
-use schemer;
-use schemer_rusqlite::RusqliteMigration;
+use schemerz_rusqlite::RusqliteMigration;
 use uuid::Uuid;
 
 use crate::wallet::init::WalletMigrationError;
@@ -13,7 +11,7 @@ pub(super) const MIGRATION_ID: Uuid = Uuid::from_u128(0xbc4f5e57_d600_4b6c_990f_
 
 pub(super) struct Migration;
 
-impl schemer::Migration for Migration {
+impl schemerz::Migration for Migration {
     fn id(&self) -> Uuid {
         MIGRATION_ID
     }