fixup! tests: add tests for KeyRing and Wallet

Author: thunderbiscuit

src/persist_test_utils.rs

@@ -160,7 +160,6 @@ pub fn persist_wallet_changeset<Store, CreateStore, K>(
     let keyring_changeset = crate::keyring::ChangeSet {
         network: Some(Network::Testnet),
         descriptors: [(keychain.clone(), descriptor.clone())].into(),
-        default_keychain: Some(keychain),
     };
 
     let mut changeset = ChangeSet {
@@ -273,7 +272,6 @@ pub fn persist_multiple_wallet_changesets<Store, CreateStores, K>(
     let keyring_changeset = crate::keyring::ChangeSet {
         network: Some(Network::Testnet),
         descriptors: [(keychain.clone(), descriptor.clone())].into(),
-        default_keychain: Some(keychain.clone()),
     };
 
     let changeset1 = ChangeSet {
@@ -295,7 +293,6 @@ pub fn persist_multiple_wallet_changesets<Store, CreateStores, K>(
     let keyring_changeset2 = crate::keyring::ChangeSet {
         network: Some(Network::Testnet),
         descriptors: [(keychain.clone(), descriptor.clone())].into(),
-        default_keychain: Some(keychain),
     };
 
     let changeset2 = ChangeSet {
@@ -392,7 +389,6 @@ pub fn persist_keychain<Store, CreateStore, K>(
 
     let keyring_changeset = crate::keyring::ChangeSet {
         descriptors: [(keychain.clone(), descriptor.clone())].into(),
-        default_keychain: Some(keychain.clone()),
         ..crate::keyring::ChangeSet::default()
     };
 
@@ -411,8 +407,6 @@ pub fn persist_keychain<Store, CreateStore, K>(
         *changeset_read.keyring.descriptors.get(&keychain).unwrap(),
         descriptor
     );
-
-    assert_eq!(changeset_read.keyring.default_keychain, Some(keychain));
 }
 
 /// tests if multiple descriptors are being persisted correctly
@@ -454,7 +448,6 @@ pub fn persist_keychains<Store, CreateStore, K>(
             (keychain2.clone(), desc2.clone()),
         ]
         .into(),
-        default_keychain: Some(keychain1.clone()),
         ..crate::keyring::ChangeSet::default()
     };
 
@@ -478,13 +471,7 @@ pub fn persist_keychains<Store, CreateStore, K>(
         desc2
     );
 
-    assert_eq!(
-        changeset_read.keyring.default_keychain,
-        Some(keychain1.clone())
-    );
-
     let keyring_changeset_new = crate::keyring::ChangeSet {
-        default_keychain: Some(keychain2.clone()),
         ..crate::keyring::ChangeSet::default()
     };
 
@@ -497,10 +484,7 @@ pub fn persist_keychains<Store, CreateStore, K>(
 
     let changeset_read_new =
         WalletPersister::initialize(&mut store).expect("should read persisted changeset");
-    assert_eq!(
-        changeset_read_new.keyring.default_keychain,
-        Some(keychain2.clone())
-    );
+
     assert_eq!(
         *changeset_read_new
             .keyring

src/test_utils.rs

@@ -63,7 +63,7 @@ pub fn new_wallet_and_funding_update(
         .expect("descriptor must be valid");
     if let Some(change_desc) = change_descriptor {
         keyring
-            .add_descriptor(KeychainKind::Internal, change_desc, false)
+            .add_descriptor(KeychainKind::Internal, change_desc)
             .expect("descriptor must be valid");
     };
 

tests/keyring.rs

@@ -26,7 +26,6 @@ fn test_simple_keyring() {
 
     let keyring = KeyRing::new(network, keychain_id, DESC_1).unwrap();
 
-    assert_eq!(keyring.default_keychain(), keychain_id);
     assert_eq!(keyring.list_keychains().len(), 1);
 }
 
@@ -53,9 +52,8 @@ fn test_8_keychains_keyring() {
     ]
     .into();
 
-    let keyring = KeyRing::new_with_descriptors(Network::Regtest, descriptors, Some(1)).unwrap();
+    let keyring = KeyRing::new_with_descriptors(Network::Regtest, descriptors).unwrap();
 
-    assert_eq!(keyring.default_keychain(), 1);
     assert_eq!(keyring.list_keychains().len(), 8);
 }
 
@@ -69,7 +67,7 @@ fn err_on_hardened_derivation_path() {
         ))
     );
     let mut keyring = KeyRing::new(Network::Regtest, KeychainKind::External, DESC_1).unwrap();
-    let res = keyring.add_descriptor(KeychainKind::Internal,"tr([738b4dbd/86h/1h/0h]tpubDDQsJyQKuP6jCCSZ75Y8zpBAnXsvAN6BWpp6ZoczfxKBDBWnY8XGbC7AMMSyXAcQPNgppkCBmv3hkCLZSaQ4VvSTGsstuTrXuDadMaB7E45/0'/*)", false).err();
+    let res = keyring.add_descriptor(KeychainKind::Internal,"tr([738b4dbd/86h/1h/0h]tpubDDQsJyQKuP6jCCSZ75Y8zpBAnXsvAN6BWpp6ZoczfxKBDBWnY8XGbC7AMMSyXAcQPNgppkCBmv3hkCLZSaQ4VvSTGsstuTrXuDadMaB7E45/0'/*)").err();
     assert_eq!(
         res,
         Some(KeyRingError::Descriptor(
@@ -90,7 +88,7 @@ fn err_on_multipath() {
         )))
     );
     let mut keyring = KeyRing::new(Network::Regtest, KeychainKind::External, DESC_1).unwrap();
-    let res = keyring.add_descriptor(KeychainKind::Internal, "tr(tpubD6NzVbkrYhZ4WyC5VZLuSJQ14uwfUbus7oAFurAFkZA5N3groeQqtW65m8pG1TT1arPpfWu9RbBsc5rSBncrX2d84BAwJJHQfaRjnMCQwuT/86/1/0/<0;1>/*)" , false).err();
+    let res = keyring.add_descriptor(KeychainKind::Internal, "tr(tpubD6NzVbkrYhZ4WyC5VZLuSJQ14uwfUbus7oAFurAFkZA5N3groeQqtW65m8pG1TT1arPpfWu9RbBsc5rSBncrX2d84BAwJJHQfaRjnMCQwuT/86/1/0/<0;1>/*)").err();
     assert_eq!(
         res,
         Some(KeyRingError::Descriptor(DescriptorError::Miniscript(
@@ -105,23 +103,23 @@ fn err_on_multipath() {
 fn test_duplicate_keychain_and_desc() {
     let (desc, change_desc) = get_test_wpkh_and_change_desc();
     // duplicate descriptor(err)
-    let err = KeyRing::new_with_descriptors(Network::Testnet, [(1, desc), (2, desc)].into(), None)
-        .unwrap_err();
+    let err =
+        KeyRing::new_with_descriptors(Network::Testnet, [(1, desc), (2, desc)].into()).unwrap_err();
     assert_eq!(
         err,
         KeyRingError::DescAlreadyExists(Box::new(get_descriptor(desc)))
     );
     // does not err as `new_with_descriptors` takes a map from keychain to
     // descriptor to argument
     let mut keyring =
-        KeyRing::new_with_descriptors(Network::Testnet, [(1, desc), (1, change_desc)].into(), None)
+        KeyRing::new_with_descriptors(Network::Testnet, [(1, desc), (1, change_desc)].into())
             .unwrap();
     assert_eq!(
         keyring.list_keychains().get(&1),
         Some(&get_descriptor(change_desc))
     );
 
     //try inserting duplicate keychain(err)
-    let err = keyring.add_descriptor(1, desc, true).unwrap_err();
+    let err = keyring.add_descriptor(1, desc).unwrap_err();
     assert_eq!(err, KeyRingError::KeychainAlreadyExists(1));
 }

tests/persisted_wallet.rs

@@ -105,7 +105,6 @@ fn wallet_is_persisted() -> anyhow::Result<()> {
                     (KeychainKind::Internal, internal_desc),
                 ]
                 .into(),
-                None,
             )
             .unwrap();
             let mut wallet = Wallet::create(keyring)
@@ -267,7 +266,6 @@ fn wallet_load_checks() -> anyhow::Result<()> {
                 (KeychainKind::Internal, internal_desc),
             ]
             .into(),
-            Some(KeychainKind::External),
         )?;
 
         // create new wallet
@@ -464,7 +462,6 @@ fn test_lock_outpoint_persist() -> anyhow::Result<()> {
             (KeychainKind::Internal, change_desc),
         ]
         .into(),
-        Some(KeychainKind::External),
     )?;
     let mut wallet = Wallet::create(keyring).create_wallet(&mut conn)?;
 

tests/wallet.rs

@@ -38,7 +38,7 @@ mod common;
 #[test]
 fn check_balance() {
     let mut keyring = KeyRing::new(Network::Regtest, KeychainKind::External, "tr(tprv8ZgxMBicQKsPdWAHbugK2tjtVtRjKGixYVZUdL7xLHMgXZS6BFbFi1UDb1CHT25Z5PU1F9j7wGxwUiRhqz9E3nZRztikGUV6HoRDYcqPhM4/86'/1'/0'/0/*)").unwrap();
-    keyring.add_descriptor(KeychainKind::Internal, "tr(tprv8ZgxMBicQKsPdWAHbugK2tjtVtRjKGixYVZUdL7xLHMgXZS6BFbFi1UDb1CHT25Z5PU1F9j7wGxwUiRhqz9E3nZRztikGUV6HoRDYcqPhM4/86'/1'/0'/5/*)", false);
+    keyring.add_descriptor(KeychainKind::Internal, "tr(tprv8ZgxMBicQKsPdWAHbugK2tjtVtRjKGixYVZUdL7xLHMgXZS6BFbFi1UDb1CHT25Z5PU1F9j7wGxwUiRhqz9E3nZRztikGUV6HoRDYcqPhM4/86'/1'/0'/5/*)");
     let mut wallet = Wallet::create(keyring).create_wallet_no_persist().unwrap();
     let receive_address = wallet
         .reveal_next_address(KeychainKind::External)