clippy!: fix large enum variants

..by `Box`ing the descriptor in `LoadMismatch` enum,
and by boxing the ChangeSet in `DataAlreadyExists` variant of
`CreateWithPersistError`.

We allow the large_enum_variant lint for `FileStoreError` for now,
as it is planned to be fixed in a future version of `bdk_file_store`.

Author: ValuedMammal

src/lib.rs

@@ -8,9 +8,6 @@
 #![no_std]
 #![warn(missing_docs)]
 #![allow(clippy::uninlined_format_args)]
-// TODO: these can be removed after <https://github.com/bitcoindevkit/bdk_wallet/issues/245>
-#![allow(clippy::result_large_err)]
-#![allow(clippy::large_enum_variant)]
 
 #[cfg(feature = "std")]
 #[macro_use]

src/wallet/mod.rs

@@ -229,9 +229,9 @@ pub enum LoadMismatch {
         /// Keychain identifying the descriptor.
         keychain: KeychainKind,
         /// The loaded descriptor.
-        loaded: Option<ExtendedDescriptor>,
+        loaded: Option<Box<ExtendedDescriptor>>,
         /// The expected descriptor.
-        expected: Option<ExtendedDescriptor>,
+        expected: Option<Box<ExtendedDescriptor>>,
     },
 }
 
@@ -602,8 +602,8 @@ impl Wallet {
                 if descriptor.descriptor_id() != exp_desc.descriptor_id() {
                     return Err(LoadError::Mismatch(LoadMismatch::Descriptor {
                         keychain: KeychainKind::External,
-                        loaded: Some(descriptor),
-                        expected: Some(exp_desc),
+                        loaded: Some(Box::new(descriptor)),
+                        expected: Some(Box::new(exp_desc)),
                     }));
                 }
                 if params.extract_keys {
@@ -612,7 +612,7 @@ impl Wallet {
             } else {
                 return Err(LoadError::Mismatch(LoadMismatch::Descriptor {
                     keychain: KeychainKind::External,
-                    loaded: Some(descriptor),
+                    loaded: Some(Box::new(descriptor)),
                     expected: None,
                 }));
             }
@@ -632,7 +632,7 @@ impl Wallet {
                     return Err(LoadError::Mismatch(LoadMismatch::Descriptor {
                         keychain: KeychainKind::Internal,
                         loaded: None,
-                        expected: Some(exp_desc),
+                        expected: Some(Box::new(exp_desc)),
                     }));
                 }
             }
@@ -646,7 +646,7 @@ impl Wallet {
                 None => {
                     return Err(LoadError::Mismatch(LoadMismatch::Descriptor {
                         keychain: KeychainKind::Internal,
-                        loaded: Some(desc),
+                        loaded: Some(Box::new(desc)),
                         expected: None,
                     }))
                 }
@@ -658,8 +658,8 @@ impl Wallet {
                     if desc.descriptor_id() != exp_desc.descriptor_id() {
                         return Err(LoadError::Mismatch(LoadMismatch::Descriptor {
                             keychain: KeychainKind::Internal,
-                            loaded: Some(desc),
-                            expected: Some(exp_desc),
+                            loaded: Some(Box::new(desc)),
+                            expected: Some(Box::new(exp_desc)),
                         }));
                     }
                     if params.extract_keys {

src/wallet/persisted.rs

@@ -150,7 +150,9 @@ impl<P: WalletPersister> PersistedWallet<P> {
     ) -> Result<Self, CreateWithPersistError<P::Error>> {
         let existing = P::initialize(persister).map_err(CreateWithPersistError::Persist)?;
         if !existing.is_empty() {
-            return Err(CreateWithPersistError::DataAlreadyExists(existing));
+            return Err(CreateWithPersistError::DataAlreadyExists(Box::new(
+                existing,
+            )));
         }
         let mut inner =
             Wallet::create_with_params(params).map_err(CreateWithPersistError::Descriptor)?;
@@ -207,7 +209,9 @@ impl<P: AsyncWalletPersister> PersistedWallet<P> {
             .await
             .map_err(CreateWithPersistError::Persist)?;
         if !existing.is_empty() {
-            return Err(CreateWithPersistError::DataAlreadyExists(existing));
+            return Err(CreateWithPersistError::DataAlreadyExists(Box::new(
+                existing,
+            )));
         }
         let mut inner =
             Wallet::create_with_params(params).map_err(CreateWithPersistError::Descriptor)?;
@@ -293,6 +297,7 @@ impl WalletPersister for bdk_chain::rusqlite::Connection {
 /// Error for [`bdk_file_store`]'s implementation of [`WalletPersister`].
 #[cfg(feature = "file_store")]
 #[derive(Debug)]
+#[allow(clippy::large_enum_variant)]
 pub enum FileStoreError {
     /// Error when loading from the store.
     Load(bdk_file_store::StoreErrorWithDump<ChangeSet>),
@@ -357,7 +362,7 @@ pub enum CreateWithPersistError<E> {
     /// Error from persistence.
     Persist(E),
     /// Persister already has wallet data.
-    DataAlreadyExists(ChangeSet),
+    DataAlreadyExists(Box<ChangeSet>),
     /// Occurs when the loaded changeset cannot construct [`Wallet`].
     Descriptor(DescriptorError),
 }

tests/persisted_wallet.rs

@@ -421,7 +421,7 @@ fn single_descriptor_wallet_persist_and_recover() {
     assert_matches!(
         err,
         Err(LoadWithPersistError::InvalidChangeSet(LoadError::Mismatch(LoadMismatch::Descriptor { keychain, loaded, expected })))
-        if keychain == KeychainKind::Internal && loaded.is_none() && expected == Some(exp_desc),
+        if keychain == KeychainKind::Internal && loaded.is_none() && expected == Some(Box::new(exp_desc)),
         "single descriptor wallet should refuse change descriptor param"
     );
 }