zcash_client_backend: Rename AccountKind to AccountSource

zcash_client_backend/CHANGELOG.md

@@ -16,7 +16,7 @@ and this library adheres to Rust's notion of
   - `Account`
   - `AccountBalance::with_orchard_balance_mut`
   - `AccountBirthday::orchard_frontier`
-  - `AccountKind`
+  - `AccountSource`
   - `BlockMetadata::orchard_tree_size`
   - `DecryptedTransaction::{new, tx(), orchard_outputs()}`
   - `NoteRetention`

zcash_client_backend/src/data_api.rs

@@ -317,7 +317,7 @@
 
 /// The kinds of accounts supported by `zcash_client_backend`.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
-pub enum AccountKind {
+pub enum AccountSource {
     /// An account derived from a known seed.
     Derived {
         seed_fingerprint: SeedFingerprint,
@@ -335,7 +335,7 @@
 
     /// Returns whether this account is derived or imported, and the derivation parameters
     /// if applicable.
-    fn kind(&self) -> AccountKind;
+    fn source(&self) -> AccountSource;
 
     /// Returns the UFVK that the wallet backend has stored for the account, if any.
     ///
@@ -349,8 +349,8 @@
         self.0
     }
 
-    fn kind(&self) -> AccountKind {
-        AccountKind::Imported
+    fn source(&self) -> AccountSource {
+        AccountSource::Imported
     }
 
     fn ufvk(&self) -> Option<&UnifiedFullViewingKey> {
@@ -363,8 +363,8 @@
         self.0
     }
 
-    fn kind(&self) -> AccountKind {
-        AccountKind::Imported
+    fn source(&self) -> AccountSource {
+        AccountSource::Imported
     }
 
     fn ufvk(&self) -> Option<&UnifiedFullViewingKey> {

zcash_client_sqlite/src/lib.rs

@@ -60,7 +60,7 @@
         self,
         chain::{BlockSource, ChainState, CommitmentTreeRoot},
         scanning::{ScanPriority, ScanRange},
-        Account, AccountBirthday, AccountKind, BlockMetadata, DecryptedTransaction, InputSource,
+        Account, AccountBirthday, AccountSource, BlockMetadata, DecryptedTransaction, InputSource,
         NullifierQuery, ScannedBlock, SentTransaction, SpendableNotes, WalletCommitmentTrees,
         WalletRead, WalletSummary, WalletWrite, SAPLING_SHARD_HEIGHT,
     },
@@ -316,10 +316,10 @@
         seed: &SecretVec<u8>,
     ) -> Result<bool, Self::Error> {
         if let Some(account) = self.get_account(account_id)? {
-            if let AccountKind::Derived {
+            if let AccountSource::Derived {
                 seed_fingerprint,
                 account_index,
-            } = account.kind()
+            } = account.source()
             {
                 let seed_fingerprint_match =
                     SeedFingerprint::from_seed(seed.expose_secret()).ok_or_else(|| {
@@ -527,7 +527,7 @@
             let account_id = wallet::add_account(
                 wdb.conn.0,
                 &wdb.params,
-                AccountKind::Derived {
+                AccountSource::Derived {
                     seed_fingerprint,
                     account_index,
                 },

zcash_client_sqlite/src/wallet.rs

@@ -82,8 +82,8 @@
     address::{Address, UnifiedAddress},
     data_api::{
         scanning::{ScanPriority, ScanRange},
-        AccountBalance, AccountBirthday, AccountKind, BlockMetadata, Ratio, SentTransactionOutput,
-        WalletSummary, SAPLING_SHARD_HEIGHT,
+        AccountBalance, AccountBirthday, AccountSource, BlockMetadata, Ratio,
+        SentTransactionOutput, WalletSummary, SAPLING_SHARD_HEIGHT,
     },
     encoding::AddressCodec,
     keys::UnifiedFullViewingKey,
@@ -139,21 +139,21 @@
 
 pub(crate) const BLOCK_SAPLING_FRONTIER_ABSENT: &[u8] = &[0x0];
 
-fn parse_account_kind(
+fn parse_account_source(
     account_kind: u32,
     hd_seed_fingerprint: Option<[u8; 32]>,
     hd_account_index: Option<u32>,
-) -> Result<AccountKind, SqliteClientError> {
+) -> Result<AccountSource, SqliteClientError> {
     match (account_kind, hd_seed_fingerprint, hd_account_index) {
-        (0, Some(seed_fp), Some(account_index)) => Ok(AccountKind::Derived {
+        (0, Some(seed_fp), Some(account_index)) => Ok(AccountSource::Derived {
             seed_fingerprint: SeedFingerprint::from_bytes(seed_fp),
             account_index: zip32::AccountId::try_from(account_index).map_err(|_| {
                 SqliteClientError::CorruptedData(
                     "ZIP-32 account ID from wallet DB is out of range.".to_string(),
                 )
             })?,
         }),
-        (1, None, None) => Ok(AccountKind::Imported),
+        (1, None, None) => Ok(AccountSource::Imported),
         (0, None, None) | (1, Some(_), Some(_)) => Err(SqliteClientError::CorruptedData(
             "Wallet DB account_kind constraint violated".to_string(),
         )),
@@ -163,10 +163,10 @@
     }
 }
 
-fn account_kind_code(value: AccountKind) -> u32 {
+fn account_kind_code(value: AccountSource) -> u32 {
     match value {
-        AccountKind::Derived { .. } => 0,
-        AccountKind::Imported => 1,
+        AccountSource::Derived { .. } => 0,
+        AccountSource::Imported => 1,
     }
 }
 
@@ -190,7 +190,7 @@
 #[derive(Debug, Clone)]
 pub struct Account {
     account_id: AccountId,
-    kind: AccountKind,
+    kind: AccountSource,
     viewing_key: ViewingKey,
 }
 
@@ -216,7 +216,7 @@
         self.account_id
     }
 
-    fn kind(&self) -> AccountKind {
+    fn source(&self) -> AccountSource {
         self.kind
     }
 
@@ -324,16 +324,16 @@
 pub(crate) fn add_account<P: consensus::Parameters>(
     conn: &rusqlite::Transaction,
     params: &P,
-    kind: AccountKind,
+    kind: AccountSource,
     viewing_key: ViewingKey,
     birthday: AccountBirthday,
 ) -> Result<AccountId, SqliteClientError> {
     let (hd_seed_fingerprint, hd_account_index) = match kind {
-        AccountKind::Derived {
+        AccountSource::Derived {
             seed_fingerprint,
             account_index,
         } => (Some(seed_fingerprint), Some(account_index)),
-        AccountKind::Imported => (None, None),
+        AccountSource::Imported => (None, None),
     };
 
     let orchard_item = viewing_key
@@ -734,7 +734,7 @@
             ],
             |row| {
                 let account_id = row.get::<_, u32>(0).map(AccountId)?;
-                let kind = parse_account_kind(row.get(1)?, row.get(2)?, row.get(3)?)?;
+                let kind = parse_account_source(row.get(1)?, row.get(2)?, row.get(3)?)?;
 
                 // We looked up the account by FVK components, so the UFVK column must be
                 // non-null.
@@ -802,7 +802,7 @@
             }?;
             Ok(Account {
                 account_id,
-                kind: AccountKind::Derived {
+                kind: AccountSource::Derived {
                     seed_fingerprint: *seed,
                     account_index,
                 },
@@ -1511,7 +1511,7 @@
     let row = result.next()?;
     match row {
         Some(row) => {
-            let kind = parse_account_kind(
+            let kind = parse_account_source(
                 row.get("account_kind")?,
                 row.get("hd_seed_fingerprint")?,
                 row.get("hd_account_index")?,
@@ -2700,7 +2700,7 @@
     use std::num::NonZeroU32;
 
     use sapling::zip32::ExtendedSpendingKey;
-    use zcash_client_backend::data_api::{AccountBirthday, AccountKind, WalletRead};
+    use zcash_client_backend::data_api::{AccountBirthday, AccountSource, WalletRead};
     use zcash_primitives::{block::BlockHash, transaction::components::amount::NonNegativeAmount};
 
     use crate::{
@@ -2857,7 +2857,7 @@
         let expected_account_index = zip32::AccountId::try_from(0).unwrap();
         assert_matches!(
             account_parameters.kind,
-            AccountKind::Derived{account_index, ..} if account_index == expected_account_index
+            AccountSource::Derived{account_index, ..} if account_index == expected_account_index
         );
     }
 

zcash_client_sqlite/src/wallet/init.rs

@@ -1282,7 +1282,7 @@ mod tests {
     #[test]
     #[cfg(feature = "transparent-inputs")]
     fn account_produces_expected_ua_sequence() {
-        use zcash_client_backend::data_api::{AccountBirthday, AccountKind, WalletRead};
+        use zcash_client_backend::data_api::{AccountBirthday, AccountSource, WalletRead};
 
         let network = Network::MainNetwork;
         let data_file = NamedTempFile::new().unwrap();
@@ -1301,7 +1301,7 @@ mod tests {
             db_data.get_account(account_id),
             Ok(Some(account)) if matches!(
                 account.kind,
-                AccountKind::Derived{account_index, ..} if account_index == zip32::AccountId::ZERO,
+                AccountSource::Derived{account_index, ..} if account_index == zip32::AccountId::ZERO,
             )
         );
 

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

@@ -5,7 +5,7 @@ use rusqlite::{named_params, Transaction};
 use schemer_rusqlite::RusqliteMigration;
 use secrecy::{ExposeSecret, SecretVec};
 use uuid::Uuid;
-use zcash_client_backend::{data_api::AccountKind, keys::UnifiedSpendingKey};
+use zcash_client_backend::{data_api::AccountSource, keys::UnifiedSpendingKey};
 use zcash_keys::keys::UnifiedFullViewingKey;
 use zcash_primitives::consensus;
 use zip32::fingerprint::SeedFingerprint;
@@ -45,11 +45,11 @@ impl<P: consensus::Parameters> RusqliteMigration for Migration<P> {
     type Error = WalletMigrationError;
 
     fn up(&self, transaction: &Transaction) -> Result<(), WalletMigrationError> {
-        let account_kind_derived = account_kind_code(AccountKind::Derived {
+        let account_kind_derived = account_kind_code(AccountSource::Derived {
             seed_fingerprint: SeedFingerprint::from_bytes([0; 32]),
             account_index: zip32::AccountId::ZERO,
         });
-        let account_kind_imported = account_kind_code(AccountKind::Imported);
+        let account_kind_imported = account_kind_code(AccountSource::Imported);
         transaction.execute_batch(
             &format!(r#"
             PRAGMA foreign_keys = OFF;