feat: Add kyoto example and logging

Author: ItoroD

examples/build.gradle.kts

@@ -15,6 +15,9 @@ repositories {
 dependencies {
     implementation(project(":lib"))
     testImplementation(kotlin("test"))
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1")
+    implementation("org.slf4j:slf4j-api:2.0.16")
+    implementation("ch.qos.logback:logback-classic:1.5.13")
 }
 
 tasks.test {
@@ -39,11 +42,21 @@ tasks.register<JavaExec>("WalletSetupBip32") {
     description = "Runs the main function in the WalletSetupBip32 example"
     mainClass.set("org.bitcoindevkit.WalletSetupBip32Kt")
     classpath = sourceSets["main"].runtimeClasspath
+    workingDir = project.rootDir
 }
 
 tasks.register<JavaExec>("MultisigTransaction") {
     group = "application"
     description = "Runs the main function in the MultisigTransaction example"
     mainClass.set("org.bitcoindevkit.MultisigTransactionKt")
     classpath = sourceSets["main"].runtimeClasspath
+    workingDir = project.rootDir
+}
+
+tasks.register<JavaExec>("Kyoto") {
+    group = "application"
+    description = "Runs the main function in the Kyoto example"
+    mainClass.set("org.bitcoindevkit.KyotoKt")
+    classpath = sourceSets["main"].runtimeClasspath
+    workingDir = project.rootDir
 }

examples/src/main/kotlin/Kyoto.kt

@@ -0,0 +1,87 @@
+package org.bitcoindevkit
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.cancelAndJoin
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
+import java.nio.file.Files
+import java.nio.file.Paths
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+
+
+
+fun main() {
+    // Regtest environment must have Compact block filter enabled to run this
+    // Setup your environment according to the https://github.com/thunderbiscuit/podman-regtest-infinity-pro documentation.
+
+    // Add your regtest IP address
+    val ip: IpAddress = IpAddress.fromIpv4(127u, 0u, 0u, 1u)
+    val peer: Peer = Peer(ip, 18444u, false)
+    val peers: List<Peer> = listOf(peer)
+    val currentPath = Paths.get("examples/data").toAbsolutePath().normalize()
+    println("Current path: $currentPath")
+    val persistenceFilePath = Files.createTempDirectory(currentPath, "kyoto-data_")
+
+    val wallet = getNewWallet(ActiveWalletScriptType.P2WPKH, Network.REGTEST)
+    val address = wallet.revealNextAddress(KeychainKind.EXTERNAL)
+
+    // Fund this address. Send coins from your regtest to this address
+    println("Receiving address. Send funds to this address: ${address.address}")
+
+    // Wait 70 seconds for funds to arrive before syncing
+    // Ensure you mine a block after sending funds to the address. This enables kyoto pickup the transaction.
+    println("Waiting 70 seconds for funds to arrive here ${address.address} before kyoto (compact block filter syncing) ...")
+    Thread.sleep(70000)
+
+    // Create CBF node and client
+    runBlocking {
+        val lightClient = CbfBuilder()
+            .peers(peers)
+            .connections(1u)
+            .scanType(ScanType.New)
+            .dataDir(persistenceFilePath.toString())
+            .build(wallet)
+        val client = lightClient.client
+        val node = lightClient.node
+
+        val logJob = launchLogCollector(this, client::nextLog, "LOG")
+        val logWarningJob = launchLogCollector(this, client::nextWarning, "WARNING")
+        val logInfoJob = launchLogCollector(this, client::nextInfo, "INFO")
+
+        //Start CBF node
+        node.run()
+        println("Node running")
+
+        //Update wallet
+        val update: Update = client.update()
+        wallet.applyUpdate(update)
+        println("Wallet balance: ${wallet.balance().total.toSat()} sats")
+
+        if(wallet.balance().total.toSat() > 0uL) {
+            println("Wallet is synced and ready for use!")
+            println("Test completed successfully")
+        }else{
+            println("Wallet balance is 0. Try sending funds to ${address.address} and try again.")
+        }
+        logJob.cancelAndJoin()
+        logWarningJob.cancelAndJoin()
+        logInfoJob.cancelAndJoin()
+        client.shutdown()
+    }
+}
+
+fun <T> launchLogCollector(scope: CoroutineScope, collector: suspend () -> T, logType: String) = scope.launch {
+    val logger: Logger = LoggerFactory.getLogger("LogCollector")
+
+    while (true) {
+        val log = collector()
+        when (logType) {
+            "LOG" -> logger.info("$log")
+            "WARNING" -> logger.warn("$log")
+            "INFO" -> logger.info("$log")
+            else -> logger.debug("[$logType]: $log")
+        }
+    }
+}
+