Chore: Refactoring of wallet tests (#1943)

* refactoring of fixtures and wallet tests
* bottleneck mark

Author: moneymanolis

pytest.ini

@@ -5,6 +5,7 @@ addopts = --bitcoind-version v22.0.0 --elementsd-version v0.21.0.2
 markers =
     slow: mark test as slow.
     elm: mark test as elementsd dependent
+    bottleneck: mark a test as so ressource intensive that it can create a bottleneck where the test just fails due to a lack of ressources
 # If you need live logging to debug, uncomment the next line
 # log_cli = True 
 # Then set the desired logging level on the command line, for example:

tests/fix_devices_and_wallets.py

@@ -51,10 +51,20 @@ def hot_wallet_device_2(specter_regtest_configured):
     return create_hot_wallet_device(specter_regtest_configured)
 
 
-def create_hot_wallet_with_ID(
-    specter_regtest_configured: Specter, hot_wallet_device_1, wallet_id
+@pytest.fixture
+def hot_ghost_machine_device(
+    specter_regtest_configured: Specter, mnemonic_ghost_machine: str
+) -> Device:
+    return create_hot_wallet_device(
+        specter_regtest_configured,
+        name="Ghost machine device",
+        mnemonic=mnemonic_ghost_machine,
+    )
+
+
+def create_hot_segwit_wallet(
+    specter_regtest_configured: Specter, device: Device, wallet_id
 ) -> Wallet:
-    device = hot_wallet_device_1
     wallet_manager = specter_regtest_configured.wallet_manager
     assert device.taproot_available(specter_regtest_configured.rpc)
 
@@ -64,24 +74,56 @@ def create_hot_wallet_with_ID(
     return source_wallet
 
 
+def create_hot_taproot_wallet(
+    specter_regtest_configured: Specter, device: Device, wallet_id
+) -> Wallet:
+    wallet_manager = specter_regtest_configured.wallet_manager
+    assert device.taproot_available(specter_regtest_configured.rpc)
+    keys = [key for key in device.keys if key.key_type == "tr"]
+    source_wallet = wallet_manager.create_wallet(wallet_id, 1, "tr", keys, [device])
+    return source_wallet
+
+
 @pytest.fixture
 def unfunded_hot_wallet_1(specter_regtest_configured, hot_wallet_device_1) -> Wallet:
-    return create_hot_wallet_with_ID(
+    return create_hot_segwit_wallet(
         specter_regtest_configured,
         hot_wallet_device_1,
         f"a_hotwallet_{random.randint(0, 999999)}",
     )
 
 
 @pytest.fixture
-def unfunded_hot_wallet_2(specter_regtest_configured, hot_wallet_device_1) -> Wallet:
-    return create_hot_wallet_with_ID(
+def unfunded_hot_wallet_2(specter_regtest_configured, hot_wallet_device_2) -> Wallet:
+    return create_hot_segwit_wallet(
         specter_regtest_configured,
         hot_wallet_device_1,
         f"a_hotwallet_{random.randint(0, 999999)}",
     )
 
 
+@pytest.fixture
+def unfunded_ghost_machine_wallet(
+    specter_regtest_configured: Specter, hot_ghost_machine_device: Device
+) -> Wallet:
+    return create_hot_segwit_wallet(
+        specter_regtest_configured,
+        hot_ghost_machine_device,
+        f"ghost_machine",
+    )
+
+
+@pytest.fixture
+def unfunded_taproot_wallet(
+    specter_regtest_configured: Specter, hot_ghost_machine_device: Device
+) -> Wallet:
+    return create_hot_taproot_wallet(
+        specter_regtest_configured,
+        hot_ghost_machine_device,
+        f"taproot",
+    )
+
+
 @pytest.fixture
 def funded_hot_wallet_1(
     bitcoin_regtest: NodeController, unfunded_hot_wallet_1: Wallet
@@ -116,3 +158,25 @@ def funded_hot_wallet_2(
     funded_hot_wallet_2 = unfunded_hot_wallet_2
     bitcoin_regtest.testcoin_faucet(funded_hot_wallet_2.getnewaddress())
     return funded_hot_wallet_2
+
+
+@pytest.fixture
+def funded_ghost_machine_wallet(
+    bitcoin_regtest: NodeController, unfunded_ghost_machine_wallet: Wallet
+) -> Wallet:
+    funded_ghost_machine_wallet = unfunded_ghost_machine_wallet
+    bitcoin_regtest.testcoin_faucet(
+        funded_ghost_machine_wallet.getnewaddress()
+    )  # default value are 20 BTC
+    return funded_ghost_machine_wallet
+
+
+@pytest.fixture
+def funded_taproot_wallet(
+    bitcoin_regtest: NodeController, unfunded_taproot_wallet: Wallet
+) -> Wallet:
+    funded_taproot_wallet = unfunded_taproot_wallet
+    bitcoin_regtest.testcoin_faucet(
+        funded_taproot_wallet.getnewaddress()
+    )  # default value are 20 BTC
+    return funded_taproot_wallet

tests/fix_keys_and_seeds.py

@@ -7,30 +7,26 @@
 from embit.bip32 import HDKey, NETWORKS
 from embit import script
 
-mnemonic_ghost_machine = (
-    "ghost ghost ghost ghost ghost ghost ghost ghost ghost ghost ghost machine"
-)
 
-mnemonic_zoo_when = (
-    "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo when"
-)
+@pytest.fixture
+def mnemonic_ghost_machine():
+    return 11 * "ghost " + "machine"
 
 
 @pytest.fixture
 def mnemonic_keen_join():
     return 11 * "keen " + "join"
 
 
-# hold hold hold hold hold hold hold hold hold hold hold accident
-# This is a formal creation of all major bitcoin artifacts from the
-# hold accident mnemonic
-
-
 @pytest.fixture
 def mnemonic_hold_accident():
     return 11 * "hold " + "accident"
 
 
+# The following is a formal creation of all major bitcoin artifacts from the
+# hold accident mnemonic
+
+
 @pytest.fixture
 def seed_hold_accident(mnemonic_hold_accident):
     seed = mnemonic_to_seed(mnemonic_hold_accident)

tests/test_commands_utxo_scanner.py

@@ -6,7 +6,7 @@
 from cryptoadvance.specter.commands.utxo_scanner import UtxoScanner
 from cryptoadvance.specter.specter import Specter
 from cryptoadvance.specter.wallet import Wallet
-from fix_devices_and_wallets import create_hot_wallet_device, create_hot_wallet_with_ID
+from fix_devices_and_wallets import create_hot_wallet_device, create_hot_segwit_wallet
 
 
 @pytest.mark.skip()
@@ -25,7 +25,7 @@ def test_rescan_utxo(specter_testnet_configured: Specter, caplog):
         11 * "hold " + "accident",
     )
     assert hot_device
-    wallet: Wallet = create_hot_wallet_with_ID(
+    wallet: Wallet = create_hot_segwit_wallet(
         specter_testnet_configured, hot_device, "hold_accident"
     )
 

tests/test_managers_wallet.py

@@ -92,6 +92,7 @@ def test_WalletManager(
 
 
 @pytest.mark.slow
+@pytest.mark.bottleneck
 def test_WalletManager_2_nodes(
     docker,
     request,
@@ -142,92 +143,6 @@ def test_WalletManager_2_nodes(
         wm.update(chain="regtest3")
     with pytest.raises(Exception, match="can only be changed with one another") as e:
         wm.update(rpc=bitcoin_regtest2.get_rpc())
-    # assert False
-
-
-@pytest.mark.slow
-def test_wallet_createpsbt(
-    docker, request, devices_filled_data_folder, device_manager, bitcoin_regtest
-):
-    wm = WalletManager(
-        200100,
-        devices_filled_data_folder,
-        bitcoin_regtest.get_rpc(),
-        "regtest",
-        device_manager,
-        allow_threading=False,
-    )
-    # A wallet-creation needs a device
-    device = device_manager.get_by_alias("specter")
-    key = Key.from_json(
-        {
-            "derivation": "m/48h/1h/0h/2h",
-            "original": "Vpub5n9kKePTPPGtw3RddeJWJe29epEyBBcoHbbPi5HhpoG2kTVsSCUzsad33RJUt3LktEUUPPofcZczuudnwR7ZgkAkT6N2K2Z7wdyjYrVAkXM",
-            "fingerprint": "08686ac6",
-            "type": "wsh",
-            "xpub": "tpubDFHpKypXq4kwUrqLotPs6fCic5bFqTRGMBaTi9s5YwwGymE8FLGwB2kDXALxqvNwFxB1dLWYBmmeFVjmUSdt2AsaQuPmkyPLBKRZW8BGCiL",
-        }
-    )
-    wallet = wm.create_wallet("a_second_test_wallet", 1, "wpkh", [key], [device])
-    # Let's fund the wallet
-    address = wallet.getnewaddress()
-    assert address == "bcrt1qtnrv2jpygx2ef3zqfjhqplnycxak2m6ljnhq6z"
-    bitcoin_regtest.testcoin_faucet(address, amount=5)
-    address = wallet.getnewaddress()
-    bitcoin_regtest.testcoin_faucet(address, amount=10)
-    address = wallet.getnewaddress()
-    bitcoin_regtest.testcoin_faucet(address, amount=15)
-    # update the wallet data
-    wallet.update_balance()
-    assert wallet.amount_total == 30
-    unspents = wallet.rpc.listunspent(0)
-    # Let's take 3 UTXO:
-    selected_coins = [
-        {"txid": u["txid"], "vout": u["vout"]}
-        for u in [unspents[0], unspents[1], unspents[2]]
-    ]
-    selected_coins_amount_sum = (
-        unspents[0]["amount"] + unspents[1]["amount"] + unspents[2]["amount"]
-    )
-    number_of_coins_to_spend = (
-        selected_coins_amount_sum - 0.1
-    )  # Let's spend almost all of them
-    random_address = "bcrt1qwxhn49vkppudjcgrd4mylxczgjtuwayg5ckp5s"
-    psbt = wallet.createpsbt(
-        [random_address],
-        [number_of_coins_to_spend],
-        True,
-        0,
-        10,
-        selected_coins=selected_coins,
-    )
-    assert len(psbt["tx"]["vin"]) == 3
-    psbt_txs = [tx["txid"] for tx in psbt["tx"]["vin"]]
-    for coin in selected_coins:
-        assert coin["txid"] in psbt_txs
-
-    # Now let's spend more coins than we have selected. This should result in an exception:
-    try:
-        psbt = wallet.createpsbt(
-            [random_address],
-            [number_of_coins_to_spend + 1],
-            True,
-            0,
-            10,
-            selected_coins=selected_coins,
-        )
-        assert False, "should throw an exception!"
-    except SpecterError as e:
-        pass
-
-    assert wallet.amount_locked_unsigned == selected_coins_amount_sum
-    assert len(wallet.rpc.listlockunspent()) == 3
-    assert wallet.amount_available == wallet.amount_total - selected_coins_amount_sum
-
-    wallet.delete_pending_psbt(psbt["tx"]["txid"])
-    assert wallet.amount_locked_unsigned == 0
-    assert len(wallet.rpc.listlockunspent()) == 0
-    assert wallet.amount_total == wallet.amount_available
 
 
 def test_WalletManager_check_duplicate_keys(empty_data_folder):
@@ -779,47 +694,3 @@ def test_multisig_wallet_backup_and_restore(
 
     # We restored the wallet's utxos
     assert wallet.amount_total == 3.3
-
-
-@pytest.mark.slow
-def test_taproot_wallet(bitcoin_regtest, caplog, specter_regtest_configured):
-    """
-    Taproot m/86h/ derivation path xpubs should be able to create wallets and
-    receive funds
-    """
-    caplog.set_level(logging.INFO)
-
-    device_manager = specter_regtest_configured.device_manager
-    wallet_manager = specter_regtest_configured.wallet_manager
-
-    taproot_device = device_manager.add_device(
-        name="hot_key", device_type=DeviceTypes.BITCOINCORE, keys=[]
-    )
-    taproot_device.setup_device(file_password=None, wallet_manager=wallet_manager)
-    taproot_device.add_hot_wallet_keys(
-        mnemonic=generate_mnemonic(strength=128),
-        passphrase="",
-        paths=["m/86h/1h/0h"],  # Taproot for testnet/regtest
-        file_password=None,
-        wallet_manager=wallet_manager,
-        testnet=True,
-        keys_range=[0, 1000],
-        keys_purposes=[],
-    )
-
-    taproot_wallet = wallet_manager.create_wallet(
-        name="my_taproot_test_wallet",
-        sigs_required=1,
-        key_type=taproot_device.keys[0].key_type,
-        keys=[taproot_device.keys[0]],
-        devices=[taproot_device],
-    )
-
-    # Fund the wallet
-    address = taproot_wallet.getnewaddress()
-    bitcoin_regtest.testcoin_faucet(address, amount=2.2)
-    taproot_wallet.update_balance()
-    assert taproot_wallet.amount_total == 2.2
-
-    # Taproot test addrs are bcrt1p vs native segwit bcrt1q
-    assert address.startswith("bcrt1p")

tests/test_rest.py

@@ -13,7 +13,6 @@
 from cryptoadvance.specter.specter_error import SpecterError
 from cryptoadvance.specter.util.wallet_importer import WalletImporter
 from cryptoadvance.specter.user import User
-from fix_devices_and_wallets import create_hot_wallet_with_ID
 
 logger = logging.getLogger(__name__)