zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Make `WalletWrite` documentation for colliding accounts more precise

This commit is contained in:
Jack Grigg 2024-07-31 21:45:12 +00:00 committed by Daira-Emma Hopwood
parent 9cfce187f0
commit 15bc35cd32
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
zcash_client_backend/src/data_api.rs
View File

@ -1703,11 +1703,20 @@ impl AccountBirthday {
/// - If [`WalletWrite::import_account_hd`] is used to import accounts with non-sequential /// - If [`WalletWrite::import_account_hd`] is used to import accounts with non-sequential
/// ZIP 32 account indices from the same seed, a call to [`WalletWrite::create_account`] /// ZIP 32 account indices from the same seed, a call to [`WalletWrite::create_account`]
/// will use the ZIP 32 account index just after the highest-numbered existing account. /// will use the ZIP 32 account index just after the highest-numbered existing account.
/// - If an account is imported via [`WalletWrite::import_account_ufvk`], and then a later /// - If an account is added to the wallet, and then a later call to one of the methods
/// call to either [`WalletWrite::create_account`] or [`WalletWrite::import_account_hd`] /// would produce the same UFVK, an error will be returned. While any combination of
/// would produce the same UFVK, an error will be returned. /// method calls can cause this, there are two main ways it can occur that users of the
/// - A future change to this trait might introduce a method to "upgrade" an imported /// `WalletWrite` trait should watch out for:
/// account with derivation information. See [zcash/librustzcash#1284] for details. /// - An account is created via [`WalletWrite::create_account`] with an auto-selected
/// ZIP 32 account index, and that index is later imported explicitly via either
/// [`WalletWrite::import_account_hd`] or [`WalletWrite::import_account_ufvk`].
/// - An account is imported via [`WalletWrite::import_account_ufvk`], and the ZIP 32
/// account index corresponding to that account's UFVK is later imported either
/// implicitly via [`WalletWrite::create_account`] or explicitly via
/// [`WalletWrite::import_account_hd`].
///
/// A future change to this trait might introduce a method to "upgrade" an imported
/// account with derivation information. See [zcash/librustzcash#1284] for details.
/// ///
/// Users of the `WalletWrite` trait should generally distinguish in their APIs and wallet /// Users of the `WalletWrite` trait should generally distinguish in their APIs and wallet
/// UIs between creating a new account, and importing an account that previously existed. /// UIs between creating a new account, and importing an account that previously existed.