test: add excluded-in-CI live tests

.github/workflows/test-jvm.yaml

@@ -38,4 +38,4 @@ jobs:
       - name: "Run JVM tests"
         run: |
           cd bdk-jvm
-          ./gradlew test
+          ./gradlew test -P excludeConnectedTests

.github/workflows/test-python.yaml

@@ -54,7 +54,7 @@ jobs:
         run: ${PYBIN}/pip install ./dist/*.whl
 
       - name: "Run tests"
-        run: ${PYBIN}/python -m unittest tests/test_bdk.py --verbose
+        run: ${PYBIN}/python -m unittest --start "./tests/" --pattern "test_offline_*.py" --verbose
 
       - name: "Upload artifact test"
         uses: actions/upload-artifact@v3
@@ -97,7 +97,7 @@ jobs:
       # - name: "Install wheel and run tests"
       #   run: |
       #     pip3 install ./dist/*.whl
-      #     python3 -m unittest tests/test_bdk.py --verbose
+      #     python3 -m unittest --start "./tests/" --pattern "test_offline_*.py" --verbose
 
       - name: "Upload artifact test"
         uses: actions/upload-artifact@v3
@@ -138,7 +138,7 @@ jobs:
         run: pip3 install ./dist/*.whl
 
       - name: "Run tests"
-        run: python3 -m unittest tests/test_bdk.py --verbose
+        run: python3 -m unittest --start "./tests/" --pattern "test_offline_*.py" --verbose
 
       - name: "Upload artifact test"
         uses: actions/upload-artifact@v3
@@ -186,4 +186,4 @@ jobs:
         shell: powershell
 
       - name: "Run tests"
-        run: python -m unittest tests/test_bdk.py --verbose
+        run: python -m unittest --start "./tests/" --pattern "test_offline_*.py" --verbose

.github/workflows/test-swift.yaml

@@ -23,4 +23,4 @@ jobs:
 
       - name: "Run Swift tests"
         working-directory: bdk-swift
-        run: swift test
+        run: swift test --skip LiveWalletTests --skip LiveTxBuilderTests

bdk-jvm/lib/build.gradle.kts

@@ -26,6 +26,18 @@ java {
     withJavadocJar()
 }
 
+// This block ensures that the tests that require access to a blockchain are not
+// run if the -P excludeConnectedTests flag is passed to gradle.
+// This ensures our CI runs are not fickle by not requiring access to testnet.
+// This is a workaround until we have a proper regtest setup for the CI.
+// Note that the command in the CI is ./gradlew test -P excludeConnectedTests
+tasks.test {
+    if (project.hasProperty("excludeConnectedTests")) {
+        exclude("**/LiveWalletTest.class")
+        exclude("**/LiveTxBuilderTest.class")
+    }
+}
+
 testing {
     suites {
         val test by getting(JvmTestSuite::class) {

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/LiveTxBuilderTest.kt

@@ -0,0 +1,25 @@
+package org.bitcoindevkit
+
+import org.junit.Test
+
+class LiveTxBuilderTest {
+    @Test
+    fun testTxBuilder() {
+        val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
+        val wallet = Wallet.newNoPersist(descriptor, null, Network.TESTNET)
+        val esploraClient = EsploraClient("https://mempool.space/testnet/api")
+        val update = esploraClient.scan(wallet, 10uL, 1uL)
+        wallet.applyUpdate(update)
+        println("Balance: ${wallet.getBalance().total()}")
+
+        assert(wallet.getBalance().total() > 0uL)
+
+        val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
+        val psbt: PartiallySignedTransaction = TxBuilder()
+            .addRecipient(recipient.scriptPubkey(), 4200uL)
+            .feeRate(2.0f)
+            .finish(wallet)
+
+        println(psbt.serialize())
+    }
+}

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/LiveWalletTest.kt

@@ -0,0 +1,16 @@
+package org.bitcoindevkit
+
+import org.junit.Test
+
+class LiveWalletTest {
+    @Test
+    fun testSyncedBalance() {
+        val descriptor: Descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
+        val wallet: Wallet = Wallet.newNoPersist(descriptor, null, Network.TESTNET)
+        val esploraClient: EsploraClient = EsploraClient("https://mempool.space/testnet/api")
+        // val esploraClient = EsploraClient("https://blockstream.info/testnet/api")
+        val update = esploraClient.scan(wallet, 10uL, 1uL)
+        wallet.applyUpdate(update)
+        println("Balance: ${wallet.getBalance().total()}")
+    }
+}

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/OfflineDescriptorTest.kt

@@ -0,0 +1,15 @@
+package org.bitcoindevkit
+
+import kotlin.test.Test
+import kotlin.test.assertTrue
+
+class OfflineDescriptorTest {
+    @Test
+    fun testDescriptorBip86() {
+        val mnemonic: Mnemonic = Mnemonic(WordCount.WORDS12)
+        val descriptorSecretKey: DescriptorSecretKey = DescriptorSecretKey(Network.TESTNET, mnemonic, null)
+        val descriptor: Descriptor = Descriptor.newBip86(descriptorSecretKey, KeychainKind.EXTERNAL, Network.TESTNET)
+
+        assertTrue(descriptor.asString().startsWith("tr"), "Bip86 Descriptor does not start with 'tr'")
+    }
+}

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/JvmLibTest.kt → bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/OfflineWalletTest.kt

@@ -4,8 +4,7 @@ import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
-class WalletTest {
-
+class OfflineWalletTest {
     @Test
     fun testDescriptorBip86() {
         val mnemonic: Mnemonic = Mnemonic(WordCount.WORDS12)
@@ -28,7 +27,10 @@ class WalletTest {
         )
         val addressInfo: AddressInfo = wallet.getAddress(AddressIndex.New)
 
-        assertEquals("tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e", addressInfo.address.asString())
+        assertEquals(
+            expected = "tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e",
+            actual = addressInfo.address.asString()
+        )
     }
 
     @Test
@@ -43,18 +45,9 @@ class WalletTest {
             Network.TESTNET
         )
 
-        assertEquals(0uL, wallet.getBalance().total())
+        assertEquals(
+            expected = 0uL,
+            actual = wallet.getBalance().total()
+        )
     }
-
-    // @Test
-    // fun testSyncedBalance() {
-    //     val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
-    //     val wallet = Wallet.newNoPersist(descriptor, null, Network.TESTNET)
-    //     val esploraClient = EsploraClient("https://mempool.space/testnet/api")
-    //     // val esploraClient = EsploraClient("https://blockstream.info/testnet/api")
-    //     val update = esploraClient.scan(wallet, 10uL, 1uL)
-    //     wallet.applyUpdate(update)
-    //     println("Balance: ${wallet.getBalance().total()}")
-    // }
-
 }

bdk-python/tests/test_live_bdk.py

@@ -0,0 +1,8 @@
+import bdkpython as bdk
+import unittest
+
+class TestLiveWallet(unittest.TestCase):
+
+
+if __name__ == '__main__':
+    unittest.main()

bdk-swift/Tests/BitcoinDevKitTests/LiveTxBuilderTests.swift

@@ -0,0 +1,34 @@
+import XCTest
+@testable import BitcoinDevKit
+
+final class LiveTxBuilderTests: XCTestCase {
+    func testTxBuilder() throws {
+        let descriptor = try Descriptor(
+            descriptor: "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
+            network: Network.testnet
+        )
+        let wallet = try Wallet.newNoPersist(
+            descriptor: descriptor,
+            changeDescriptor: nil,
+            network: .testnet
+        )
+        let esploraClient = EsploraClient(url: "https://mempool.space/testnet/api")
+        let update = try esploraClient.scan(
+            wallet: wallet,
+            stopGap: 10,
+            parallelRequests: 1
+        )
+        try wallet.applyUpdate(update: update)
+
+        XCTAssertGreaterThan(wallet.getBalance().total(), UInt64(0), "Wallet must have positive balance, please add funds")
+
+        let recipient: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .testnet)
+        let psbt: PartiallySignedTransaction = try TxBuilder()
+            .addRecipient(script: recipient.scriptPubkey(), amount: 4200)
+            .feeRate(satPerVbyte: 2.0)
+            .finish(wallet: wallet)
+
+        print(psbt.serialize())
+        XCTAssertTrue(psbt.serialize().hasPrefix("cHNi"), "PSBT should start with cHNI")
+    }
+}

bdk-swift/Tests/BitcoinDevKitTests/LiveWalletTests.swift

@@ -0,0 +1,25 @@
+import XCTest
+@testable import BitcoinDevKit
+
+final class LiveWalletTests: XCTestCase {
+    func testSyncedBalance() throws {
+        let descriptor = try Descriptor(
+            descriptor: "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
+            network: Network.testnet
+        )
+        let wallet = try Wallet.newNoPersist(
+            descriptor: descriptor,
+            changeDescriptor: nil,
+            network: .testnet
+        )
+        let esploraClient = EsploraClient(url: "https://mempool.space/testnet/api")
+        let update = try esploraClient.scan(
+            wallet: wallet,
+            stopGap: 10,
+            parallelRequests: 1
+        )
+        try wallet.applyUpdate(update: update)
+
+        XCTAssertGreaterThan(wallet.getBalance().total(), UInt64(0))
+    }
+}

bdk-swift/Tests/BitcoinDevKitTests/OfflineDescriptorTests.swift

@@ -0,0 +1,20 @@
+import XCTest
+@testable import BitcoinDevKit
+
+final class OfflineDescriptorTests: XCTestCase {
+    func testDescriptorBip86() {
+        let mnemonic: Mnemonic = Mnemonic(wordCount: WordCount.words12)
+        let descriptorSecretKey: DescriptorSecretKey = DescriptorSecretKey(
+            network: Network.testnet,
+            mnemonic: mnemonic,
+            password: nil
+        )
+        let descriptor: Descriptor = Descriptor.newBip86(
+            secretKey: descriptorSecretKey,
+            keychain: KeychainKind.external,
+            network: Network.testnet
+        )
+
+        XCTAssertTrue(descriptor.asString().hasPrefix("tr"), "Bip86 Descriptor does not start with 'tr'")
+    }
+}

bdk-swift/Tests/BitcoinDevKitTests/OfflineWalletTests.swift

@@ -0,0 +1,33 @@
+import XCTest
+@testable import BitcoinDevKit
+
+final class OfflineWalletTests: XCTestCase {
+    func testNewAddress() throws {
+        let descriptor: Descriptor = try Descriptor(
+            descriptor: "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
+            network: Network.testnet
+        )
+        let wallet: Wallet = try Wallet.newNoPersist(
+            descriptor: descriptor,
+            changeDescriptor: nil,
+            network: .testnet
+        )
+        let addressInfo: AddressInfo = wallet.getAddress(addressIndex: AddressIndex.new)
+
+        XCTAssertEqual(addressInfo.address.asString(), "tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e")
+    }
+
+    func testBalance() throws {
+        let descriptor: Descriptor = try Descriptor(
+            descriptor: "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
+            network: Network.testnet
+        )
+        let wallet: Wallet = try Wallet.newNoPersist(
+            descriptor: descriptor,
+            changeDescriptor: nil,
+            network: .testnet
+        )
+
+        XCTAssertEqual(wallet.getBalance().total(), 0)
+    }
+}