Tor integration

gradle.properties

@@ -7,7 +7,7 @@ kotlin.code.style = official
 kotlin.mpp.stability.nowarn=true
 kotlin.incremental.multiplatform = true
 kotlin.parallel.tasks.in.project = true
-kotlin.mpp.enableGranularSourceSetsMetadata = true
+#kotlin.mpp.enableGranularSourceSetsMetadata = true
 kotlin.native.enableDependencyPropagation = false
 
 # Android

phoenix-ios/phoenix-ios/controllers.swift

@@ -17,6 +17,7 @@ class MockControllerFactory : ControllerFactory {
     func scan() -> MVIController<Scan.Model, Scan.Intent> { MVIControllerMock(model: ScanView_Previews.mockModel) }
     func restoreWallet() -> MVIController<RestoreWallet.Model, RestoreWallet.Intent> { MVIControllerMock(model: RestoreWalletView_Previews.mockModel) }
     func configuration() -> MVIController<Configuration.Model, Configuration.Intent> { MVIControllerMock(model: ConfigurationView_Previews.mockModel) }
+    func torConfiguration() -> MVIController<TorConfiguration.Model, TorConfiguration.Intent> { MVIControllerMock(model: TorConfigurationView_Previews.mockModel) }
     func electrumConfiguration() -> MVIController<ElectrumConfiguration.Model, ElectrumConfiguration.Intent> { MVIControllerMock(model: ElectrumConfigurationView_Previews.mockModel) }
     func channelsConfiguration() -> MVIController<ChannelsConfiguration.Model, ChannelsConfiguration.Intent> { MVIControllerMock(model: ChannelsConfigurationView_Previews.mockModel) }
     func logsConfiguration() -> MVIController<LogsConfiguration.Model, LogsConfiguration.Intent> { MVIControllerMock(model: LogsConfigurationView_Previews.mockModel) }

phoenix-ios/phoenix-ios/views/HomeView.swift

@@ -180,41 +180,56 @@ struct ConnectionStatusButton : View {
 	@Environment(\.popoverState) var popoverState: PopoverState
 
 	var body: some View {
+		let tor = connectionsMonitor.connections.tor
 		let status = connectionsMonitor.connections.global
-
+		let connectedWithTor = status == Eclair_kmpConnection.established && tor != nil
+		let connectedWithoutTor = status == Eclair_kmpConnection.established && tor == nil
+
 		Group {
-			Button {
-				showConnectionsPopover()
-			} label: {
-				HStack {
-					Image("ic_connection_lost")
-						.resizable()
-						.frame(width: 16, height: 16)
-					Text(status.localizedText())
-						.font(.caption2)
+			if connectedWithTor {
+				NavigationLink(destination: TorConfigurationView()) {
+					HStack {
+						Image(systemName: "checkmark.shield")
+								.frame(width: 16, height: 16)
+								.foregroundColor(.appGreen)
+						Text("Tor enabled")
+								.font(.caption2)
+					}
 				}
-			}
-			.buttonStyle(PlainButtonStyle())
-			.padding([.leading, .top, .bottom], 4)
-			.padding([.trailing], 6)
-			.background(Color.buttonFill)
-			.cornerRadius(10)
-			.overlay(
-				RoundedRectangle(cornerRadius: 10)
-					.stroke(Color.gray, lineWidth: 1)
-			)
-			.opacity(dimStatus ? 0.2 : 1.0)
-			.isHidden(status == Eclair_kmpConnection.established)
-		}
-		.onAppear {
-			DispatchQueue.main.async {
-				withAnimation(Animation.linear(duration: 1.0).repeatForever()) {
-					self.dimStatus.toggle()
+			} else {
+				Button {
+					showConnectionsPopover()
+				} label: {
+					HStack {
+						Image("ic_connection_lost")
+								.resizable()
+								.frame(width: 16, height: 16)
+						Text(status.localizedText())
+								.font(.caption2)
+					}
 				}
 			}
 		}
+				.buttonStyle(PlainButtonStyle())
+				.padding([.leading, .top, .bottom], 4)
+				.padding([.trailing], 6)
+				.background(Color.buttonFill)
+				.cornerRadius(10)
+				.overlay(
+						RoundedRectangle(cornerRadius: 10)
+								.stroke(Color.gray, lineWidth: 1)
+				)
+				.opacity((dimStatus && !connectedWithTor) ? 0.2 : 1.0)
+				.isHidden(connectedWithoutTor)
+				.onAppear {
+					DispatchQueue.main.async {
+						withAnimation(Animation.linear(duration: 1.0).repeatForever()) {
+							self.dimStatus.toggle()
+						}
+					}
+				}
 	}
-	
+
 	func showConnectionsPopover() -> Void {
 		log.trace("(ConnectionStatusButton) showConnectionsPopover()")
 
@@ -325,6 +340,7 @@ class HomeView_Previews: PreviewProvider {
 
 	static let connections = Connections(
 		internet : .established,
+		tor      : .established,
 		peer     : .established,
 		electrum : .closed
 	)

phoenix-ios/phoenix-ios/views/configuration/general/ElectrumConfigurationView.swift

@@ -488,6 +488,7 @@ class ElectrumConfigurationView_Previews: PreviewProvider {
 		id: 0,
 		host: "tn.not.fyi",
 		port: 55002,
+		tls: .safe,
 		customized: true,
 		blockHeight: 123456789,
 		tipTimestamp: 1599564210
@@ -497,6 +498,7 @@ class ElectrumConfigurationView_Previews: PreviewProvider {
 		id: 0,
 		host: "",
 		port: 0,
+		tls: nil,
 		customized: false,
 		blockHeight: 123456789,
 		tipTimestamp: 1599564210

phoenix-ios/phoenix-ios/views/configuration/general/TorConfigurationView.swift

@@ -1,27 +1,44 @@
 import SwiftUI
+import PhoenixShared
 
 struct TorConfigurationView: View {
 
     @State var isTorEnabled = Prefs.shared.isTorEnabled
-    @State var theme = Prefs.shared.theme
 
     var body: some View {
-        Form {
-            Section(header: TorFormHeader(), content: {}).textCase(nil)
-
-            Toggle(isOn: $isTorEnabled.animation()) {
-                if isTorEnabled {
-                    Text("Tor is enabled")
-                } else {
-                    Text("Tor is disabled")
+        MVIView({ $0.torConfiguration() }) { model, postIntent in
+            Form {
+                Section(header: TorFormHeader(), content: {}).textCase(nil)
+
+                Toggle(isOn: $isTorEnabled.animation()) {
+                    if isTorEnabled {
+                        Text("Tor is enabled")
+                    } else {
+                        Text("Tor is disabled")
+                    }
+                }.onChange(of: isTorEnabled) { newValue in
+                    self.toggleTor(newValue)
+                }
+
+                if let info = model.info {
+                    VStack {
+                        HStack {
+                            Text("Tor version: \(info.version)")
+                            Spacer()
+                        }
+                        HStack {
+                            Text("Network: \(info.networkLiveness)")
+                            Spacer()
+                        }
+                    }
+                            .padding(.top, 10)
+                            .font(.caption)
                 }
-            }.onChange(of: isTorEnabled) { newValue in
-                self.toggleTor(newValue)
             }
+                    .frame(maxWidth: .infinity, maxHeight: .infinity)
+                    .edgesIgnoringSafeArea(.bottom)
+                    .navigationBarTitle("Tor Settings", displayMode: .inline)
         }
-                .frame(maxWidth: .infinity, maxHeight: .infinity)
-                .edgesIgnoringSafeArea(.bottom)
-                .navigationBarTitle("Tor Settings", displayMode: .inline)
     }
 
     struct TorFormHeader: View {
@@ -47,4 +64,6 @@ class TorConfigurationView_Previews: PreviewProvider {
         TorConfigurationView()
                 .previewDevice("iPhone 11")
     }
+
+    static let mockModel = TorConfiguration.Model(info: Tor_mobile_kmpTor.TorInfo(version: "1.0.0", networkLiveness: "UP"))
 }

phoenix-ios/phoenix-ios/views/widgets/ConnectionsPopover.swift

@@ -16,6 +16,10 @@ struct ConnectionsPopover: View {
 			Divider()
 			ConnectionCell(label: "Internet", connection: monitor.connections.internet)
 			Divider()
+			if let tor = monitor.connections.tor {
+				ConnectionCell(label: "Tor", connection: tor)
+				Divider()
+			}
 			ConnectionCell(label: "Lightning peer", connection: monitor.connections.peer)
 			Divider()
 			ConnectionCell(label: "Electrum server", connection: monitor.connections.electrum)

phoenix-shared/build.gradle.kts

@@ -54,13 +54,14 @@ kotlin {
         val coroutinesVersion = "1.4.2-native-mt"
         val serializationVersion = "1.0.0"
         val secp256k1Version = "0.4.1"
-        val ktorVersion = "1.4.1"
+        val ktorVersion = "1.5.0"
         val kodeinDBVersion = "0.2.0-beta"
         val sqldelightVersion = "1.4.4"
 
         val commonMain by getting {
             dependencies {
                 api("fr.acinq.eclair:eclair-kmp:snapshot")
+                api("fr.acinq.tor:tor-mobile-kmp:0.1.0")
                 implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:$serializationVersion")
                 implementation("org.jetbrains.kotlinx:kotlinx-serialization-cbor:$serializationVersion")
                 implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion")
@@ -81,6 +82,7 @@ kotlin {
 
         val commonTest by getting {
             dependencies {
+                implementation("fr.acinq.eclair:eclair-kmp-test-fixtures:snapshot")
                 implementation(kotlin("test-common"))
                 implementation(kotlin("test-annotations-common"))
             }

phoenix-shared/src/commonMain/kotlin/fr.acinq.phoenix/PhoenixBusiness.kt

@@ -13,6 +13,7 @@ import fr.acinq.phoenix.ctrl.config.*
 import fr.acinq.phoenix.data.Chain
 import fr.acinq.phoenix.db.*
 import fr.acinq.phoenix.utils.*
+import fr.acinq.tor.Tor
 import io.ktor.client.*
 import io.ktor.client.features.json.JsonFeature
 import io.ktor.client.features.json.serializer.*
@@ -40,7 +41,15 @@ class PhoenixBusiness(private val ctx: PlatformContext) {
         logMemory.withShortPackageKeepLast(1)
     )
 
+    public val tor by lazy { Tor(getApplicationCacheDirectoryPath(ctx), torLog(loggerFactory)) }
+
     private val tcpSocketBuilder = TcpSocket.Builder()
+    private val tcpSockerBuilderFactory = {
+        if (appConfigurationManager.isTorEnabled.value)
+            tcpSocketBuilder.torProxy(loggerFactory)
+        else
+            tcpSocketBuilder
+    }
 
     private val networkMonitor by lazy { NetworkMonitor(loggerFactory, ctx) }
     private val httpClient by lazy {
@@ -64,18 +73,18 @@ class PhoenixBusiness(private val ctx: PlatformContext) {
 
     private val masterPubkeyPath = if (chain == Chain.MAINNET) "m/84'/0'/0'" else "m/84'/1'/0'"
 
-    private val electrumClient by lazy { ElectrumClient(tcpSocketBuilder, MainScope()) }
+    private val electrumClient by lazy { ElectrumClient(null, MainScope()) }
     private val electrumWatcher by lazy { ElectrumWatcher(electrumClient, MainScope()) }
 
     private var appConnectionsDaemon: AppConnectionsDaemon? = null
 
     private val walletManager by lazy { WalletManager() }
-    private val peerManager by lazy { PeerManager(loggerFactory, walletManager, appConfigurationManager, paymentsDb, tcpSocketBuilder, electrumWatcher, chain, ctx) }
+    private val peerManager by lazy { PeerManager(loggerFactory, walletManager, appConfigurationManager, paymentsDb, electrumWatcher, chain, ctx) }
     private val paymentsManager by lazy { PaymentsManager(loggerFactory, paymentsDb, peerManager) }
     private val appConfigurationManager by lazy { AppConfigurationManager(noSqlAppDB, appDb, httpClient, electrumClient, chain, loggerFactory) }
 
     val currencyManager by lazy { CurrencyManager(loggerFactory, noSqlAppDB, httpClient) }
-    val connectionsMonitor by lazy { ConnectionsMonitor(peerManager, electrumClient, networkMonitor) }
+    val connectionsMonitor by lazy { ConnectionsMonitor(peerManager, electrumClient, networkMonitor, appConfigurationManager, tor) }
     val util by lazy { Utilities(loggerFactory, chain) }
 
     init {
@@ -90,6 +99,8 @@ class PhoenixBusiness(private val ctx: PlatformContext) {
                 peerManager,
                 currencyManager,
                 networkMonitor,
+                tcpSockerBuilderFactory,
+                tor,
                 electrumClient,
                 loggerFactory,
             )
@@ -140,6 +151,7 @@ class PhoenixBusiness(private val ctx: PlatformContext) {
         override fun scan(): ScanController = AppScanController(loggerFactory, peerManager)
         override fun restoreWallet(): RestoreWalletController = AppRestoreWalletController(loggerFactory)
         override fun configuration(): ConfigurationController = AppConfigurationController(loggerFactory, walletManager)
+        override fun torConfiguration(): TorConfigurationController = AppTorConfigurationController(loggerFactory, tor)
         override fun electrumConfiguration(): ElectrumConfigurationController = AppElectrumConfigurationController(loggerFactory, appConfigurationManager, chain, masterPubkeyPath, walletManager, electrumClient)
         override fun channelsConfiguration(): ChannelsConfigurationController = AppChannelsConfigurationController(loggerFactory, peerManager, chain)
         override fun logsConfiguration(): LogsConfigurationController = AppLogsConfigurationController(ctx, loggerFactory, logMemory)

phoenix-shared/src/commonMain/kotlin/fr.acinq.phoenix/app/AppConfigurationManager.kt

@@ -166,9 +166,9 @@ class AppConfigurationManager(
     //endregion
 
     //region Tor configuration
-    private val isTorEnabled = MutableStateFlow(false)
-    fun subscribeToIsTorEnabled(): StateFlow<Boolean> = isTorEnabled
-    fun updateTorUsage(enabled: Boolean): Unit {
+    private val _isTorEnabled = MutableStateFlow(false)
+    public val isTorEnabled get() = _isTorEnabled
+    public fun updateTorUsage(enabled: Boolean): Unit {
         isTorEnabled.value = enabled
     }
     //endregion